Navigation

Upgrade from Operator Version 0.10 or Later

On this page

Upgrading to version 1.3.0 and newer

Starting in MongoDB Enterprise Kubernetes Operator version 1.3.0, you can only have one MongoDB resource per project. To learn how to migrate your project to a single-cluster configuration, see Migrate to One Resource per Project (Required for Version 1.3.0).

Procedure

The following steps depend on how your environment is configured:

1

Change to the directory in which you cloned the repository.

2

Upgrade the CustomResourceDefinitions for MongoDB deployments using the following kubectl command:

kubectl apply -f crds.yaml
3

You can edit the Operator YAML file to further customize your Operator before upgrading it.

  1. Open your mongodb-enterprise.yaml in your preferred text editor.

  2. You may need to add one or more of the following options:

    Environment Variable When to Use
    OPERATOR_ENV

    Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

    If OPERATOR_ENV is Log Level is set to Log Format is set to
    dev debug text
    prod info json

    Accepted values are: dev, prod.

    Default value is: prod.

    You can set the following pair of values:

    spec.template.spec.containers.name.env.name: OPERATOR_ENV
    spec.template.spec.containers.name.env.value: prod
    

    Example

    spec:
      template:
        spec:
          serviceAccountName: mongodb-enterprise-operator
          containers:
          - name: mongodb-enterprise-operator
            image: <operatorVersionUrl>
            imagePullPolicy: <policyChoice>
            env:
            - name: OPERATOR_ENV
              value: prod
    
    WATCH_NAMESPACE

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

    * means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

    Default value is: <metadata.namespace>.

    Important

    To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

    You can set the following pair of values:

    spec.template.spec.containers.name.env.name: WATCH_NAMESPACE
    spec.template.spec.containers.name.env.value: "<testNamespace>"
    

    Example

    spec:
      template:
        spec:
          serviceAccountName: mongodb-enterprise-operator
          containers:
          - name: mongodb-enterprise-operator
            image: <operatorVersionUrl>
            imagePullPolicy: <policyChoice>
            env:
            - name: WATCH_NAMESPACE
              value: "<testNamespace>"
    
    OPS_MANAGER_IMAGE_REPOSITORY

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

    Default value is: quay.io/mongodb/mongodb-enterprise-ops-manager

    spec.template.spec.containers.name.env.name:
    OPS_MANAGER_IMAGE_REPOSITORY
    spec.template.spec.containers.name.env.value:
    quay.io/mongodb/mongodb-enterprise-ops-manager
    

    Example

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    spec:
      template:
        spec:
          serviceAccountName: mongodb-enterprise-operator
          containers:
          - name: mongodb-enterprise-operator
            image: <operatorVersionUrl>
            imagePullPolicy: <policyChoice>
            env:
            - name: OPS_MANAGER_IMAGE_REPOSITORY
              value: quay.io/mongodb/mongodb-enterprise-ops-manager
            - name: OPS_MANAGER_IMAGE_PULL_POLICY
              value: Always
    
    OPS_MANAGER_IMAGE_PULL_POLICY

    Pull policy for the image deployed to an Ops Manager resource.

    Accepted values are: Always, IfNotPresent, Never

    Default value is: Always

    spec.template.spec.containers.name.env.name:
    OPS_MANAGER_IMAGE_PULL_POLICY
    spec.template.spec.containers.name.env.value:
    <policy>
    

    Example

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    spec:
      template:
        spec:
          serviceAccountName: mongodb-enterprise-operator
          containers:
          - name: mongodb-enterprise-operator
            image: <operatorVersionUrl>
            imagePullPolicy: <policyChoice>
            env:
            - name: OPS_MANAGER_IMAGE_REPOSITORY
              value: quay.io/mongodb/mongodb-enterprise-ops-manager
            - name: OPS_MANAGER_IMAGE_PULL_POLICY
              value: Always
    
4

Upgrade the Kubernetes Operator using the following kubectl command:

kubectl apply -f mongodb-enterprise.yaml
1

Upgrade the Kubernetes Operator using the following helm command:

helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values.yaml file:

