Skip to content

Commit e816a17

Browse files
authored
Enable MongoDB by Default and Update Installation Guide (#1601)
Set mongodb.enabled to true by default to ensure automatic MongoDB installation, and updated the installation guide to include --namespace yorkie so MongoDB is deployed in the same namespace as Yorkie cluster, allowing the mongodb-sharding-setup job to run successfully.
1 parent 57094aa commit e816a17

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

build/charts/yorkie-cluster/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentati
3434

3535
```bash
3636
# Uses pre-configured development credentials (clearly marked as dev-only)
37-
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster
37+
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster --namespace yorkie
3838
```
3939

4040
### For Production:
@@ -43,7 +43,7 @@ helm install [RELEASE_NAME] yorkie-team/yorkie-cluster
4343

4444
```bash
4545
# Generate strong random passwords
46-
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster \
46+
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster --namespace yorkie \
4747
--set mongodb.credentials.databaseAdmin.password="$(openssl rand -base64 32)" \
4848
--set mongodb.credentials.userAdmin.password="$(openssl rand -base64 32)" \
4949
--set mongodb.credentials.clusterAdmin.password="$(openssl rand -base64 32)"
@@ -55,10 +55,12 @@ helm install [RELEASE_NAME] yorkie-team/yorkie-cluster \
5555

5656
Install Yorkie cluster with MongoDB deployed by Percona Operator:
5757

58+
> [!IMPORTANT]
59+
> Setting namespace is needed to ensure MongoDB is deployed in the same namespace with Yorkie cluster.
60+
5861
```bash
5962
# Install yorkie cluster with MongoDB
60-
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster \
61-
--set mongodb.enabled=true \
63+
helm install [RELEASE_NAME] yorkie-team/yorkie-cluster --namespace yorkie \
6264
--set mongodb.credentials.databaseAdmin.password="<your-password>" \
6365
--set mongodb.credentials.userAdmin.password="<your-password>" \
6466
--set mongodb.credentials.clusterAdmin.password="<your-password>"
@@ -81,7 +83,7 @@ _See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command docum
8183
## Uninstall Helm Chart
8284

8385
```bash
84-
helm uninstall [RELEASE_NAME]
86+
helm uninstall [RELEASE_NAME] --namespace yorkie
8587
```
8688

8789
This removes all the Kubernetes components associated with the chart and deletes the release.

build/charts/yorkie-cluster/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ ratelimit:
8181
# Configuration for MongoDB (Percona Operator)
8282
mongodb:
8383
# Enable/disable MongoDB deployment
84-
enabled: false
84+
enabled: true
8585

8686
# MongoDB user credentials
8787
credentials:

0 commit comments

Comments
 (0)