From 58053ccca7849e0e3d342dfc11e9aa24baae8bcc Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:02:26 +0530 Subject: [PATCH 01/10] updated sidebar and prod dockerfile --- prod.dockerfile | 2 +- versioned_sidebars/version-1.3.0-sidebars.json | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/prod.dockerfile b/prod.dockerfile index 2691dd14..013d36bc 100644 --- a/prod.dockerfile +++ b/prod.dockerfile @@ -1,4 +1,4 @@ -FROM node:16.14.0-alpine3.15 as builder +FROM node:18.2.0-alpine as builder WORKDIR /build COPY package.json ./ COPY package-lock.json ./ diff --git a/versioned_sidebars/version-1.3.0-sidebars.json b/versioned_sidebars/version-1.3.0-sidebars.json index a631a95e..15828fa6 100644 --- a/versioned_sidebars/version-1.3.0-sidebars.json +++ b/versioned_sidebars/version-1.3.0-sidebars.json @@ -69,8 +69,6 @@ "get-started/prerequisites/prerequisites-gateway-node-label", "get-started/prerequisites/prerequisites-configure-helm-repository", "get-started/prerequisites/prerequisites-install-istio" - - ] } @@ -214,8 +212,8 @@ "collapsed": true, "link": { "type": "generated-index", - "title": "use-case", - "description": "The use case section provides details the use cases applicable to kubeslice", + "title": "Use Cases", + "description": "This section describes use cases for KubeSlice. Use cases offer a framework for articulating functional requirements within the framework of business and system processes. We will continue adding more KubeSlice use cases to this section.", "keywords": [ "kubeslice" ] @@ -227,8 +225,8 @@ "collapsed": true, "link": { "type": "generated-index", - "title": "use-case", - "description": "The use case section provides details the use cases applicable to kubeslice", + "title": "Distributed MongoDB", + "description": "This section provides the use case related to distributed MongoDB over multi cloud/clusters.", "keywords": [ "kubeslice" ] From 861296092167db240be06e4ed606ab9da399e54f Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:24:09 +0530 Subject: [PATCH 02/10] fixed the error --- .../version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx index 8a3ed470..097e04d6 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx @@ -1,6 +1,6 @@ # Replica Access Methods -Once the MongoDB replica sets are deployed over the slice across multiple clusters, there are different deployment models +After the MongoDB replica sets are deployed over the slice across multiple clusters, there are different deployment models that can be used to access the replicas. ## Access Replicas from within the Clusters From c8c25eaa6206f795dc92f4de9f9d31dcd27248ac Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:27:55 +0530 Subject: [PATCH 03/10] fixed the error --- .../use-cases/mongodb/replicas-access-methods.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx index 097e04d6..3d3e22bc 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx @@ -1,7 +1,7 @@ # Replica Access Methods -After the MongoDB replica sets are deployed over the slice across multiple clusters, there are different deployment models -that can be used to access the replicas. +After you deploy MongoDB replica sets over the slice across multiple clusters, there are different deployment models +you can use to access the replicas. ## Access Replicas from within the Clusters From 68f98959b553568b516cd69fc42eaa3a01aba041 Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 15:36:32 +0530 Subject: [PATCH 04/10] fixed the error --- .../mongodb/distributed-mongodb-for-multicloud.mdx | 6 +++--- .../use-cases/mongodb/replicas-access-methods.mdx | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index 7ee50afb..52933a9f 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -131,10 +131,10 @@ To create a slice: ``` The `mongodb-slice.yaml` or `mongo-slice-lb.yaml` file contains the configuration to create a namespace called `mongodb`, and - also on board it onto the demo-slice. The configuration also enables namespace sameness, which means that the `mongodb` slice - will be onboarded onto any worker cluster that is connected to the `demo-slice`. + also on board it onto the demo-slice. The configuration also enables namespace sameness, which means that the `mongodb` namespace + will be onboarded onto any worker cluster that is connected to the demo-slice. -2. Apply the slice configuration yaml file on the project namespace. +2. Apply the slice configuration YAML file on the project namespace. Example diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx index 3d3e22bc..3813e709 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/replicas-access-methods.mdx @@ -26,7 +26,7 @@ read and write to the primary replica set. ### Step 2: Deploy a MongoDB Shell Pod in the mongo-sh Namespace -Create and deploy a mongodb-sh pod in the mongo-sh namespace with the following configuration: +Create and deploy a `mongodb-sh` pod in the mongo-sh namespace with the following configuration: ``` kubectl apply -f - < Date: Wed, 23 Oct 2024 17:00:59 +0530 Subject: [PATCH 05/10] updated the command --- .../distributed-mongodb-for-multicloud.mdx | 46 ++++++++++++------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index 52933a9f..8df7309b 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -410,7 +410,8 @@ To create a slice: ops-manager-svc-ext LoadBalancer 10.7.32.125 34.23.212.14 8080:31348/TCP,25999:31914/TCP 13m ``` -9. To generate Ops Manager URL address if the service is exposed as a LoadBalancer, use the following command: +9. To generate Ops Manager URL address if the service is exposed as a LoadBalancer, use the following command + when the LoadBalancer assigns a DNS name to the service: :::caution The command below works if your service is exposed as a LoadBalancer. In case, it is exposed as Nodeport service use the URL @@ -426,7 +427,7 @@ To create a slice: Example ``` - URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}:{.spec.ports[0].port}') echo $URL + URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') echo $URL ``` Example Output @@ -718,8 +719,8 @@ Setting the environment variables is a prerequisite. 2. On the master cluster, use the following command to generate Ops Manager API keys and add IP addresses to the Ops Manager access list: :::note - The command below works only if your service is exposed as a LoadBalancer. In case, it is exposed as node port service, use - the URL as given below. + The command below only works if your service is exposed as a LoadBalancer. In case, it is exposed as node port service, use + the URL as given below: ``` URL=http://: @@ -727,19 +728,32 @@ Setting the environment variables is a prerequisite. where External Node IP of the worker node where Ops Manager is deployed & NodePort is the node port on which `ops-manager-svc-ext` is exposed. ::: - - ``` - kubectx $MASTER - URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}:{.spec.ports[0].port}') - echo $URL - ``` - - Example Output - ``` - Switched to context "k8s-cluster-1". - http://34.23.212.14:8080 - ``` + :::note + Use the host name in the command when the LoadBalancer assigns a DNS Name to the service. + ::: + + + - Use the IP address in the following command when the LoadBalancer assigns an external IP address to the service: + ``` + kubectx $MASTER + URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}:{.spec.ports[0].port}') + echo $URL + ``` + + Example Output + ``` + Switched to context "k8s-cluster-1". + http://34.23.212.14:8080 + ``` + + - Use the host name in the following command when the LoadBalancer assigns a DNS name to the service: + + ``` + kubectx $MASTER + URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') + echo $URL + ``` 15. Log in to Ops Manager, and generate public and private API keys. When you create API keys, be sure to add your current IP address to the API access list. To do so, log in to the Ops Manager and go to `ops-manager-db` organization. From 12ac81b5b7ce699feccef399f00783423299491e Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:35:39 +0530 Subject: [PATCH 06/10] updated the command --- .../mongodb/distributed-mongodb-for-multicloud.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index 8df7309b..c931d3ce 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -429,6 +429,13 @@ To create a slice: ``` URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') echo $URL ``` + + Use the host name when the LoadBalancer assigns an external IP address in the following command: + + ``` + URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}'):$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.spec.ports[0].port}') + echo $URL + ``` Example Output ``` From f97c124f09776f1a816ab4ae95d6637ae18aa43c Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 19:08:51 +0530 Subject: [PATCH 07/10] updated the command --- .../distributed-mongodb-for-multicloud.mdx | 31 +++++++++---------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index c931d3ce..3d2d2950 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -410,8 +410,7 @@ To create a slice: ops-manager-svc-ext LoadBalancer 10.7.32.125 34.23.212.14 8080:31348/TCP,25999:31914/TCP 13m ``` -9. To generate Ops Manager URL address if the service is exposed as a LoadBalancer, use the following command - when the LoadBalancer assigns a DNS name to the service: +9. To generate the Ops Manager URL address if the service is exposed as a LoadBalancer, use the following command: :::caution The command below works if your service is exposed as a LoadBalancer. In case, it is exposed as Nodeport service use the URL @@ -425,22 +424,22 @@ To create a slice: is exposed. ::: - Example - ``` - URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') echo $URL - ``` + - When the LoadBalancer assigns an a DNS Name to the services, use hostname in the following command: + ``` + URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') echo $URL + ``` - Use the host name when the LoadBalancer assigns an external IP address in the following command: + - When the LoadBalancer assigns an external IP address to the services, use the IP address in the following command: - ``` - URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}'):$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.spec.ports[0].port}') - echo $URL - ``` - - Example Output - ``` - http://34.23.212.14:8080 - ``` + ``` + URL=http://$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}'):$(kubectl -n "mongodb-operator" get svc ops-manager-svc-ext -o jsonpath='{.spec.ports[0].port}') + echo $URL + ``` + + Example Output + ``` + http://34.23.212.14:8080 + ``` 10. Update the Ops Manager Kubernetes manifest to include an external IP address created by LoadBalancer in the `spec.configuration.mms.centralUrl` through `kubectl patch` using the following command: From 862fbc2b0ef4fcb7ea3b215cc039459f0c60683b Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 19:13:19 +0530 Subject: [PATCH 08/10] updated the command --- .../use-cases/mongodb/distributed-mongodb-for-multicloud.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index 3d2d2950..e92179fa 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -410,7 +410,7 @@ To create a slice: ops-manager-svc-ext LoadBalancer 10.7.32.125 34.23.212.14 8080:31348/TCP,25999:31914/TCP 13m ``` -9. To generate the Ops Manager URL address if the service is exposed as a LoadBalancer, use the following command: +9. Generate the Ops Manager URL address if the service is exposed as a LoadBalancer. :::caution The command below works if your service is exposed as a LoadBalancer. In case, it is exposed as Nodeport service use the URL From 47ada668c97443c47358475e0cbe66864646305f Mon Sep 17 00:00:00 2001 From: veenamj-avesha <104770800+veenamj-avesha@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:46:34 +0530 Subject: [PATCH 09/10] Update distributed-mongodb-for-multicloud.mdx --- .../use-cases/mongodb/distributed-mongodb-for-multicloud.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index e92179fa..821be682 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -413,7 +413,7 @@ To create a slice: 9. Generate the Ops Manager URL address if the service is exposed as a LoadBalancer. :::caution - The command below works if your service is exposed as a LoadBalancer. In case, it is exposed as Nodeport service use the URL + The command below works if your service is exposed as a LoadBalancer. In case, it is exposed as NodePort service, use the URL as given below: ```yaml @@ -1008,4 +1008,4 @@ k8s-cluster-1 k8s-cluster-2 k8s-cluster-3 2. Verify each multi-replica-set that you created. - ![mongodb](/images/version1.3.0/use-cases/configure-mongodb/replicaset-deployment.png) \ No newline at end of file + ![mongodb](/images/version1.3.0/use-cases/configure-mongodb/replicaset-deployment.png) From 5ff1198255b960cf11df020a01b1dc33847f03d9 Mon Sep 17 00:00:00 2001 From: uma-kt <105046156+uma-kt@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:47:34 +0530 Subject: [PATCH 10/10] fixed alignment --- .../distributed-mongodb-for-multicloud.mdx | 62 +++++++++---------- 1 file changed, 29 insertions(+), 33 deletions(-) diff --git a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx index e92179fa..3a259a3c 100644 --- a/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx +++ b/versioned_docs/version-1.3.0/use-cases/mongodb/distributed-mongodb-for-multicloud.mdx @@ -722,44 +722,40 @@ Setting the environment variables is a prerequisite. echo $URL ``` - 2. On the master cluster, use the following command to generate Ops Manager API keys and add IP addresses to the Ops Manager access list: + 2. On the master cluster, generate Ops Manager API keys and add IP addresses to the Ops Manager access list: - :::note - The command below only works if your service is exposed as a LoadBalancer. In case, it is exposed as node port service, use - the URL as given below: + :::note + The command below only works if your service is exposed as a LoadBalancer. In case, it is exposed as node port service, use + the URL as given below: - ``` - URL=http://: - ``` - where External Node IP of the worker node where Ops Manager is deployed & NodePort is the node port on which `ops-manager-svc-ext` - is exposed. - ::: - - :::note - Use the host name in the command when the LoadBalancer assigns a DNS Name to the service. - ::: - + ``` + URL=http://: + ``` + where External Node IP of the worker node where Ops Manager is deployed & NodePort is the node port on which `ops-manager-svc-ext` + is exposed. + ::: - - Use the IP address in the following command when the LoadBalancer assigns an external IP address to the service: - ``` - kubectx $MASTER - URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}:{.spec.ports[0].port}') - echo $URL - ``` - - Example Output - ``` - Switched to context "k8s-cluster-1". - http://34.23.212.14:8080 - ``` + - Use the IP address in the following command when the LoadBalancer assigns an external IP address to the service: + + ``` + kubectx $MASTER + URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].ip}:{.spec.ports[0].port}') + echo $URL + ``` + + Example Output + ``` + Switched to context "k8s-cluster-1". + http://34.23.212.14:8080 + ``` - - Use the host name in the following command when the LoadBalancer assigns a DNS name to the service: + - Use the host name in the following command when the LoadBalancer assigns a DNS name to the service: - ``` - kubectx $MASTER - URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') - echo $URL - ``` + ``` + kubectx $MASTER + URL=http://$(kubectl -n mongodb-operator get svc ops-manager-svc-ext -o jsonpath='{.status.loadBalancer.ingress[0].hostname}:{.spec.ports[0].port}') + echo $URL + ``` 15. Log in to Ops Manager, and generate public and private API keys. When you create API keys, be sure to add your current IP address to the API access list. To do so, log in to the Ops Manager and go to `ops-manager-db` organization.