github/deprecated-helm-charts
1
0
Fork 0
mirror of https://github.com/helm/charts.git synced 2026-08-23 22:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

[stable/mongodb] Unify and refactor README.md (#18279)

Browse Source 
Signed-off-by: Carlos Rodriguez Hernandez <crhernandez@bitnami.com>
This commit is contained in:
Carlos Rodríguez Hernández
2019-10-24 07:06:28 -07:00
committed by Kubernetes Prow Robot
parent 8a957641e2
commit 7749e8bb35
2 changed files with 16 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stable/mongodb/Chart.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
apiVersion: v1
name: mongodb
version: 7.4.2
version: 7.4.3
appVersion: 4.0.13
description: NoSQL document-oriented database that stores JSON-like documents with dynamic schemas, simplifying the integration of data in content-driven applications.
keywords:
stable/mongodb/README.md
+15 -25
View File
@@ -29,7 +29,7 @@ To install the chart with the release name `my-release`:
$ helm install --name my-release stable/mongodb
```
The command deploys MongoDB on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
The command deploys MongoDB on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
@@ -43,7 +43,7 @@ $ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
## Parameters
The following table lists the configurable parameters of the MongoDB chart and their default values.
@@ -195,13 +195,17 @@ $ helm install --name my-release -f values.yaml stable/mongodb
> **Tip**: You can use the default [values.yaml](values.yaml)
### Production configuration
## Configuration and installation details
This chart includes a `values-production.yaml` file where you can find some parameters oriented to production configuration in comparison to the regular `values.yaml`.
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
```console
$ helm install --name my-release -f ./values-production.yaml stable/mongodb
```
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
### Production configuration and horizontal scaling
This chart includes a `values-production.yaml` file where you can find some parameters oriented to production configuration in comparison to the regular `values.yaml`. You can use this file instead of the default one.
- Switch to enable/disable replica set configuration:
```diff
@@ -227,25 +231,11 @@ $ helm install --name my-release -f ./values-production.yaml stable/mongodb
+ metrics.readinessProbe.enabled: true
```
To horizontally scale this chart, run the following command to scale the number of secondary nodes in your MongoDB replica set.
To horizontally scale this chart, you can use the `--replicas` flag to modify the number of secondary nodes in your MongoDB replica set.
```console
$ kubectl scale statefulset my-release-mongodb-secondary --replicas=3
```
### Replication
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
## Replication
You can start the MongoDB chart in replica set mode with the following command:
```bash
$ helm install --name my-release stable/mongodb --set replicaSet.enabled=true
```
You can start the MongoDB chart in replica set mode with the following parameter: `replicaSet.enabled=true`
Some characteristics of this chart are:
@@ -253,7 +243,7 @@ Some characteristics of this chart are:
- The number of secondary and arbiter nodes can be scaled out independently.
- Easy to move an application from using a standalone MongoDB server to use a replica set.
## Initialize a fresh instance
### Initialize a fresh instance
The [Bitnami MongoDB](https://github.com/bitnami/bitnami-docker-mongodb) image allows you to use your custom scripts to initialize a fresh instance. In order to execute the scripts, they must be located inside the chart folder `files/docker-entrypoint-initdb.d` so they can be consumed as a ConfigMap.
Also you can create a custom config map and give it via `initConfigMap`(check options for more details).