Puedes usar el operador Atlas Kubernetes Operator para gestionar los recursos en Atlas sin salir de Kubernetes. Este tutorial demuestra cómo crear su primer clúster en Atlas a partir de archivos de configuración de Kubernetes con Atlas Kubernetes Operator.
Nota
¿Preferirías empezar con Helm?
Para crear tu primer clúster en Atlas desde Helm Charts con Atlas Kubernetes Operator, consulta Introducción rápida a los charts de Helm.
Requisitos previos
Este tutorial requiere:
Un clúster de Kubernetes en ejecución con nodos que ejecutan procesadores con la arquitectura x86-64, AMD64 o ARM64.
jq1.6 o superior
Puedes acceder al proyecto Atlas Kubernetes Operator en GitHub:
Para instalar el operador Atlas Kubernetes utilizando Atlas CLI, ejecuta el siguiente comando:
atlas kubernetes operator install [options]
Para obtener más información sobre la sintaxis del comando y los parámetros, consulta la documentación de Atlas CLI para atlas kubernetes operator install.
Procedimiento
Importante
Recursos personalizados ya no borran objetos por defecto
Atlas Kubernetes Operator uses custom resource archivos de configuración to manage your Atlas configuration, but as of Atlas Kubernetes Operator 2.0, custom resources you borrar in Kubernetes are no longer (por defecto) borrados in Atlas. En su lugar, Atlas Kubernetes Operator simplemente deja de gestionar esos recursos en Atlas. Por ejemplo, si eliminas un
AtlasProjectCustom recurso en Kubernetes, de forma predeterminada, el Atlas Kubernetes Operator ya no elimina automáticamente el Proyecto correspondiente de Atlas. Este cambio de comportamiento está diseñado para ayudar a prevenir eliminaciones accidentales o inesperadas. Para saber más, incluido cómo revertir este comportamiento al por defecto utilizado antes de Atlas Kubernetes Operator 2.0, consulta Nuevo valor por defecto: Protección de Eliminación en Atlas Kubernetes Operator 2.0.De manera similar, Atlas Kubernetes Operator no elimina equipos de Atlas si los elimina de un proyecto Atlas en Kubernetes con Atlas Kubernetes Operator.
Define explícitamente los detalles de configuración que deseas para evitar el uso implícito de los valores de configuración por defecto de Atlas. En algunos casos, heredar los valores por defecto de Atlas puede crear un ciclo de conciliación que impida que el recurso personalizado alcance un estado de
READY. Por ejemplo, definir explícitamente el comportamiento de escalado automático deseado en el recurso personalizadoAtlasDeployment, como se muestra en el ejemplo incluido, garantiza que un tamaño de instancia estático en el recurso personalizado no se aplique repetidamente a una implementación de Atlas que tiene el escalado automático habilitado.autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40
Regístrese para obtener una cuenta Atlas o inicie sesión.
Registrar una nueva cuenta de Atlas o Iniciar sesión en tu cuenta de Atlas.
Cree claves API para su organización.
Nota
Necesita la siguiente llave pública de API, llave privada de API y la información del Identificador de la Organización para configurar el acceso de Atlas Kubernetes Operator a Atlas.
Otorgar acceso programático a una organización y configurar la API Access List.
Necesita la siguiente llave pública de API, llave privada de API y la información del Identificador de la Organización para configurar el acceso de Atlas Kubernetes Operator a Atlas.
Si deseas que el Atlas Kubernetes Operator cree un nuevo Proyecto de Atlas, otorga acceso programático a una organización. Si tu organización requiere una lista de acceso IP para la API de administración de Atlas, también deberás configurar la lista de acceso a la API.
Importante
Debes asignar a la clave API el rol organizacional Organization Project Creator o superior.
Si deseas trabajar con un proyecto Atlas existente, Añadir acceso al proyecto desde un proyecto. Si tu organización requiere una lista de acceso IP para la API de Administración de Atlas, también debes configurar la lista de acceso a la API.
Importante
Debe asignar al clave API el rol de proyecto Project Owner.
Implementar el operador Atlas Kubernetes.
En uno de los siguientes escenarios, sustituya <version> con la versión más reciente:
Si desea que Atlas Kubernetes Operator supervise todos los espacios de nombres en el clúster de Kubernetes, ejecute el siguiente comando:
kubectl apply -f https://raw.githubusercontent.com/mongodb/mongodb-atlas-kubernetes/refs/heads/main/releases/v<version>/deploy/all-in-one.yaml Si desea que Atlas Kubernetes Operator solo observe su espacio de nombres, debe instalar los archivos de configuración desde el
deploy/namespaceddirectorio: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
Crea un secreto con tus claves API y el ID de tu organización.
Para crear y etiquetar un secreto, ejecute los siguientes comandos con sus claves API y el ID de la organización:
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
Si usa almacenamiento secreto externo, no necesita guardar información confidencial directamente en los secretos de Kubernetes. Para obtener más información, consulte Configurar almacenamiento secreto.
Cree el recurso personalizado AtlasProject.
Ejecuta el siguiente comando para crear el AtlasProject recurso personalizado:
Nota
El siguiente ejemplo no especifica spec.connectionSecretRef.name. Si no se especifica, el Atlas Kubernetes Operator utiliza la conexión por defecto secret previamente configurada con tus llaves API y el Identificador de la Organización.
Implementa el recurso personalizado del 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
Cree el recurso personalizado AtlasDeployment.
Ejecuta uno de los siguientes comandos para crear un AtlasDeployment Recurso personalizado y crear un clúster:
Nivel de pago:
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
nivel gratuito:
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
Para crear una instancia sin servidor, consulte el ejemplo de instancia sin servidor.
Crea un secreto con una contraseña para iniciar sesión en la base de datos del clúster de Atlas.
Reemplace P@@ssword% con su contraseña y ejecute los siguientes comandos:
kubectl create secret generic the-user-password --from-literal="password=P@@sword%"
kubectl label secret the-user-password atlas.mongodb.com/type=credentials
Si usa almacenamiento secreto externo, no necesita guardar información confidencial directamente en los secretos de Kubernetes. Para obtener más información, consulte Configurar almacenamiento secreto.
Cree el recurso personalizado AtlasDatabaseUser.
Ejecuta el siguiente comando para crear el AtlasDatabaseUser recurso personalizado:
Nota
spec.passwordSecretRef debe hacer referencia a la contraseña que creó anteriormente.
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
Verifique el estado de su usuario de base de datos.
Ejecute el siguiente comando hasta que reciba una respuesta True, lo que indica que el usuario de la base de datos está listo:
Nota
El AtlasDatabaseUser recurso personalizado espera hasta que el clúster esté listo. Crear un nuevo clúster Atlas de nivel gratuito tarda menos de 15 segundos. Crear un nuevo clúster Flex o Dedicado puede tardar hasta 10 minutos.
kubectl get atlasdatabaseusers my-database-user -o=jsonpath='{.status.conditions[?(@.type=="Ready")].status}'
Recuperar el secreto que Atlas Kubernetes Operator creó para conectarse al clúster.
Copie el siguiente comando:
Importante
El siguiente comando requiere
jq1.6 o superior.kubectl get secret {my-project}-{my-atlas-cluster}-{my-database-user} -o json | jq -r '.data | with_entries(.value |= @base64d)'; Reemplaza los siguientes marcadores de posición con los detalles para tus recursos personalizados:
my-projectEspecifica el valor del campo
metadatade tuAtlasProjectRecurso Personalizado.my-atlas-clusterEspecifica el valor del campo
metadatade tuAtlasDeploymentRecurso Personalizado.my-database-userEspecifica el valor del campo
metadatade tuAtlasDatabaseUserRecurso Personalizado.Ejecuta el comando.
Nota
Las cadenas de conexión serán diferentes a las del siguiente ejemplo.
{ "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" } Puedes usar este secreto en tu aplicación:
containers: - name: test-app env: - name: "CONNECTION_STRING" valueFrom: secretKeyRef: name: test-atlas-operator-project-test-cluster-theuser key: connectionStringStandardSrv