Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Configure Kubernetes for Deploying MongoDB Resource

On this page

You can use the Kubernetes Operator to deploy MongoDB resources such as a replica set, a sharded cluster, or a standalone instance using an object. Ops Manager can generate the YAML files you need to configure your Kubernetes environment for deploying a MongoDB Database resource.

To generate the YAML files:

Verify Permissions

You must have one of the following roles to access the Ops Manager UI for setting up Kubernetes:

Navigate to the Kubernetes Setup Page in the Ops Manager UI

To access the Kubernetes Setup page in the Ops Manager UI:

1

Log in to Ops Manager and select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.

2

Select your desired project from the Project menu in the navigation bar.

3

Click the Add New dropdown and select Prepare Kubernetes Configuration to display the Kubernetes Setup page.

If you are a Global Owner or Organization Owner, you can access the Kubernetes Setup page in the Ops Manager UI by doing the following also:

1

Log in to Ops Manager and select your desired organization from the office icon Organizations menu in the navigation bar.

2

Click Kubernetes Setup in the sidebar, or click Kubernetes Setup in the navigation bar.

Set Up Kubernetes for a MongoDB Resource

The MongoDB Enterprise Kubernetes Operator requires a Kubernetes ConfigMap to create or link your Ops Manager project.

Using the Kubernetes ConfigMap, you can either connect to a HTTPS-enabled Ops Manager that is using a custom CA or link to a Ops Manager project that isn’t using a custom CA.

You can use the Ops Manager Kubernetes Setup page to automatically generate the ConfigMap. The generated YAML file for the ConfigMap looks similar to the following:

copy 
apiVersion: v1
kind: ConfigMap
metadata:
  name: my-project
  namespace: mongodb
data:
  baseUrl: https://cloud.mongodb.com

  # Optional Parameters
  # projectName: <your-project-name>

  orgId: <your-org-id>

  sslMMSCAConfigMap: <root-ca-configmap-name>
  sslRequireValidMMSServerCertificates: ‘true’
copy 
apiVersion: v1
kind: ConfigMap
metadata:
  name: my-project
  namespace: mongodb
data:
  baseUrl: https://cloud.mongodb.com

  # Optional Parameters
  # projectName: <your-project-name>

  orgId: <your-org-id>

You need to store your Programmatic API Key as a Kubernetes secret to create or update Kubernetes objects in your Ops Manager project. A Kubernetes secret stores authentication credentials so only Kubernetes can access them.

copy 
apiVersion: v1
kind: Secret
metadata:
  name: organization-secret
  namespace: mongodb
stringData:
  user: <private-key>
  publicApiKey: <public-api-key>

Setting up Template files and Configuration Parameters

To generate the YAML files, you must do the following:

1

Create a secret file with your API keys.

Create a YAML file that contains your Programmatic API Key in the /mongodb-ops-manager/ folder.

2
3

Configure the Ops Manager settings for Kubernetes.

In your server’s conf-mms.properties file, configure the following settings:

  • kubernetes.templates.credentialsFilePath
  • kubernetes.templates.projectFilePath

To learn more about these settings, see Kubernetes Setup.

Generating the YAML Files

To setup Kubernetes for a MongoDB resource:

1

In the Kubernetes Setup page, toggle the switch for Configure HTTPS-enabled Ops Manager Using a Custom CA from OFF to ON to generate a ConfigMap for HTTPS-enabled Ops Manager that is using a custom CA.

2

In the CA ConfigMap Name field, enter the name of your ConfigMap containing the root CA certificate in the same namespace as your database pods.

3

Optional: Select the Require Valid Server Certificate checkbox to force the MongoDB Enterprise Kubernetes Operator to require a valid TLS certificate from Ops Manager.

4

Specify the API keys for accessing your Ops Manager project.

  • Click Create New API Keys to generate new API keys.
  • Click Use Existing API Keys to specify your existing public and private keys.
5

Enter the IP addresses to add to your Ops Manager project’s IP access list to grant programmatic access from your Kubernetes environment.

If you disabled the mms.publicApi.whitelistEnabled setting in your Ops Manager configuration, the Access List Entry field is not visible in the UI.

6

Generate ConfigMap and Kubernetes secret YAML files.

To generate the ConfigMap and Kubernetes secret YAML files:

  • Click Generate Key and YAML if you are generating new API keys.
  • Click Generate YAML if you are using existing API keys.
7

Follow the steps in the Generated ConfigMap and Secret YAML file modal to apply the generated ConfigMap and Kubernetes secret YAML files to your Kubernetes environment.

1

Specify the API keys for accessing your Ops Manager project.

  • Click Create New API Keys to generate new API keys.
  • Click Use Existing API Keys to specify your existing public and private keys.
2

Enter the IP addresses to add to your Ops Manager project’s IP access list to grant programmatic access from your Kubernetes environment.

If you disabled the mms.publicApi.whitelistEnabled setting in your Ops Manager configuration, the Access List Entry field is not visible in the UI.

3

Generate ConfigMap and Kubernetes secret YAML files.

To generate the ConfigMap and Kubernetes secret YAML files:

  • Click Generate Key and YAML if you are generating new API keys.
  • Click Generate YAML if you are using existing API keys.
4

Follow the steps in the Generated ConfigMap and Secret YAML file modal to apply the generated ConfigMap and Kubernetes secret YAML files to your Kubernetes environment.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.