Setting When to Use
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set namespace=<testNamespace> \
helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml

To upgrade the Kubernetes Operator on a host not connected to the Internet, you have two options, you can download the Kubernetes Operator files from either:

1

Upgrade the latest version of the Kubernetes Operator with modified pull policy values using the following helm command:

helm template --set registry.pullPolicy=IfNotPresent \
helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values.yaml file:

Setting When to Use
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set registry.pullPolicy=IfNotPresent \
--set namespace=<testNamespace> \
helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml
1

Upgrade the latest version of the Kubernetes Operator with modified pull policy values using the following helm command:

helm template --set registry.pullPolicy=IfNotPresent \
helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values.yaml file:

Setting When to Use
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set registry.pullPolicy=IfNotPresent \
--set namespace=<testNamespace> \
helm_chart > operator.yaml \
-- values helm_chart/values.yaml
kubectl apply -f operator.yaml
1

Change to the directory in which you cloned the repository.

2

Upgrade the CustomResourceDefinitions for MongoDB deployments using the following oc command:

oc apply -f crds.yaml
3

You can edit the Operator YAML file to further customize your Operator before upgrading it.

  1. Open your mongodb-enterprise-openshift.yaml in your preferred text editor.

  2. You must add your <openshift-pull-secret> to the ServiceAccount definitions:

    ---
    # Source: mongodb-enterprise-operator/templates/serviceaccount.yaml
    ---
    apiVersion: v1
    kind: ServiceAccount
    metadata:
      name: enterprise-operator
    
      namespace: mongodb
    
    imagePullSecrets:
     - name: <openshift-pull-secret>
    
    ---
    apiVersion: v1
    kind: ServiceAccount
    metadata:
      name: mongodb-enterprise-appdb
    
      namespace: mongodb
    
    imagePullSecrets:
     - name: <openshift-pull-secret>
    
    ---
    apiVersion: v1
    kind: ServiceAccount
    metadata:
      name: mongodb-enterprise-database-pods
    
      namespace: mongodb
    
    imagePullSecrets:
     - name: <openshift-pull-secret>
    
  3. You may need to add one or more of the following options:

Environment Variable When to Use
OPERATOR_ENV

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If OPERATOR_ENV is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

You can set the following pair of values:

spec.template.spec.containers.name.env.name: OPERATOR_ENV
spec.template.spec.containers.name.env.value: prod

Example

spec:
  template:
    spec:
      serviceAccountName: mongodb-enterprise-operator
      containers:
      - name: mongodb-enterprise-operator
        image: <operatorVersionUrl>
        imagePullPolicy: <policyChoice>
        env:
        - name: OPERATOR_ENV
          value: prod
WATCH_NAMESPACE

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

You can set the following pair of values:

spec.template.spec.containers.name.env.name: WATCH_NAMESPACE
spec.template.spec.containers.name.env.value: "<testNamespace>"

Example

spec:
  template:
    spec:
      serviceAccountName: enterprise-operator
      containers:
      - name: enterprise-operator
        image: <operatorVersionUrl>
        imagePullPolicy: <policyChoice>
        env:
        - name: WATCH_NAMESPACE
          value: "<testNamespace>"
OPS_MANAGER_IMAGE_REPOSITORY

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

Default value is: registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager

spec.template.spec.containers.name.env.name:
OPS_MANAGER_IMAGE_REPOSITORY
spec.template.spec.containers.name.env.value:
registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
spec:
  template:
    spec:
      serviceAccountName: enterprise-operator
      containers:
      - name: enterprise-operator
        image: <operatorVersionUrl>
        imagePullPolicy: <policyChoice>
        env:
        - name: OPS_MANAGER_IMAGE_REPOSITORY
          value: registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager
        - name: OPS_MANAGER_IMAGE_PULL_POLICY
          value: Always
OPS_MANAGER_IMAGE_PULL_POLICY

Pull policy for the image deployed to an Ops Manager resource.

Accepted values are: Always, IfNotPresent, Never

Default value is: Always

