Improve yorkie-mongodb with yorkie-cluster

- refactor typo and wording
- set sharded=true to default option
- remove yorkie-mongodb dependency condition for standalone mode

Author: hyun98

build/charts/yorkie-cluster/Chart.lock

@@ -3,4 +3,4 @@ dependencies:
   repository: ""
   version: 0.4.13
 digest: sha256:0c702d4ee264c8cbc9a8959d0290c12679e013ccd7a979fcbf81a8c03519b220
-generated: "2024-08-29T01:24:48.119979+09:00"
+generated: "2024-10-19T15:27:57.253314+09:00"

build/charts/yorkie-cluster/Chart.yaml

@@ -18,7 +18,6 @@ kubeVersion: ">=1.23.0-0"
 dependencies:
   - name: yorkie-mongodb
     version: 0.4.13
-    condition: yorkie-mongodb.sharded.enabled
 
 keywords:
   - yorkie

build/charts/yorkie-cluster/README.md

@@ -30,10 +30,13 @@ _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentati
 
 ```bash
 # Create mongodb namespace
-kubectl create namespace yorkie
+kubectl create namespace mongodb
 
 # Install yorkie cluster helm chart
-helm install [RELEASE_NAME] yorkie-team/yorkie-cluster --set=yorkie-mongodb.sharded.enabled=true
+helm install [RELEASE_NAME] yorkie-team/yorkie-cluster
+
+# Install yorkie cluster helm chart with standalone parameter (disable sharding)
+helm install [RELEASE_NAME] yorkie-team/yorkie-cluster --set=yorkie-mongodb.sharded.enabled=false
 ```
 
 _See [configuration](#configuration) below for custom installation_

build/charts/yorkie-cluster/templates/yorkie/deployment.yaml

@@ -34,7 +34,7 @@ spec:
     spec:
       {{ if index .Values "yorkie-mongodb" "sharded" "enabled"}}
       initContainers:
-      - name: wait-db
+      - name: wait-for-sharded-db-provision
         image: bitnami/kubectl:latest
         command:
           - /bin/sh
@@ -44,10 +44,10 @@ spec:
             while true; do
               job_status=$(kubectl get job -n $NAMESPACE $JOB_NAME -o jsonpath='{.status.conditions[?(@.type=="Complete")].status}')
               if [ "$job_status" = "True" ]; then
-                echo "Job completed"
+                echo "DB provisioning Job completed successfully!"
                 break
               fi
-              echo "Waiting for job to complete..."
+              echo "Waiting for DB provisioning job to complete..."
               sleep 5
             done
         env:
@@ -86,4 +86,4 @@ spec:
             port: {{ .Values.yorkie.ports.rpcPort }}
           initialDelaySeconds: 10
         resources:
-          {{ toYaml .Values.yorkie.resources | nindent 12 }}
+          {{ toYaml .Values.yorkie.resources | nindent 12 }}

build/charts/yorkie-cluster/templates/yorkie/role.yaml

@@ -3,7 +3,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   namespace: {{ index .Values "yorkie-mongodb" "namespace" }}
-  name: db-status-reader
+  name: db-provisioning-job-status-reader
 rules:
   - apiGroups: ["batch"]
     resources: ["jobs"]
@@ -22,7 +22,7 @@ subjects:
     namespace: {{ .Values.yorkie.namespace }}
 roleRef:
   kind: Role
-  name: db-status-reader
+  name: db-provisioning-job-status-reader
   apiGroup: rbac.authorization.k8s.io
 
 ---
@@ -32,4 +32,4 @@ kind: ServiceAccount
 metadata:
   name: yorkie-db-service-account
   namespace: {{ .Values.yorkie.namespace }}
-{{ end -}}
+{{ end -}}

build/charts/yorkie-cluster/values.yaml

@@ -77,5 +77,13 @@ yorkie-mongodb:
   namespace: mongodb
   port: 27017
   clusterDomain: cluster.local
+  image:
+    registry: docker.io
+    repository: mongo
+    tag: "6.0"
+  persistence:
+    dataSize: 1Gi
+    configSize: 500Mi
+    storageClass: standard
   sharded:
-    enabled: false
+    enabled: true