diff --git a/README.md b/README.md index 422079f6ff7..8d2f02cdf72 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,27 @@ The project requires JDK 1.21. ## Configuration Refer to the [configuration guide](docs/configuration.md). -## Deploy -To deploy PMS on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deployment/sandbox-deployment). +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` ## Test Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests). diff --git a/deploy/copy_cm.sh b/deploy/copy_cm.sh deleted file mode 100755 index 28cf72d2e08..00000000000 --- a/deploy/copy_cm.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/bash -# Copy configmaps from other namespaces -# DST_NS: Destination namespace - -function copying_cm() { - UTIL_URL=https://raw.githubusercontent.com/mosip/mosip-infra/master/deployment/v3/utils/copy_cm_func.sh - COPY_UTIL=./copy_cm_func.sh - DST_NS=ida - - wget -q $UTIL_URL -O copy_cm_func.sh && chmod +x copy_cm_func.sh - - $COPY_UTIL configmap global default $DST_NS - $COPY_UTIL configmap artifactory-share artifactory $DST_NS - $COPY_UTIL configmap config-server-share config-server $DST_NS - $COPY_UTIL configmap softhsm-ida-share softhsm $DST_NS - return 0 -} - - -# set commands for error handling. -set -e -set -o errexit ## set -e : exit the script if any statement returns a non-true return value -set -o nounset ## set -u : exit the script if you try to use an uninitialised variable -set -o errtrace # trace ERR through 'time command' and other functions -set -o pipefail # trace ERR through pipes -copying_cm # calling function - - diff --git a/deploy/copy_cm_func.sh b/deploy/copy_cm_func.sh new file mode 100755 index 00000000000..e633442eea6 --- /dev/null +++ b/deploy/copy_cm_func.sh @@ -0,0 +1,28 @@ +#!/bin/bash +# Copy configmap and secret from one namespace to another. +# ./copy_cm_func.sh [name] +# Parameters: +# resource: configmap|secret +# name: Optional new name of the configmap or secret in destination namespace. This may be needed if there is +# clash of names + +if [ $1 = "configmap" ] +then + RESOURCE=configmap +elif [ $1 = "secret" ] +then + RESOURCE=secret +else + echo "Incorrect resource $1. Exiting.." + exit 1 +fi + + +if [ $# -ge 5 ] +then + kubectl -n $4 delete --ignore-not-found=true $RESOURCE $5 + kubectl -n $3 get $RESOURCE $2 -o yaml | sed "s/namespace: $3/namespace: $4/g" | sed "s/name: $2/name: $5/g" | kubectl -n $4 create -f - +else + kubectl -n $4 delete --ignore-not-found=true $RESOURCE $2 + kubectl -n $3 get $RESOURCE $2 -o yaml | sed "s/namespace: $3/namespace: $4/g" | kubectl -n $4 create -f - +fi diff --git a/deploy/ida-apitestrig/README.md b/deploy/ida-apitestrig/README.md new file mode 100644 index 00000000000..a5e277981d9 --- /dev/null +++ b/deploy/ida-apitestrig/README.md @@ -0,0 +1,44 @@ +# APITESTRIG + +## Introduction +ApiTestRig will test the working of APIs of the MOSIP modules. + +## Install +* Review `values.yaml` and, Make sure to enable required modules for apitestrig operation. +* Install +```sh +./install.sh +``` +* During the execution of the `install.sh` script, a prompt appears requesting information regarding the presence of a public domain and a valid SSL certificate on the server. +* If the server lacks a public domain and a valid SSL certificate, it is advisable to select the `n` option. Opting it will enable the `init-container` with an `emptyDir` volume and include it in the deployment process. +* The init-container will proceed to download the server's self-signed SSL certificate and mount it to the specified location within the container's Java keystore (i.e., `cacerts`) file. +* This particular functionality caters to scenarios where the script needs to be employed on a server utilizing self-signed SSL certificates. + +## Uninstall +* To uninstall ApiTestRig, run `delete.sh` script. +```sh +./delete.sh +``` + +## Run apitestrig manually + +#### Rancher UI +* Run apitestrig manually via Rancher UI. + ![apitestrig-2.png](../../docs/apitestrig-2.png) +* There are two modes of apitestrig `smoke` & `smokeAndRegression`. +* By default, apitestrig will execute with `smokeAndRegression`.
+ If you want to run apitestrig with only `smoke`.
+ You have to update the `apitestrig` configmap and rerun the specific apitestrig job. + +#### CLI +* Download Kubernetes cluster `kubeconfig` file from `rancher dashboard` to your local. + ![apitestrig-1.png](../../docs/apitestrig-1.png) +* Install `kubectl` package to your local machine. +* Run apitestrig manually via CLI by creating a new job from an existing k8s cronjob. + ``` + kubectl --kubeconfig= -n apitestrig create job --from=cronjob/ + ``` + example: + ``` + kubectl --kubeconfig=/home/xxx/Downloads/qa4.config -n apitestrig create job --from=cronjob/cronjob-apitestrig-masterdata cronjob-apitestrig-masterdata + ``` \ No newline at end of file diff --git a/deploy/ida-apitestrig/delete.sh b/deploy/ida-apitestrig/delete.sh new file mode 100755 index 00000000000..2eff43ecc43 --- /dev/null +++ b/deploy/ida-apitestrig/delete.sh @@ -0,0 +1,30 @@ +#!/bin/bash +# Uninstalls apitestrig +## Usage: ./delete.sh [kubeconfig] + +if [ $# -ge 1 ] ; then + export KUBECONFIG=$1 +fi + +function deleting_apitestrig() { + NS=ida + while true; do + read -p "Are you sure you want to delete apitestrig helm charts?(Y/n) " yn + if [ $yn = "Y" ] + then + helm -n $NS delete ida-apitestrig + break + else + break + fi + done + return 0 +} + +# set commands for error handling. +set -e +set -o errexit ## set -e : exit the script if any statement returns a non-true return value +set -o nounset ## set -u : exit the script if you try to use an uninitialised variable +set -o errtrace # trace ERR through 'time command' and other functions +set -o pipefail # trace ERR through pipes +deleting_apitestrig # calling function \ No newline at end of file diff --git a/deploy/ida-apitestrig/install.sh b/deploy/ida-apitestrig/install.sh new file mode 100755 index 00000000000..ee1b41b1839 --- /dev/null +++ b/deploy/ida-apitestrig/install.sh @@ -0,0 +1,130 @@ +#!/bin/bash +# Installs apitestrig +## Usage: ./install.sh [kubeconfig] + +if [ $# -ge 1 ] ; then + export KUBECONFIG=$1 +fi + +NS=ida +CHART_VERSION=0.0.1-develop +COPY_UTIL=../copy_cm_func.sh + +echo Create $NS namespace +kubectl create ns $NS + +function installing_apitestrig() { + echo Istio label + kubectl label ns $NS istio-injection=disabled --overwrite + helm repo update + + echo Copy Configmaps + $COPY_UTIL configmap global default $NS + $COPY_UTIL configmap keycloak-host keycloak $NS + $COPY_UTIL configmap artifactory-share artifactory $NS + $COPY_UTIL configmap config-server-share config-server $NS + + echo echo Copy Secrtes + $COPY_UTIL secret keycloak-client-secrets keycloak $NS + $COPY_UTIL secret s3 s3 $NS + $COPY_UTIL secret postgres-postgresql postgres $NS + + echo "Delete s3, db, & apitestrig configmap if exists" + kubectl -n $NS delete --ignore-not-found=true configmap s3 + kubectl -n $NS delete --ignore-not-found=true configmap db + kubectl -n $NS delete --ignore-not-found=true configmap apitestrig + + DB_HOST=$( kubectl -n default get cm global -o json |jq -r '.data."mosip-api-internal-host"' ) + API_INTERNAL_HOST=$( kubectl -n default get cm global -o json |jq -r '.data."mosip-api-internal-host"' ) + ENV_USER=$( kubectl -n default get cm global -o json |jq -r '.data."mosip-api-internal-host"' | awk -F '.' '/api-internal/{print $1"."$2}') + + read -p "Please enter the time(hr) to run the cronjob every day (time: 0-23) : " time + if [ -z "$time" ]; then + echo "ERROT: Time cannot be empty; EXITING;"; + exit 1; + fi + if ! [ $time -eq $time ] 2>/dev/null; then + echo "ERROR: Time $time is not a number; EXITING;"; + exit 1; + fi + if [ $time -gt 23 ] || [ $time -lt 0 ] ; then + echo "ERROR: Time should be in range ( 0-23 ); EXITING;"; + exit 1; + fi + + echo "Do you have public domain & valid SSL? (Y/n) " + echo "Y: if you have public domain & valid ssl certificate" + echo "n: If you don't have a public domain and a valid SSL certificate. Note: It is recommended to use this option only in development environments." + read -p "" flag + + if [ -z "$flag" ]; then + echo "'flag' was provided; EXITING;" + exit 1; + fi + ENABLE_INSECURE='' + if [ "$flag" = "n" ]; then + ENABLE_INSECURE='--set enable_insecure=true'; + fi + + read -p "Please provide the retention days to remove old reports ( Default: 3 )" reportExpirationInDays + + if [[ -z $reportExpirationInDays ]]; then + reportExpirationInDays=3 + fi + if ! [[ $reportExpirationInDays =~ ^[0-9]+$ ]]; then + echo "The variable \"reportExpirationInDays\" should contain only number; EXITING"; + exit 1; + fi + + read -p "Please provide slack webhook URL to notify server end issues on your slack channel : " slackWebhookUrl + + if [ -z $slackWebhookUrl ]; then + echo "slack webhook URL not provided; EXITING;" + exit 1; + fi + + valid_inputs=("yes" "no") + eSignetDeployed="" + + while [[ ! " ${valid_inputs[@]} " =~ " ${eSignetDeployed} " ]]; do + read -p "Is the eSignet service deployed? (yes/no): " eSignetDeployed + eSignetDeployed=${eSignetDeployed,,} # Convert input to lowercase + done + + if [[ $eSignetDeployed == "yes" ]]; then + echo "eSignet service is deployed. Proceeding with installation..." + else + echo "eSignet service is not deployed. hence will be skipping esignet related test-cases..." + fi + + echo Installing ida apitestrig + helm -n $NS install ida-apitestrig mosip/apitestrig \ + --set crontime="0 $time * * *" \ + -f values.yaml \ + --version $CHART_VERSION \ + --set apitestrig.configmaps.s3.s3-host='http://minio.minio:9000' \ + --set apitestrig.configmaps.s3.s3-user-key='admin' \ + --set apitestrig.configmaps.s3.s3-region='' \ + --set apitestrig.configmaps.db.db-server="$DB_HOST" \ + --set apitestrig.configmaps.db.db-su-user="postgres" \ + --set apitestrig.configmaps.db.db-port="5432" \ + --set apitestrig.configmaps.apitestrig.ENV_USER="$ENV_USER" \ + --set apitestrig.configmaps.apitestrig.ENV_ENDPOINT="https://$API_INTERNAL_HOST" \ + --set apitestrig.configmaps.apitestrig.ENV_TESTLEVEL="smokeAndRegression" \ + --set apitestrig.configmaps.apitestrig.reportExpirationInDays="$reportExpirationInDays" \ + --set apitestrig.configmaps.apitestrig.slack-webhook-url="$slackWebhookUrl" \ + --set apitestrig.configmaps.apitestrig.eSignetDeployed="$eSignetDeployed" \ + --set apitestrig.configmaps.apitestrig.NS="$NS" \ + $ENABLE_INSECURE + + echo Installed ida apitestrig. + return 0 +} + +# set commands for error handling. +set -e +set -o errexit ## set -e : exit the script if any statement returns a non-true return value +set -o nounset ## set -u : exit the script if you try to use an uninitialised variable +set -o errtrace # trace ERR through 'time command' and other functions +set -o pipefail # trace ERR through pipes +installing_apitestrig # calling function \ No newline at end of file diff --git a/deploy/ida-apitestrig/values.yaml b/deploy/ida-apitestrig/values.yaml new file mode 100644 index 00000000000..d40a6442de3 --- /dev/null +++ b/deploy/ida-apitestrig/values.yaml @@ -0,0 +1,7 @@ +modules: + auth: + enabled: true + image: + repository: mosipqa/apitest-auth + tag: develop + pullPolicy: Always diff --git a/deploy/README.md b/deploy/ida/README.md similarity index 100% rename from deploy/README.md rename to deploy/ida/README.md diff --git a/deploy/certs_upload/postman/README.md b/deploy/ida/certs_upload/postman/README.md similarity index 100% rename from deploy/certs_upload/postman/README.md rename to deploy/ida/certs_upload/postman/README.md diff --git a/deploy/certs_upload/postman/collection.json b/deploy/ida/certs_upload/postman/collection.json similarity index 100% rename from deploy/certs_upload/postman/collection.json rename to deploy/ida/certs_upload/postman/collection.json diff --git a/deploy/certs_upload/postman/env.json b/deploy/ida/certs_upload/postman/env.json similarity index 100% rename from deploy/certs_upload/postman/env.json rename to deploy/ida/certs_upload/postman/env.json diff --git a/deploy/delete.sh b/deploy/ida/delete.sh similarity index 100% rename from deploy/delete.sh rename to deploy/ida/delete.sh diff --git a/deploy/install.sh b/deploy/ida/install.sh similarity index 93% rename from deploy/install.sh rename to deploy/ida/install.sh index bea94cfab0b..b85e80e2d00 100755 --- a/deploy/install.sh +++ b/deploy/ida/install.sh @@ -8,6 +8,7 @@ fi NS=ida CHART_VERSION=0.0.1-develop +COPY_UTIL=../copy_cm_func.sh echo Create $NS namespace kubectl create ns $NS @@ -18,8 +19,10 @@ function installing_ida() { helm repo update echo Copy configmaps - sed -i 's/\r$//' copy_cm.sh - ./copy_cm.sh + $COPY_UTIL configmap global default $NS + $COPY_UTIL configmap artifactory-share artifactory $NS + $COPY_UTIL configmap config-server-share config-server $NS + $COPY_UTIL configmap softhsm-ida-share softhsm $NS echo "Do you have public domain & valid SSL? (Y/n) " echo "Y: if you have public domain & valid ssl certificate" diff --git a/deploy/restart.sh b/deploy/ida/restart.sh similarity index 100% rename from deploy/restart.sh rename to deploy/ida/restart.sh diff --git a/docs/apitestrig-1.png b/docs/apitestrig-1.png new file mode 100644 index 00000000000..a7f36f6f057 Binary files /dev/null and b/docs/apitestrig-1.png differ diff --git a/docs/apitestrig-2.png b/docs/apitestrig-2.png new file mode 100644 index 00000000000..c6e48e63d37 Binary files /dev/null and b/docs/apitestrig-2.png differ diff --git a/helm/ida-auth/templates/deployment.yaml b/helm/ida-auth/templates/deployment.yaml index dd244d5fdc1..78b4f09d501 100644 --- a/helm/ida-auth/templates/deployment.yaml +++ b/helm/ida-auth/templates/deployment.yaml @@ -117,8 +117,10 @@ spec: {{- end }} {{- end }} {{- if .Values.extraEnvVarsSecret }} + {{- range .Values.extraEnvVarsSecret }} - secretRef: - name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsSecret "context" $) }} + name: {{ . }} + {{- end }} {{- end }} ports: - name: spring-service diff --git a/helm/ida-auth/values.yaml b/helm/ida-auth/values.yaml index 8e808c5f4ba..1264991e594 100644 --- a/helm/ida-auth/values.yaml +++ b/helm/ida-auth/values.yaml @@ -252,7 +252,7 @@ extraEnvVarsCM: ## Secret with extra environment variables ## -extraEnvVarsSecret: +extraEnvVarsSecret: [] ## Extra volumes to add to the deployment ## diff --git a/helm/ida-internal/templates/deployment.yaml b/helm/ida-internal/templates/deployment.yaml index 465d68012eb..e9b9b4ad4f2 100644 --- a/helm/ida-internal/templates/deployment.yaml +++ b/helm/ida-internal/templates/deployment.yaml @@ -117,8 +117,10 @@ spec: {{- end }} {{- end }} {{- if .Values.extraEnvVarsSecret }} + {{- range .Values.extraEnvVarsSecret }} - secretRef: - name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsSecret "context" $) }} + name: {{ . }} + {{- end }} {{- end }} ports: - name: spring-service diff --git a/helm/ida-internal/values.yaml b/helm/ida-internal/values.yaml index f1e5a5a1725..e0bc1158bac 100644 --- a/helm/ida-internal/values.yaml +++ b/helm/ida-internal/values.yaml @@ -252,7 +252,7 @@ extraEnvVarsCM: ## Secret with extra environment variables ## -extraEnvVarsSecret: +extraEnvVarsSecret: [] ## Extra volumes to add to the deployment ## diff --git a/helm/ida-otp/templates/deployment.yaml b/helm/ida-otp/templates/deployment.yaml index 7016a127aea..d016cb4bb08 100644 --- a/helm/ida-otp/templates/deployment.yaml +++ b/helm/ida-otp/templates/deployment.yaml @@ -117,8 +117,10 @@ spec: {{- end }} {{- end }} {{- if .Values.extraEnvVarsSecret }} + {{- range .Values.extraEnvVarsSecret }} - secretRef: - name: {{ include "common.tplvalues.render" (dict "value" .Values.extraEnvVarsSecret "context" $) }} + name: {{ . }} + {{- end }} {{- end }} ports: - name: spring-service diff --git a/helm/ida-otp/values.yaml b/helm/ida-otp/values.yaml index 0208fc6d359..e9c83140e6d 100644 --- a/helm/ida-otp/values.yaml +++ b/helm/ida-otp/values.yaml @@ -252,7 +252,7 @@ extraEnvVarsCM: ## Secret with extra environment variables ## -extraEnvVarsSecret: +extraEnvVarsSecret: [] ## Extra volumes to add to the deployment ##