- Reference >
- MongoDB Enterprise Kubernetes Operator Installation Settings >
- MongoDB Enterprise Kubernetes Operator Helm Installation Settings
MongoDB Enterprise Kubernetes Operator Helm Installation Settings¶
On this page
- appDb.name
- appDb.version
- database.name
- database.version
- initAppDb.name
- initAppDb.version
- initDatabase.name
- initDatabase.version
- initOpsManager.name
- initOpsManager.version
- managedSecurityContext
- multiCluster.clusterClientTimeout
- namespace
- needsCAInfrastructure
- operator.deployment_name
- operator.env
- operator.name
- operator.version
- operator.watchNamespace
- operator.watchedResources
- opsManager.name
- registry.appDb
- registry.imagePullSecrets
- registry.initAppDb
- registry.initOpsManager
- registry.operator
- registry.opsManager
- subresourceEnabled
To provide optional settings, pass them to Helm using the --set
argument.
Use the following files that list value settings for your deployment type:
- Vanilla Kubernetes: values.yaml
- OpenShift: values-openshift.yaml
To learn about optional Kubernetes Operator installation settings, see Operator Helm Installation Settings.
Run the command as in the following example and the options that you specified will be passed to your configuration:
appDb.name¶
Name of the Application Database image.
The default value is mongodb-enterprise-appdb.
Example
appDb.version¶
Version of the image that contains the MongoDB Agent that the Application Database uses.
The default value is 10.2.15.5958-1_4.2.11-ent.
Example
database.name¶
Name of the MongoDB Enterprise Database image.
The default value is mongodb-enterprise-database.
Example
database.version¶
Version of the MongoDB Enterprise Database image that the Kubernetes Operator deploys.
Example
initAppDb.name¶
Name of the initContainer
image that contains the Application
Database start-up scripts and the readiness probe.
The default value is mongodb-enterprise-init-appdb.
Example
initAppDb.version¶
Version of the initContainer
image that contains the Application
Database start-up scripts and the readiness probe.
The default value is 1.0.6.
Example
initDatabase.name¶
Name of the initContainer
image that contains the MongoDB Agent
start-up scripts and the readiness probe.
The default value is mongodb-enterprise-init-database.
Example
initDatabase.version¶
Version of the initContainer
image that contains the MongoDB Agent
start-up scripts and the readiness probe.
The default value is 1.0.2.
Example
initOpsManager.name¶
Version of the initContainer
image that contains the Ops Manager
start-up scripts and the readiness probe.
The default value is mongodb-enterprise-init-ops-manager.
Example
initOpsManager.version¶
Version of the initContainer
image that contains the Ops Manager
start-up scripts and the readiness probe.
The default value is 1.0.3.
Example
managedSecurityContext¶
Flag that determines whether or not the Kubernetes Operator inherits the securityContext settings that your Kubernetes cluster manages.
This value must be true if you want to run the Kubernetes Operator in OpenShift or in a restrictive environment.
- Kubernetes
- OpenShift
The default value is false.
Example
The default value is true.
Example
multiCluster.clusterClientTimeout¶
Time, in seconds, the Kubernetes Operator attempts to connect to a cluster’s Kubernetes API server endpoint. This timeout is set for all Kubernetes clusters in multi-Kubernetes-cluster deployments. If the Kubernetes Operator doesn’t get a response from the Kubernetes API server within the specified time, it logs the cluster’s status as “unhealthy”. To learn more, see Troubleshooting Kubernetes Clusters.
The default value is 10.
Example
namespace¶
namespaces in which you want to deploy the Kubernetes Operator.
To use a namespace other than the default, specify the namespace in which you want to deploy the Kubernetes Operator.
The default value is mongodb.
Example
needsCAInfrastructure¶
Flag that determines whether Kubernetes creates a ClusterRole that allows the Kubernetes Operator to sign TLS certificates using the certificates.k8s.io API.
Example
The default value is true.
operator.deployment_name¶
Name of the Kubernetes Operator container.
The default value is mongodb-enterprise-operator.
Example
operator.env¶
Label for the Kubernetes Operators deployment environment. This value affects the default timeouts and the logging level and format:
If the value is | Log Level is set to | Log Format is set to |
---|---|---|
dev |
debug | text |
prod |
info | json |
The default value is prod.
Example
operator.name¶
Name that Kubernetes assigns to Kubernetes Operator objects, such as Deployments, ServiceAccounts, Roles, and Pods.
This value also corresponds to the name of the container registry where the Kubernetes Operator is located.
The default value is mongodb-enterprise-operator.
Example
operator.version¶
Version of the Kubernetes Operator that you want to deploy.
The default value is master.
Example
operator.watchNamespace¶
Namespaces that the Kubernetes Operator watches for MongoDB Kubernetes resource changes. If this namespace differs from the default, ensure that the Kubernetes Operator ServiceAccount can access this namespace.
- To watch all namespaces, specify * and assign the ClusterRole to the
mongodb-enterprise-operator
ServiceAccount that you use to run the Kubernetes Operator. - To watch a subset of all namespaces, specify them in a
comma-separated list, escape each comma with a backslash,
and surround the list in quotes, such as
"operator.watchNamespace=ns1\,ns2"
.
Watching a subset of namespaces is useful in deployments with multiple Kubernetes Operator instances, where each Kubernetes Operator instance watches a different subset of namespaces in your cluster.
Important
To deploy Ops Manager and MongoDB Kubernetes resources to one or more namespaces other than the one where you deploy the Kubernetes Operator, see Set Scope for MongoDB Enterprise Kubernetes Operator Deployment for values you must use and additional steps you might have to perform.
The default value is <metadata.namespace>.
Example
Example
Example
Example
operator.watchedResources¶
Custom resources that the Kubernetes Operator watches.
The Kubernetes Operator installs the CustomResourceDefinitions for and watches only the resources you specify.
The Kubernetes Operator accepts the following values:
Value | Description |
---|---|
mongodb |
Install the CustomResourceDefinitions for database resources and watch those resources. |
mongodbusers |
Install the CustomResourceDefinitions for MongoDB user resources and watch those resources. |
opsmanagers |
Install the CustomResourceDefinitions for Ops Manager resources and watch those resources. |
Example
opsManager.name¶
Name of the Ops Manager image.
The default value is mongodb-enterprise-ops-manager.
Example
registry.appDb¶
URL of the repository from which the Kubernetes Operator downloads the Application Database image.
- Kubernetes
- OpenShift
The default value is quay.io/mongodb.
Example
The default value is registry.connect.redhat.com/mongodb.
Example
registry.imagePullSecrets¶
secret that contains the credentials required to pull images from the repository.
Important
OpenShift requires this setting. Define it in the
imagePullSecrets
setting in this file or pass it when you install
the Kubernetes Operator using Helm.
If you use the Kubernetes Operator to deploy MongoDB resources to
multiple namespaces or with a
cluster-wide scope, create the secret
only in the namespace where you installed the Kubernetes Operator.
The Kubernetes Operator synchronizes the secret across all watched
namespaces.
Example
registry.initAppDb¶
URL of the repository from which the initContainer
image that
contains the Application Database start-up scripts and the readiness
probe is downloaded.
- Kubernetes
- OpenShift
The default value is quay.io/mongodb.
Example
The default value is registry.connect.redhat.com/mongodb.
Example
registry.initOpsManager¶
URL of the repository from which the initContainer
image that
contains the Ops Manager start-up scripts and the readiness probe is
downloaded.
- Kubernetes
- OpenShift
The default value is quay.io/mongodb.
Example
The default value is registry.connect.redhat.com/mongodb.
Example
registry.operator¶
Repository from which the Kubernetes Operator image is pulled. Specify this value if you want to pull the Kubernetes Operator image from a private repository.
- Kubernetes
- OpenShift
The default value is quay.io/mongodb.
Example
The default value is registry.connect.redhat.com/mongodb.
Example
registry.opsManager¶
URL of the repository from which the image for an Ops Manager resource is downloaded.
- Kubernetes
- OpenShift
The default value is quay.io/mongodb.
Example
The default value is registry.connect.redhat.com/mongodb.
Example
subresourceEnabled¶
Flag that indicates whether subresources can be defined in the Kubernetes Operator CustomResourceDefinition.
The default value is true.
Example