Create Credentials for the Kubernetes Operator

On this page

For the Kubernetes Operator to create or update objects in your Cloud Manager or Ops Manager Project, you need to store your Programmatic API Key as a Kubernetes secret. Creating a secret stores authentication credentials so only Kubernetes can access them.

Multiple secrets can exist in the same namespace. Each user should have their own secret.

You can follow the Procedure below to manually set up the secret. Alternatively, you can use the MongoDB Cloud Manager UI or the Ops Manager UI to automatically generate the Kubernetes secret YAML file, which you can then apply to your Kubernetes environment.


To create credentials for the Kubernetes Operator, you must:

  1. Have or create an Ops Manager Organization.


    Unlike earlier Kubernetes Operator versions, use the Operator to create your Ops Manager project. The Operator adds additional metadata to Projects that it creates to help manage the deployments.

  2. Have or generate a Programmatic API Key.

  3. Grant this new Programmatic API Key the Project Owner role.

  4. Add the IP or CIDR block of any hosts that serve the Kubernetes Operator to the API Whitelist.


To create your Kubernetes secret:

  1. Make sure you have the Public and Private Keys for your desired Ops Manager Programmatic API Key.

  2. Invoke the following Kubernetes command to create your secret:

    kubectl -n <metadata.namespace> \
      create secret generic <myCredentials> \
      --from-literal="publicKey=<publicKey>" \


    The -n flag limits the namespace to which this secret applies. All MongoDB Kubernetes resources must be in the same namespace with the secrets and ConfigMaps. The Kubernetes Operator does not use either the secrets or ConfigMaps.


    The deprecated version of this command specifies a user and publicApiKey instead of a publicKey and privateKey. Kubernetes Operator accepts either version for authentication.

  3. Invoke the following Kubernetes command to verify your secret:

    kubectl describe secrets/<myCredentials> -n <metadata.namespace>

    This command returns a secret description in the shell:

    Name:         <myCredentials>
    Namespace:    <metadata.namespace>
    Labels:       <none>
    Annotations:  <none>
    Type:  Opaque
    privateKey:  31 bytes
    publicKey:          22 bytes