From f6b9f260a74a346402df7c282b7848313847d539 Mon Sep 17 00:00:00 2001 From: xet-a Date: Sat, 20 Jul 2024 15:30:10 +0900 Subject: [PATCH 1/4] Add namespace creation step to Istio installation instructions --- docs/self-hosted-server/minikube.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/self-hosted-server/minikube.mdx b/docs/self-hosted-server/minikube.mdx index 281520f..64b8c29 100644 --- a/docs/self-hosted-server/minikube.mdx +++ b/docs/self-hosted-server/minikube.mdx @@ -62,7 +62,13 @@ After ingress addons are enabled, you will see the following output: After Minikube is configured, you need to install Istio for Yorkie cluster. Yorkie cluster uses Istio for L7 load balancing and traffic management. -Install Istio with the following command: +First, create the `yorkie` namespace: + +```bash +$ kubectl create namespace yorkie +``` + +Then, install Istio with the following command: ```bash $ istioctl install -f <(curl -s https://raw.githubusercontent.com/yorkie-team/yorkie/main/build/charts/yorkie-cluster/istio-operator.yaml) From 280d688acfd1e14133949cf60118259c398fc06c Mon Sep 17 00:00:00 2001 From: xet-a Date: Sat, 20 Jul 2024 23:29:46 +0900 Subject: [PATCH 2/4] Update docs for setting up MongoDB pod and service --- docs/self-hosted-server/minikube.mdx | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/self-hosted-server/minikube.mdx b/docs/self-hosted-server/minikube.mdx index 64b8c29..0297fd1 100644 --- a/docs/self-hosted-server/minikube.mdx +++ b/docs/self-hosted-server/minikube.mdx @@ -62,7 +62,7 @@ After ingress addons are enabled, you will see the following output: After Minikube is configured, you need to install Istio for Yorkie cluster. Yorkie cluster uses Istio for L7 load balancing and traffic management. -First, create the `yorkie` namespace: +First, create the `yorkie` namespace with the following command: ```bash $ kubectl create namespace yorkie @@ -113,6 +113,30 @@ Then, update your local repository with the following command: $ helm repo update ``` +### Setup MongoDB pod and service + +Before installing the Yorkie cluster with Helm chart, you need to set up a MongoDB pod and expose it as a service. This is crucial since internal MongoDB installation is no longer provided and it avoids errors during Yorkie server provisioning. + +First, create the `mongodb` namespace with the following command: + +```bash +$ kubectl create namespace mongodb +``` + +Then, create a MongoDB pod named `mongodb` in the `mongodb` namespace with the following command: + +```bash +$ kubectl run mongodb --image=mongo:latest --port=27017 -n mongodb +``` + +Next, expose the MongoDB pod as a service to allow other pods to access it with the following command: + +```bash +$ kubectl expose pod mongodb --port=27017 --target-port=27017 --name=mongodb --type=ClusterIP -n mongodb +``` + +By following these steps, you ensure that the MongoDB pod is running and accessible to other pods within the cluster. + ### Install Yorkie cluster with Helm chart Now you have added yorkie-team Helm chart repository in your local repository, you can install Yorkie cluster with Helm chart. From bc98717e2c564d4a5f4995d113fe9369e8e62d91 Mon Sep 17 00:00:00 2001 From: xet-a Date: Sat, 20 Jul 2024 23:35:29 +0900 Subject: [PATCH 3/4] Fix typo in docs * Delete the duplicate ```bash --- docs/self-hosted-server.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/self-hosted-server.mdx b/docs/self-hosted-server.mdx index 48306c1..531ac38 100644 --- a/docs/self-hosted-server.mdx +++ b/docs/self-hosted-server.mdx @@ -13,8 +13,6 @@ To run a Yorkie Server, you need to install the CLI. If you haven't installed it Let's start a Server with the CLI. You can start a Server with the following command: -```bash - ```bash $ yorkie server From 4ded5f8f85bdaf040d1e6acb36feb172e3f525e3 Mon Sep 17 00:00:00 2001 From: xet-a Date: Sun, 21 Jul 2024 13:11:08 +0900 Subject: [PATCH 4/4] Update docs for repositioning paragraphs --- docs/self-hosted-server/minikube.mdx | 34 ++++++++++++++-------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/self-hosted-server/minikube.mdx b/docs/self-hosted-server/minikube.mdx index 0297fd1..86cb900 100644 --- a/docs/self-hosted-server/minikube.mdx +++ b/docs/self-hosted-server/minikube.mdx @@ -97,25 +97,9 @@ Making this installation the default for injection and validation. Thank you for installing Istio 1.17. Please take a few minutes to tell us about your install/upgrade experience! https://forms.gle/hMHGiwZHPU7UQRWe9 ``` -### Add yorkie-team Helm chart in your local repository - -After Istio is installed, you need to add yorkie-team Helm chart repository in your local repository to install Yorkie cluster. - -Add yorkie-team Helm chart repository in your local repository with the following command: - -```bash -$ helm repo add yorkie-team https://yorkie-team.github.io/yorkie/helm-charts -``` - -Then, update your local repository with the following command: - -```bash -$ helm repo update -``` - ### Setup MongoDB pod and service -Before installing the Yorkie cluster with Helm chart, you need to set up a MongoDB pod and expose it as a service. This is crucial since internal MongoDB installation is no longer provided and it avoids errors during Yorkie server provisioning. +Before installing the Yorkie cluster with Helm chart, you need to set up a MongoDB pod and expose it as a service. This is crucial since internal MongoDB installation is no longer provided. First, create the `mongodb` namespace with the following command: @@ -137,6 +121,22 @@ $ kubectl expose pod mongodb --port=27017 --target-port=27017 --name=mongodb --t By following these steps, you ensure that the MongoDB pod is running and accessible to other pods within the cluster. +### Add yorkie-team Helm chart in your local repository + +After Istio is installed, you need to add yorkie-team Helm chart repository in your local repository to install Yorkie cluster. + +Add yorkie-team Helm chart repository in your local repository with the following command: + +```bash +$ helm repo add yorkie-team https://yorkie-team.github.io/yorkie/helm-charts +``` + +Then, update your local repository with the following command: + +```bash +$ helm repo update +``` + ### Install Yorkie cluster with Helm chart Now you have added yorkie-team Helm chart repository in your local repository, you can install Yorkie cluster with Helm chart.