Navigation

MongoDB Enterprise Kubernetes Operator Helm Installation Settings

To provide optional settings, edit the Helm values YAML file that corresponds to your deployment type in the directory where you cloned the Kubernetes Operator repository:

  • Vanilla Kubernetes: helm_chart/values.yaml
  • OpenShift: helm_chart/values-openshift.yaml

If the setting that you want to add doesn’t exist in the values YAML file, add its key and value:

Example

registry:
  appDb: quay.io/mongodb

Tip

Alternatively, you can pass these values as options when you apply the Helm Chart:

helm upgrade <chart-name> helm_chart \
     --values helm_chart/values.yaml \
     --set namespace=<testNamespace>
helm upgrade <chart-name> helm_chart \
     --values helm_chart/values-openshift.yaml \
     --set namespace=<testNamespace>

appDb.name

Name of the Application Database image.

The default value is mongodb-enterprise-appdb.

Example

appDb:
  name: mongodb-enterprise-appdb
  version: 10.2.15.5958-1_4.2.11-ent

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

appDb:
  name: mongodb-enterprise-appdb
  version: 10.2.15.5958-1_4.2.11-ent

database.name

Name of the MongoDB Enterprise Database image.

The default value is mongodb-enterprise-database.

Example

database:
  name: mongodb-enterprise-database
  version: 2.0.0

database.version

Version of the MongoDB Enterprise Database image that the Kubernetes Operator deploys.

Example

database:
  name: mongodb-enterprise-database
  version: 2.0.0

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

database:
  name: mongodb-enterprise-init-appdb
  version: 1.0.6

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

database:
  name: mongodb-enterprise-init-appdb
  version: 1.0.6

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

database:
  name: mongodb-enterprise-init-database
  version: 1.0.2

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

database:
  name: mongodb-enterprise-init-database
  version: 1.0.2

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

database:
  name: mongodb-enterprise-init-ops-manager
  version: 1.0.3

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

database:
  name: mongodb-enterprise-init-ops-manager
  version: 1.0.3

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.

The default value is false.

Example

# Set this to true if your cluster is managing SecurityContext for you.
# If running OpenShift (Cloud, Minishift, etc.), set this to true.
managedSecurityContext: false

The default value is true.

Example

# Set this to true if your cluster is managing SecurityContext for you.
# If running OpenShift (Cloud, Minishift, etc.), set this to true.
managedSecurityContext: true

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

# Name of the Namespace to use
namespace: mongodb

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

needsCAInfrastructure: true

The default value is true.

operator.deployment_name

Name of the Kubernetes Operator container.

The default value is mongodb-enterprise-operator.

Example

operator:
  deployment_name: mongodb-enterprise-operator

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:
  # Execution environment for the operator, dev or prod.
  # Use dev for more verbose logging
  env: prod

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:
  name: mongodb-enterprise-operator

operator.version

Version of the Kubernetes Operator that you want to deploy.

The default value is master.

Example

operator:
  version: master

operator.watchNamespace

Namespace that the Kubernetes Operator watches for MongoDB Kubernetes resource changes. If this namespace differs from the default, ensure that the Operator’s ServiceAccount can access this namespace.

Use * to specify all namespaces. To watch all namespaces, you must also assign the ClusterRole to the mongodb-enterprise-operator ServiceAccount, which is the ServiceAccount used to run the Kubernetes Operator.

Important

To deploy Ops Manager and MongoDB Kubernetes resources in a namespace 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

operator:
  watchNamespace: *

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

operator:
  watchedResources:
    - mongodbusers
    - mongodb
    - opsmanagers

opsManager.name

Name of the Ops Manager image.

The default value is mongodb-enterprise-ops-manager.

Example

opsManager:
  name: mongodb-enterprise-ops-manager

registry.appDb

URL of the repository from which the Kubernetes Operator downloads the Application Database image.

The default value is quay.io/mongodb.

Example

registry:
  appDb: quay.io/mongodb

The default value is registry.connect.redhat.com/mongodb.

Example

registry:
  appDb: registry.connect.redhat.com/mongodb

registry.imagePullSecrets

secret that contains the credentials required to pull images from the repository.

Important

OpenShift requires this setting. Define it in this file or pass it when you install the Kubernetes Operator using Helm.

Example

registry:
# The pull secret must be specified
  imagePullSecrets: <openshift-pull-secret>

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.

The default value is quay.io/mongodb.

Example

registry:
  initAppDb: quay.io/mongodb

The default value is registry.connect.redhat.com/mongodb.

Example

registry:
  initAppDb: registry.connect.redhat.com/mongodb

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.

The default value is quay.io/mongodb.

Example

registry:
  initOpsManager: quay.io/mongodb

The default value is registry.connect.redhat.com/mongodb.

Example

registry:
  initOpsManager: registry.connect.redhat.com/mongodb

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.

The default value is quay.io/mongodb.

Example

registry:
  operator: quay.io/mongodb

The default value is registry.connect.redhat.com/mongodb.

Example

registry:
  operator: registry.connect.redhat.com/mongodb

registry.opsManager

URL of the repository from which the image for an Ops Manager resource is downloaded.

The default value is quay.io/mongodb.

Example

registry:
  opsManager: quay.io/mongodb

The default value is registry.connect.redhat.com/mongodb.

Example

registry:
  opsManager: registry.connect.redhat.com/mongodb

subresourceEnabled

Flag that indicates whether subresources can be defined in the Kubernetes Operator CustomResourceDefinition.

Set this setting to false if installing the Kubernetes Operator CustomResourceDefinition fails on an OpenShift 3.11 cluster.

The default value is true.

Example

subresourceEnabled: true