spec.template.spec.containers.name.env.name:
OPS_MANAGER_IMAGE_PULL_POLICY
spec.template.spec.containers.name.env.value:
<policy>

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
spec:
  template:
    spec:
      serviceAccountName: enterprise-operator
      containers:
      - name: enterprise-operator
        image: <operatorVersionUrl>
        imagePullPolicy: <policyChoice>
        env:
        - name: OPS_MANAGER_IMAGE_REPOSITORY
          value: registry.connect.redhat.com/mongodb/mongodb-enterprise-ops-manager
        - name: OPS_MANAGER_IMAGE_PULL_POLICY
          value: Always
4

Upgrade the Kubernetes Operator using the following oc command:

oc apply -f mongodb-enterprise-openshift.yaml
1

Upgrade the Kubernetes Operator using the following helm command:

helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values-openshift.yaml file:

Setting When to Use
registry.imagePullSecrets

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

Important

This setting is mandatory for OpenShift installs. You must either define it in this file or pass it when you install the Kubernetes Operator using Helm.

Example

registry:
  imagePullSecrets: <openshift-pull-secret>
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set registry.imagePullSecrets=<openshift-pull-secret> \
helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml

To upgrade the Kubernetes Operator on a host not connected to the Internet, you have two options, you can download the Kubernetes Operator files from either:

1

Upgrade the latest version of the Kubernetes Operator with modified pull policy values using the following helm command:

helm template --set registry.pullPolicy=IfNotPresent \
--set registry.imagePullSecrets=<openshift-pull-secret> \
helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values-openshift.yaml file:

Setting When to Use
registry.imagePullSecrets

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

Important

This setting is mandatory for OpenShift installs. You must either define it in this file or pass it when you install the Kubernetes Operator using Helm.

Example

registry:
  imagePullSecrets: <openshift-pull-secret>
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set registry.pullPolicy=IfNotPresent \
--set registry.imagePullSecrets=<openshift-pull-secret> \
--set namespace=<testNamespace> \
helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml
1

Upgrade the latest version of the Kubernetes Operator with modified pull policy values using the following helm command:

helm template --set registry.pullPolicy=IfNotPresent \
--set registry.imagePullSecrets=<openshift-pull-secret> \
helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml

You can customize your Helm Chart before installing it. To modify it, add one or more of the following options to the values-openshift.yaml file:

Setting When to Use
registry.imagePullSecrets

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

Important

This setting is mandatory for OpenShift installs. You must either define it in this file or pass it when you install the Kubernetes Operator using Helm.

Example

registry:
  imagePullSecrets: <openshift-pull-secret>
namespace

To use a different namespace, you need to specify that namespace.

Default value is: mongodb.

Example

# Name of the Namespace to use
namespace: mongodb
operator.env

Label for the Operator’s deployment environment. The env value affects default timeouts and the format and level of logging.

If operator.env is Log Level is set to Log Format is set to
dev debug text
prod info json

Accepted values are: dev, prod.

Default value is: prod.

Example

operator:
 # Execution environment for the operator, dev or prod. Use dev for more verbose logging
 env: prod
operator.watchNamespace

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

* means all namespaces and requires the ClusterRole assigned to the mongodb-enterprise-operator ServiceAccount which is the ServiceAccount used to run the Kubernetes Operator.

Default value is: <metadata.namespace>.

Important

To watch Ops Manager and MongoDB Kubernetes resources in a different namespace to which you deploy the Kubernetes Operator, see Kubernetes Operator Deployment Scopes for values you must use and additional steps you might have to perform.

Example

operator:
  watchNamespace: *

Note

You can also pass these values as options when you apply the Helm Chart:

helm template --set registry.pullPolicy=IfNotPresent \
--set registry.imagePullSecrets=<openshift-pull-secret> \
--set namespace=<testNamespace> \
helm_chart > operator.yaml \
-- values helm_chart/values-openshift.yaml
oc apply -f operator.yaml

To troubleshoot your Kubernetes Operator, see Review Logs from the Kubernetes Operator.

Important

If you need to remove the Kubernetes Operator or the namespace, you first must remove MongoDB resources.