Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Readme for Percona MongoDB helm chart #249

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+55 −7
Open

Updated Readme for Percona MongoDB helm chart #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion charts/psmdb-operator-db/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,35 @@ helm dependency build
helm install my-db <path-to-chart> --namespace my-namespace
```

The chart can be customized using the following configurable parameters:
#These parameters are for psmdb-operator:

| Parameter | Description | Default |
| ---------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `image.repository` | PSMDB Operator Container image name | `percona/percona-server-mongodb-operator` |
| `image.tag` | PSMDB Operator Container image tag | `1.18.0` |
| `image.pullPolicy` | PSMDB Operator Container pull policy | `Always` |
| `image.pullSecrets` | PSMDB Operator Pod pull secret | `[]` |
| `replicaCount` | PSMDB Operator Pod quantity | `1` |
| `tolerations` | List of node taints to tolerate | `[]` |
| `annotations` | PSMDB Operator Deployment annotations | `{}` |
| `podAnnotations` | PSMDB Operator Pod annotations | `{}` |
| `labels` | PSMDB Operator Deployment labels | `{}` |
| `podLabels` | PSMDB Operator Pod labels | `{}` |
| `resources` | Resource requests and limits | `{}` |
| `nodeSelector` | Labels for Pod assignment | `{}` |
| `podAnnotations` | Annotations for pod | `{}` |
| `podSecurityContext` | Pod Security Context | `{}` |
| `watchNamespace` | Set when a different from default namespace is needed to watch (comma separated if multiple needed) | `""` |
| `createNamespace` | Set if you want to create watched namespaces with helm | `false` |
| `rbac.create` | If false RBAC will not be created. RBAC resources will need to be created manually | `true` |
| `securityContext` | Container Security Context | `{}` |
| `serviceAccount.create` | If false the ServiceAccounts will not be created. The ServiceAccounts must be created manually | `true` |
| `serviceAccount.annotations` | PSMDB Operator ServiceAccount annotations | `{}` |
| `logStructured` | Force PSMDB operator to print JSON-wrapped log messages | `false` |
| `logLevel` | PSMDB Operator logging level | `INFO` |
| `disableTelemetry` | Disable sending PSMDB Operator telemetry data to Percona | `false` |

#These parameters are for psmdb-db:

| Parameter | Description | Default |
| ------------------------------- | ------------------------------------------------------------------------------|---------------------------------------|
Expand Down Expand Up @@ -249,6 +277,26 @@ The chart can be customized using the following configurable parameters:
| `backup.tasks` | Backup working schedule | `{}` |
| `users` | PSMDB essential users | `{}` |

#These parameters are for backup:

| Parameter | Description |
| --------------- | -------------------------------------------------- |
| `annotations` | Annotations for the resource |
| `name` | Name of the backup resource |
| `labels` | Labels for the resource |
| `clusterName` | Name of the MongoDB cluster to backup |
| `storageName` | Name of the storage configuration for the backup |
| `type` | Type of the backup operation |

#These parameters are for restore:

| Parameter | Description |
| --------------- | -------------------------------------------------- |
| `annotations` | Annotations for the resource |
| `name` | Name of the restore resource |
| `labels` | Labels for the resource |
| `clusterName` | Name of the MongoDB cluster to restore |
| `backupName` | Name of the backup to restore from |

Specify parameters using `--set key=value[,key=value]` argument to `helm install`
Notice that you can use multiple replica sets only with sharding enabled.
Expand Down
12 changes: 6 additions & 6 deletions charts/psmdb-operator-db/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,21 +785,21 @@ backup:
enabled: true
annotations:
description: "test"
name: backup
name: backup #specify the backup name. You will use this name to restore from this backup
labels:
app: mongo-backup
environment: testing
clusterName: mdb-db-psmdb-db
storageName: azure-blob
clusterName: mdb-db-psmdb-db #specify the name of your cluster. This is the name you specified when deploying Percona Server for MongoDB.
storageName: azure-blob #specify the name of your already configured storage.
type: logical

restore:
enabled: true
annotations:
description: "test"
name: restore1
name: restore1 #name of the restore
labels:
app: mongo-restore
environment: testing
clusterName: mdb-db-psmdb-db
backupName: backup
clusterName: mdb-db-psmdb-db #name of the target cluster to restore the backup on
backupName: backup #name of the backup
Loading