快速入门

注册 Atlas 帐户或登录。

注册新的 Atlas 帐户或登录您的 Atlas 帐户。

为您的组织创建 API 密钥。

授予Atlas编程访问权限并配置 API Access List。

您需要以下公共 API 密钥、私有 API 密钥和组织 ID 信息， 配置 Atlas Kubernetes Operator 对 Atlas 的访问权限。

• 如果您希望Atlas Kubernetes Operator创建新的Atlas项目，请授予对Atlas 的编程访问权限。如果您的组织需要Atlas Administration API的IP访问列表，您还必须配置API访问权限列表。

  重要

  您必须为 API 密钥分配 Organization Project Creator 或更高级别的组织角色。

• 如果要使用现有Atlas项目，请从项目添加项目访问权限。如果您的组织需要Atlas Administration API的IP访问列表，您还必须配置API访问权限列表。

  重要

  您必须为 API 密钥分配 Project Owner 项目角色。

部署 Atlas Kubernetes Operator。

在以下场景之一，请将<version>替换为最新版本号：

• 如果您希望 Atlas Kubernetes Operator 监视 Kubernetes 集群中的所有命名空间，请运行以下命令：

  kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/refs/heads/main/releases/v<version>/deploy/all-in-one.yaml

• 如果您希望 Atlas Kubernetes Operator 仅监视其命名空间，则必须从 deploy/namespaced 目录安装配置文件：

  kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/v<version>/deploy/namespaced/crds.yaml

  kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/v<version>/deploy/namespaced/namespaced-config.yaml

使用您的 API 密钥和组织 ID 创建密钥。

要创建并标记密钥，请使用您的API密钥和组织ID运行以下命令：

kubectl create secret generic mongodb-atlas-operator-api-key \
    --from-literal="orgId=<atlas_organization_id>" \
    --from-literal="publicApiKey=<atlas_api_public_key>" \
    --from-literal="privateApiKey=<atlas_api_private_key>" \
    -n mongodb-atlas-system

kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system

如果使用外部密钥存储，则无需将敏感信息直接放入Kubernetes 密钥中。要学习；了解更多信息，请参阅配置密钥存储。

创建AtlasProject 自定义资源。

运行以下命令以创建AtlasProject自定义资源：

部署Atlas Kubernetes Operator自定义资源。

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  projectIpAccessList:
    - ipAddress: <your-ip-address-range>
      comment: "Adding your IP to Atlas access list"
EOF

创建AtlasDeployment 自定义资源。

运行以下命令之一以创建AtlasDeployment自定义资源并创建集群：

付费层级：

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: "Test-cluster"
    tags:
      - key: "environment"
        value: "production"
    replicationSpecs:
      - zoneName: US-Zone
        regionConfigs:
          - electableSpecs:
              instanceSize: M10
              nodeCount: 3
            providerName: AWS
            regionName: US_EAST_1
            priority: 7
EOF

免费套餐：

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: "Test-cluster"
    replicationSpecs:
      - regionConfigs:
          - regionName: US_EAST_1
            providerName: TENANT
            backingProviderName: AWS
            electableSpecs:
              instanceSize: M0
              nodeCount: 3
EOF

要创建无服务器实例，请参阅无服务器实例示例。

创建带有密码的密钥，用于登录 Atlas 集群数据库。

将P@@ssword%替换为您的密码，然后运行以下命令：

kubectl create secret generic the-user-password --from-literal="password=P@@sword%"

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

如果使用外部密钥存储，则无需将敏感信息直接放入Kubernetes 密钥中。要学习；了解更多信息，请参阅配置密钥存储。

创建AtlasDatabaseUser 自定义资源。

运行以下命令以创建AtlasDatabaseUser自定义资源：

cat <<EOF | kubectl apply -f -
apiVersion: atlas.mongodb.com/v1
kind: AtlasDatabaseUser
metadata:
  name: my-database-user
spec:
  roles:
    - roleName: "readWriteAnyDatabase"
      databaseName: "admin"
  projectRef:
    name: my-project
  username: theuser
  passwordSecretRef:
    name: the-user-password
EOF

检查数据库用户的状态。

运行以下命令，直到收到True响应，这表明数据库用户已准备就绪：

kubectl get atlasdatabaseusers my-database-user -o=jsonpath='{.status.conditions[?(@.type=="Ready")].status}'

检索 Atlas Kubernetes Operator 创建的用于连接到集群的密钥。

1. 复制以下命令：

   重要

   以下命令需要 jq 1.6 或更高版本。

   kubectl get secret {my-project}-{my-atlas-cluster}-{my-database-user} -o json | jq -r '.data | with_entries(.value |= @base64d)';

2. 对于自定义资源，用详细信息替换以下占位符：

   my-project	指定AtlasProject自定义资源的metadata字段的值。
   my-atlas-cluster	指定AtlasDeployment自定义资源的metadata字段的值。
   my-database-user	指定AtlasDatabaseUser自定义资源的metadata字段的值。

3. 运行命令。

   注意

   您的连接字符串将与以下示例不同。

   {
      "connectionStringStandard": "mongodb://theuser:P%40%40sword%25@test-cluster-shard-00-00.peqtm.mongodb.net:27017,test-cluster-shard-00-01.peqtm.mongodb.net:27017,test-cluster-shard-00-02.peqtm.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-pk82fl-shard-0",
      "connectionStringStandardSrv": "mongodb+srv://theuser:P%40%40sword%25@test-cluster.peqtm.mongodb.net",
      "password": "P@@sword%",
      "username": "theuser"
    }

   您可以在应用程序中使用此密钥：

   containers:
    - name: test-app
      env:
       - name: "CONNECTION_STRING"
         valueFrom:
           secretKeyRef:
             name: test-atlas-operator-project-test-cluster-theuser
             key: connectionStringStandardSrv