From 24dbe6793470b8504ef997ea3a4bf66ae6973d55 Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Mon, 12 Dec 2022 10:02:04 +0530 Subject: [PATCH 1/8] Update mb-install.md --- learn/on-premise/extensions/mb-install.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/learn/on-premise/extensions/mb-install.md b/learn/on-premise/extensions/mb-install.md index 09f6f83c2..73963984b 100644 --- a/learn/on-premise/extensions/mb-install.md +++ b/learn/on-premise/extensions/mb-install.md @@ -23,16 +23,7 @@ kubectl version - Downnload helm package from the given link shared by WaveMaker support team. ```bash -helm command //TODO -``` - - -### Check sha1sum - -- Verify SHA1SUM of downloaded file with the SHA1SUM given by WaveMaker support - -```bash -sha1sum command //TODO +cat | helm registry login -u _json_key_base64 --password-stdin https://us-east4-docker.pkg.dev ``` ### Namespace creation @@ -48,7 +39,7 @@ kubectl create ns mockingbird - Login to docker with JSON Key provided by WaveMaker support ```bash -//TODO command +cat | docker login -u KEY-TYPE --password-stdin https://us-east4-docker.pkg.dev ``` ### Create K8s secrets From f1798d513166bf96455361c40b09faa783a5d721 Mon Sep 17 00:00:00 2001 From: Niranjan Andhe Date: Thu, 15 Dec 2022 08:34:10 +0530 Subject: [PATCH 2/8] Completed the #TODO in the mb-install, mb-integrate, mb-persisentvolumes files. --- learn/on-premise/extensions/mb-install.md | 31 ++- learn/on-premise/extensions/mb-integrate.md | 2 +- .../extensions/mb-persistentvolumes.md | 203 +++++++++--------- 3 files changed, 129 insertions(+), 107 deletions(-) diff --git a/learn/on-premise/extensions/mb-install.md b/learn/on-premise/extensions/mb-install.md index 73963984b..75c2e6ca3 100644 --- a/learn/on-premise/extensions/mb-install.md +++ b/learn/on-premise/extensions/mb-install.md @@ -23,7 +23,8 @@ kubectl version - Downnload helm package from the given link shared by WaveMaker support team. ```bash -cat | helm registry login -u _json_key_base64 --password-stdin https://us-east4-docker.pkg.dev +cat | helm registry login -u _json_key_base64 --password-stdin https://us-east4-docker.pkg.dev +helm pull oci://us-east4-docker.pkg.dev/api-mock-server-332212/mockingbird/helm-charts/api-mock-server --version [MOCKINGBIRD-VERSION] ``` ### Namespace creation @@ -44,22 +45,44 @@ cat | docker login -u KEY-TYPE --password-stdin https://us-eas ### Create K8s secrets -- Create image pull secrets after replacing Directory-Path-to-CONFIG-JSON path //TODO +- Create image pull secrets after replacing Directory-Path-to-CONFIG-JSON path, by default path is $HOME/.docker/config.json + ```bash Command kubectl create secret generic mb-image-pull-secret --from-file=.dockerconfigjson=[Directory-Path-to-CONFIG-JSON]/config.json --type=kubernetes.io/dockerconfigjson -n mockingbird ``` - Create SSL cert secret with CERT_PRIVATE_KEY_FILE and CERT_FILE replaced with path values. + ```bash kubectl create secret tls mb-ssl-secret --key ${CERT_PRIVATE_KEY_FILE} --cert ${CERT_FILE} ``` +### Create K8s configmap + +- Create configmap yaml file with this code snippet and replace the MOCKINGBIRD-DOMAIN and MOCKINGBIRD-STATIC-IP + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: mockingbird-cm + namespace: mockingbird +data: + domainName=[MOCKINGBIRD-DOMAIN] + loadBalancerIP=[MOCKINGBIRD-STATIC-IP] +``` +- Create the configmap with this command + +```bash +kubectl apply -f configmap.yaml -n mockingbird +``` + #### Install Helm Chart -- Run helm command to install chart for MockingBird Platform by replacing HELM-PACKAGE and MOCKINGBIRD-DOMAIN +- Run helm command to install chart for MockingBird Platform by replacing HELM-PACKAGE ```bash -helm install mockingbird [HELM-PACKAGE] -n mockingbird --set "global.domainName=[MOCKINGBIRD-DOMAIN]" --set "apimock-ingress-nginx.controller.service.loadBalancerIP=[MOCKINGBIRD-STATIC-IP]" +helm install mockingbird [HELM-PACKAGE] -n mockingbird ``` ### Map domain to Static IP reserved for MockingBird diff --git a/learn/on-premise/extensions/mb-integrate.md b/learn/on-premise/extensions/mb-integrate.md index 2cfee30bf..fbfdcad99 100644 --- a/learn/on-premise/extensions/mb-integrate.md +++ b/learn/on-premise/extensions/mb-integrate.md @@ -13,5 +13,5 @@ Integrate Mockingbird with WME Platform - Example ["1.2.3.4/32", "1.2.3.5/24"] ```bash -apimock-ingress-nginx.controller.service.loadBalancerSourceRanges: [WHITELIST-IP-RANGE] --reuse-values +helm upgrade mockingbird [HELM-PACKAGE] -n mockingbird --set apimock-ingress-nginx.controller.service.loadBalancerSourceRanges: [WHITELIST-IP-RANGE] ``` diff --git a/learn/on-premise/extensions/mb-persistentvolumes.md b/learn/on-premise/extensions/mb-persistentvolumes.md index ff7db8f73..ed250e2bf 100644 --- a/learn/on-premise/extensions/mb-persistentvolumes.md +++ b/learn/on-premise/extensions/mb-persistentvolumes.md @@ -35,17 +35,16 @@ Make sure these storage disks are at same region as K8s cluster. storageclass.yaml -```bash - apiVersion: storage.k8s.io/v1 - kind: StorageClass - metadata: - name: mockingbird-sc - parameters: - type: pd-standard - provisioner: kubernetes.io/gce-pd - allowVolumeExpansion: true - reclaimPolicy: Retain - volumeBindingMode: WaitForFirstConsumer +```yaml +apiVersion: storage.k8s.io/v1 +kind: StorageClass +metadata: + name: mockingbird-sc +parameters: + type: pd-standard +provisioner: kubernetes.io/gce-pd +allowVolumeExpansion: true +reclaimPolicy: Retain ``` - Create StorageClass with this command @@ -60,97 +59,97 @@ kubectl apply -f storageclass.yaml -n mockingbird servicestorage.yaml -```bash - apiVersion: v1 - kind: PersistentVolume - metadata: - name: pv-k8s-mbe-redis-data - spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-redis-data - gcePersistentDisk: - pdName: k8s-mbe-redis-data - --- - apiVersion: v1 - kind: PersistentVolumeClaim - metadata: - name: pv-claim-k8s-mbe-redis-data - namespace: mockingbird - spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi - --- - - apiVersion: v1 - kind: PersistentVolume - metadata: - name: pv-k8s-mbe-swagger-json-data - spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-swagger-json-data - gcePersistentDisk: - pdName: k8s-mbe-swagger-json-data - --- - - apiVersion: v1 - kind: PersistentVolumeClaim - metadata: - name: pv-claim-k8s-mbe-swagger-json-data - namespace: mockingbird - spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi - --- - - apiVersion: v1 - kind: PersistentVolume - metadata: - name: pv-k8s-mbe-tomcat-logs-data - spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-tomcat-logs-data - gcePersistentDisk: - pdName: k8s-mbe-tomcat-logs-data - --- - - apiVersion: v1 - kind: PersistentVolumeClaim - metadata: - name: pv-claim-k8s-mbe-tomcat-logs-data - namespace: mockingbird - spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi +```yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: pv-k8s-mbe-redis-data +spec: + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-redis-data + gcePersistentDisk: + pdName: k8s-mbe-redis-data +--- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: pv-claim-k8s-mbe-redis-data + namespace: mockingbird +spec: + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi +--- + +apiVersion: v1 +kind: PersistentVolume +metadata: + name: pv-k8s-mbe-swagger-json-data +spec: + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-swagger-json-data + gcePersistentDisk: + pdName: k8s-mbe-swagger-json-data +--- + +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: pv-claim-k8s-mbe-swagger-json-data + namespace: mockingbird +spec: + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi +--- + +apiVersion: v1 +kind: PersistentVolume +metadata: + name: pv-k8s-mbe-tomcat-logs-data +spec: + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-tomcat-logs-data + gcePersistentDisk: + pdName: k8s-mbe-tomcat-logs-data +--- + +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: pv-claim-k8s-mbe-tomcat-logs-data + namespace: mockingbird +spec: + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi ``` - Create PV's and PVC's with this command From 8ff35f6fb5d7d4b05eee34713ba85559767ac78d Mon Sep 17 00:00:00 2001 From: Niranjan Andhe Date: Thu, 15 Dec 2022 08:48:19 +0530 Subject: [PATCH 3/8] Added the helm package sha1sum check. --- learn/on-premise/extensions/mb-install.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/learn/on-premise/extensions/mb-install.md b/learn/on-premise/extensions/mb-install.md index 75c2e6ca3..90bf2bfb1 100644 --- a/learn/on-premise/extensions/mb-install.md +++ b/learn/on-premise/extensions/mb-install.md @@ -27,6 +27,15 @@ cat | helm registry login -u _json_key_base64 --password- helm pull oci://us-east4-docker.pkg.dev/api-mock-server-332212/mockingbird/helm-charts/api-mock-server --version [MOCKINGBIRD-VERSION] ``` +### Check sha1sum + +- Verify SHA1SUM of downloaded file with the SHA1SUM given by WaveMaker support + +```bash +sha1sum api-mock-server-[MOCKINGBIRD-VERSION].tgz +``` + + ### Namespace creation - Create a new namespace From e4ca003a9e2001d4adf1e2fa0fbcb9a315bf3abe Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Thu, 15 Dec 2022 13:39:05 +0530 Subject: [PATCH 4/8] Update mb-persistentvolumes.md --- .../extensions/mb-persistentvolumes.md | 119 +++++++++--------- 1 file changed, 59 insertions(+), 60 deletions(-) diff --git a/learn/on-premise/extensions/mb-persistentvolumes.md b/learn/on-premise/extensions/mb-persistentvolumes.md index ed250e2bf..807c40494 100644 --- a/learn/on-premise/extensions/mb-persistentvolumes.md +++ b/learn/on-premise/extensions/mb-persistentvolumes.md @@ -39,9 +39,9 @@ storageclass.yaml apiVersion: storage.k8s.io/v1 kind: StorageClass metadata: - name: mockingbird-sc + name: mockingbird-sc parameters: - type: pd-standard + type: pd-standard provisioner: kubernetes.io/gce-pd allowVolumeExpansion: true reclaimPolicy: Retain @@ -63,93 +63,92 @@ servicestorage.yaml apiVersion: v1 kind: PersistentVolume metadata: - name: pv-k8s-mbe-redis-data + name: pv-k8s-mbe-redis-data spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-redis-data - gcePersistentDisk: - pdName: k8s-mbe-redis-data + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-redis-data + gcePersistentDisk: + pdName: k8s-mbe-redis-data --- apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: pv-claim-k8s-mbe-redis-data - namespace: mockingbird + name: pv-claim-k8s-mbe-redis-data + namespace: mockingbird spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi --- - apiVersion: v1 kind: PersistentVolume metadata: - name: pv-k8s-mbe-swagger-json-data + name: pv-k8s-mbe-swagger-json-data spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-swagger-json-data - gcePersistentDisk: - pdName: k8s-mbe-swagger-json-data + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-swagger-json-data + gcePersistentDisk: + pdName: k8s-mbe-swagger-json-data --- apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: pv-claim-k8s-mbe-swagger-json-data - namespace: mockingbird + name: pv-claim-k8s-mbe-swagger-json-data + namespace: mockingbird spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi --- apiVersion: v1 kind: PersistentVolume metadata: - name: pv-k8s-mbe-tomcat-logs-data + name: pv-k8s-mbe-tomcat-logs-data spec: - storageClassName: "mockingbird-sc" - capacity: - storage: 50Gi - accessModes: - - ReadWriteOnce - claimRef: - namespace: mockingbird - name: pv-claim-k8s-mbe-tomcat-logs-data - gcePersistentDisk: - pdName: k8s-mbe-tomcat-logs-data + storageClassName: "mockingbird-sc" + capacity: + storage: 50Gi + accessModes: + - ReadWriteOnce + claimRef: + namespace: mockingbird + name: pv-claim-k8s-mbe-tomcat-logs-data + gcePersistentDisk: + pdName: k8s-mbe-tomcat-logs-data --- apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: pv-claim-k8s-mbe-tomcat-logs-data - namespace: mockingbird + name: pv-claim-k8s-mbe-tomcat-logs-data + namespace: mockingbird spec: - storageClassName: "mockingbird-sc" - accessModes: - - ReadWriteOnce - resources: - requests: - storage: 50Gi + storageClassName: "mockingbird-sc" + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 50Gi ``` - Create PV's and PVC's with this command From fa055873a8ca82891195894fe9bac3c6454f688c Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Tue, 20 Dec 2022 09:40:27 +0530 Subject: [PATCH 5/8] Update mb-install.md --- learn/on-premise/extensions/mb-install.md | 27 +++++++++-------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/learn/on-premise/extensions/mb-install.md b/learn/on-premise/extensions/mb-install.md index 90bf2bfb1..1f9bd3a9a 100644 --- a/learn/on-premise/extensions/mb-install.md +++ b/learn/on-premise/extensions/mb-install.md @@ -66,24 +66,19 @@ kubectl create secret generic mb-image-pull-secret --from-file=.dockerconfigjson kubectl create secret tls mb-ssl-secret --key ${CERT_PRIVATE_KEY_FILE} --cert ${CERT_FILE} ``` -### Create K8s configmap +### Create one time setup values yaml -- Create configmap yaml file with this code snippet and replace the MOCKINGBIRD-DOMAIN and MOCKINGBIRD-STATIC-IP +- Create values yaml file with this code snippet and replace the MOCKINGBIRD-DOMAIN and MOCKINGBIRD-STATIC-IP -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: mockingbird-cm - namespace: mockingbird -data: - domainName=[MOCKINGBIRD-DOMAIN] - loadBalancerIP=[MOCKINGBIRD-STATIC-IP] -``` -- Create the configmap with this command +one-time-setup-values.yaml -```bash -kubectl apply -f configmap.yaml -n mockingbird +```yaml +global: + domainName: [MOCKINGBIRD-DOMAIN] +apimock-ingress-nginx: + controller: + service: + loadBalancerIP: [MOCKINGBIRD-STATIC-IP] ``` #### Install Helm Chart @@ -91,7 +86,7 @@ kubectl apply -f configmap.yaml -n mockingbird - Run helm command to install chart for MockingBird Platform by replacing HELM-PACKAGE ```bash -helm install mockingbird [HELM-PACKAGE] -n mockingbird +helm install mockingbird [HELM-PACKAGE] -n mockingbird -f one-time-setup-values.yaml ``` ### Map domain to Static IP reserved for MockingBird From 4e32b8e57a69fc7c89680a1e4b20132fcc71396d Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Tue, 20 Dec 2022 09:44:43 +0530 Subject: [PATCH 6/8] Update mb-upgrade.md --- learn/on-premise/extensions/mb-upgrade.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/learn/on-premise/extensions/mb-upgrade.md b/learn/on-premise/extensions/mb-upgrade.md index 67f8895f7..551d24fd9 100644 --- a/learn/on-premise/extensions/mb-upgrade.md +++ b/learn/on-premise/extensions/mb-upgrade.md @@ -13,7 +13,7 @@ sidebar_label: "Integrate MockingBird Platform with WME" - Replace [HELM-PATCH-PACKAGE] with the helm package name of new release or patch release after download ```bash -helm upgrade mockingbird [HELM-PATCH-PACKAGE] -n mockingbird --reuse-values" +helm upgrade mockingbird [HELM-PATCH-PACKAGE] -n mockingbird -f one-time-setup-values.yaml" ``` ### RoleBack MockingBird setup @@ -21,5 +21,5 @@ helm upgrade mockingbird [HELM-PATCH-PACKAGE] -n mockingbird --reuse-values" - Here is the command to rollback previously installed patch/upgrade ```bash -helm rollback mockingbird [HELM-PATCH-PACKAGE] -n mockingbird --reuse-values //TODO verify rollback command +helm rollback mockingbird -n mockingbird ``` From d23865c1977c87546c47742bcfef0751475d7863 Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Thu, 22 Dec 2022 16:57:20 +0530 Subject: [PATCH 7/8] Update mb-install.md --- learn/on-premise/extensions/mb-install.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/learn/on-premise/extensions/mb-install.md b/learn/on-premise/extensions/mb-install.md index 1f9bd3a9a..115fd6b44 100644 --- a/learn/on-premise/extensions/mb-install.md +++ b/learn/on-premise/extensions/mb-install.md @@ -24,6 +24,8 @@ kubectl version ```bash cat | helm registry login -u _json_key_base64 --password-stdin https://us-east4-docker.pkg.dev +``` +```bash helm pull oci://us-east4-docker.pkg.dev/api-mock-server-332212/mockingbird/helm-charts/api-mock-server --version [MOCKINGBIRD-VERSION] ``` @@ -49,7 +51,7 @@ kubectl create ns mockingbird - Login to docker with JSON Key provided by WaveMaker support ```bash -cat | docker login -u KEY-TYPE --password-stdin https://us-east4-docker.pkg.dev +cat | docker login -u _json_key_base64 --password-stdin https://us-east4-docker.pkg.dev ``` ### Create K8s secrets @@ -63,7 +65,7 @@ kubectl create secret generic mb-image-pull-secret --from-file=.dockerconfigjson - Create SSL cert secret with CERT_PRIVATE_KEY_FILE and CERT_FILE replaced with path values. ```bash -kubectl create secret tls mb-ssl-secret --key ${CERT_PRIVATE_KEY_FILE} --cert ${CERT_FILE} +kubectl create secret tls mb-ssl-secret --key ${CERT_PRIVATE_KEY_FILE} --cert ${CERT_FILE} -n mockingbird ``` ### Create one time setup values yaml From 9df972ee353653fbf98522e0db18a10895850b44 Mon Sep 17 00:00:00 2001 From: andheniranjan <120087203+andheniranjan@users.noreply.github.com> Date: Thu, 22 Dec 2022 16:58:39 +0530 Subject: [PATCH 8/8] Update mb-upgrade.md --- learn/on-premise/extensions/mb-upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/learn/on-premise/extensions/mb-upgrade.md b/learn/on-premise/extensions/mb-upgrade.md index 551d24fd9..23544c890 100644 --- a/learn/on-premise/extensions/mb-upgrade.md +++ b/learn/on-premise/extensions/mb-upgrade.md @@ -13,7 +13,7 @@ sidebar_label: "Integrate MockingBird Platform with WME" - Replace [HELM-PATCH-PACKAGE] with the helm package name of new release or patch release after download ```bash -helm upgrade mockingbird [HELM-PATCH-PACKAGE] -n mockingbird -f one-time-setup-values.yaml" +helm upgrade mockingbird [HELM-PATCH-PACKAGE] -n mockingbird -f one-time-setup-values.yaml ``` ### RoleBack MockingBird setup