/ /

Recursos personalizados

Docs Home

Gestión

Operador de Atlas Kubernetes

Recursos personalizados

Docs Home

Gestión

Operador de Atlas Kubernetes

Recursos personalizados

`AtlasDataFederation` Recurso personalizado

Nota

El operador de Kubernetes de Atlas no admite el recurso personalizado AtlasDataFederation para Atlas para el gobierno.

El recurso personalizado AtlasDataFederation configura una instancia de base de datos federada en Atlas. Al crear el recurso personalizado AtlasDataFederation, el operador de Kubernetes de Atlas intenta crear o actualizar una instancia de base de datos federada en Atlas. Puede usar una instancia de base de datos federada para ejecutar consultas federadas.

Importante

Los recursos personalizados ya no eliminan objetos de forma predeterminada

El operador de Kubernetes de Atlas utiliza Archivosde configuración de recursos personalizados para administrar la configuración de Atlas. Sin embargo, a partir del Operador de 2.0 Kubernetes de Atlas, los recursos personalizados que elimine en Kubernetes ya no se eliminan (de forma predeterminada) en Atlas. En su lugar, el Operador de Kubernetes de Atlas simplemente deja de administrar esos recursos en Atlas. Por ejemplo, si elimina un AtlasProject Recurso Personalizado en Kubernetes, el Operador de Kubernetes de Atlas ya no elimina automáticamente el proyecto correspondiente de Atlas. Este cambio de comportamiento tiene como objetivo ayudar a prevenir eliminaciones accidentales o inesperadas. Para obtener más información, incluido cómo revertir este comportamiento al valor predeterminado utilizado antes del Operador de Kubernetes de Atlas.,2 0consulte Nuevo valor predeterminado: Protección contra eliminaciones en el Operador de Kubernetes 2 de0 Atlas..
De manera similar, Atlas Kubernetes Operator no elimina equipos de Atlas si los elimina de un proyecto Atlas en Kubernetes con Atlas Kubernetes Operator.

Defina explícitamente los detalles de configuración deseados para evitar el uso implícito de los valores predeterminados de Atlas. En algunos casos, heredar los valores predeterminados de Atlas puede generar un bucle de conciliación que impide que su recurso personalizado alcance el estado READY. Por ejemplo, definir explícitamente el comportamiento de escalado automático deseado en su recurso personalizado AtlasDeployment, como se muestra en el ejemplo incluido, garantiza que un tamaño de instancia estático en su recurso personalizado no se aplique repetidamente a una implementación de Atlas con el escalado automático habilitado.

autoScaling:
  diskGB:
    enabled: true
  compute:
    enabled: true
    scaleDownEnabled: true
    minInstanceSize: M30
    maxInstanceSize: M40

Atlas Kubernetes Operator utiliza los recursos de la API de clústeres de Atlas y de la spec.serverlessSpec API de clústeres avanzados para crear una nueva instancia de base de datos federada o actualizar una instancia de base de datos federada existente. Si especifica valores para los campos en, Atlas Kubernetes Operator utiliza el recurso de la API de instancia sin servidor de Atlas para crear o configurar puntos finales privados para su instancia de base de datos federada.

Si elimina el recurso AtlasDataFederation de su clúster de Kubernetes, Atlas Kubernetes Operator elimina la instancia federada de base de datos de Atlas.

Ejemplos

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasDataFederation con puntos finales privados configurados:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDataFederation
metadata:
  name: my-federated-deployment
spec:
  projectRef:
    name: my-project
    namespace: default
  cloudProviderConfig:
    aws:
      roleId: 12345678
      testS3Bucket: my-bucket
  dataProcessRegion:
    cloudProvider: AWS
    region: OREGON_USA
  name: my-fdi
  storage:
    databases:
    - collections:
      - dataSources:
        - allowInsecure: false
          collection: my-collection
          collectionRegex:
          database: my-database
          databaseRegex:
          defaultFormat: ".avro"
          path: /
          provenanceFieldName: string
          storeName: my-data-store
          urls:
          - string:
        name: my-collection-mdb
      maxWildcardCollections: 100
      name: my-database-mdb
      views:
      - name: my-view
        pipeline:
        source: my-source-collection
    stores:
    - name: my-store
      provider: S3
      additionalStorageClasses:
      - STANDARD
      bucket: my-bucket
      delimiter: /
      includeTags: false
      prefix: data-
      public: false
      region: US_WEST_1
  privateEndpoints:
  - endpointId: vpce-3bf78b0ddee411ba1
    provider: AWS
    type: DATA_LAKE
  - endpointId: vpce-3bf78b0ddee411ba2
    provider: AWS
    type: DATA_LAKE

Parámetros

Federación de Datos Atlas

AtlasDataFederation es el esquema para la API de Atlas Data Federation.

`Name`	Tipo	Descripción	Requerido
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasDataFederation`	true
`metadata`	Objeto	Consulte la documentación de Kubernetes `API` para conocer los campos del campo `metadata`.	true
`spec`	Objeto	`DataFederationSpec` define el estado objetivo de `AtlasDataFederation`.	false
`status`	Objeto	`DataFederationStatus` define el estado observado de `AtlasDataFederation`.	false

AtlasDataFederation.spec

DataFederationSpec define el estado de destino de AtlasDataFederation.

`Name`	Tipo	Descripción	Requerido
`name`	string	Etiqueta legible por humanos que identifica la instancia de base de datos federada.	true
`projectRef`	Objeto	El proyecto es una referencia al recurso `AtlasProject` al que pertenece la implementación.	true
`cloudProviderConfig`	Objeto	Configuración para el proveedor de nube donde está alojada esta instancia de base de datos federada.	false
`dataProcessRegion`	Objeto	Información sobre la región del proveedor de la nube a la que la instancia de base de datos federada enruta las conexiones del cliente.	false
`privateEndpoints`	[]objeto	Punto final privado para instancias de bases de datos federadas y archivos en línea para agregar al proyecto especificado.	false
`storage`	Objeto	Información de configuración para cada almacén de datos y su asignación a bases de datos Atlas `MongoDB`.	false

AtlasDataFederation.spec.projectRef

Proyecto es una referencia al recurso AtlasProject al que pertenece la implementación.

`Name`	Tipo	Descripción	Requerido
`name`	string	Nombre del recurso de Kubernetes	true
`namespace`	string	Espacio de nombres del recurso de Kubernetes	false

AtlasDataFederation.spec.cloudProviderConfig

Configuración para el proveedor de nube donde está alojada esta instancia de base de datos federada.

`Name`	Tipo	Descripción	Requerido
`aws`	Objeto	Configuración para ejecutar la federación de datos en `AWS`.	false

AtlasDataFederation.spec.cloudProviderConfig.aws

Configuración para ejecutar Data Federation en AWS.

`Name`	Tipo	Descripción	Requerido
`roleId`	string	Identificador único del rol que el lago de datos puede usar para acceder a los almacenes de datos. Obligatorio si se especifica `cloudProviderConfig`.	false
`testS3Bucket`	string	Nombre del depósito de datos `S3` al que el rol proporcionado `ID` está autorizado a acceder. Obligatorio si se especifica `cloudProviderConfig`.	false

AtlasDataFederation.spec.dataProcessRegión

Información sobre la región del proveedor de la nube a la que la instancia de base de datos federada enruta las conexiones del cliente.

`Name`	Tipo	Descripción	Requerido
`cloudProvider`	enum	Nombre del servicio en la nube que hospeda la infraestructura de la instancia federada de base de datos. Enum: `AWS`	false
`region`	enum	Nombre del `region` al que el lago de datos enruta las conexiones de cliente. `SYDNEY_AUSMUMBAI_INDFRANKFURT_DEUDUBLIN_IRLLONDON_GBRVIRGINIA_USA`Enumeración:,,,,,,,, `OREGON_USASAOPAULO_BRASINGAPORE_SGP`	false

AtlasDataFederation.spec.puntos finales privados

`Name`	Tipo	Descripción	Requerido
`endpointId`	string	Cadena alfanumérica única de 22caracteres que identifica el punto final privado.	false
`provider`	string	Etiqueta legible que identifica al proveedor de servicios en la nube. Atlas Data Lake solo es compatible con Amazon Web Services.	false
`type`	string	Etiqueta legible por humanos que identifica el recurso `type` asociado con este punto final privado.	false

AtlasDataFederation.spec.almacenamiento

Información de configuración para cada almacén de datos y su mapeo a bases de datos MongoDB Atlas.

`Name`	Tipo	Descripción	Requerido
`databases`	[]objeto	Matriz que contiene los `databases` consultables y las colecciones para este lago de datos.	false
`stores`	[]objeto	Matriz que contiene los datos `stores` para el lago de datos.	false

AtlasDataFederation.spec.almacenamiento.bases de datos

Base de datos asociada a este lago de datos. Las bases de datos contienen colecciones y vistas.

`Name`	Tipo	Descripción	Requerido
`collections`	[]objeto	Matriz de `collections` y fuentes de datos que se asignan a un almacén de datos.	false
`maxWildcardCollections`	entero	Número máximo de colecciones de comodines en la base de datos. Esto solo aplica a `S3` fuentes de datos. El valor mínimo es 1 y el máximo es 1000. El valor predeterminado es 100.	false
`name`	string	Etiqueta legible por humanos que identifica la base de datos a la que el lago de datos asigna los datos.	false
`views`	[]objeto	Arreglo de pipelines de agregación que se aplican a la colección. Esto solo se aplica a fuentes de datos `S3`.	false

AtlasDataFederation.spec.almacenamiento.bases de datos.colecciones

colección se asigna a una almacenar de datos de almacenes.

`Name`	Tipo	Descripción	Requerido
`dataSources`	[]objeto	Matriz que contiene los almacenes de datos que se asignan a una colección para este lago de datos.	false
`name`	string	Etiqueta legible por humanos que identifica la colección a la que `MongoDB` Atlas asigna los datos en los almacenes de datos.	false

AtlasDataFederation.spec.storage.databases.collections.dataSources

`Name`	Tipo	Descripción	Requerido
`allowInsecure`	booleano	Marca que valida el esquema en las URL especificadas. Si es "true", permite el esquema `HTTP` inseguro, no verifica la cadena de certificados ni el nombre de host del servidor y acepta cualquier certificado con cualquier nombre de host presentado por el servidor. Si es "false", solo permite el esquema `HTTPS` seguro.	false
`collection`	string	Etiqueta legible que identifica el `collection` en la base de datos. Para crear una colección con comodines (*), debe omitir este parámetro.	false
`collectionRegex`	string	Patrón de expresión regular a utilizar para crear la colección de comodines (*).	false
`database`	string	Etiqueta legible que identifica la base de datos que contiene la colección en el clúster. Debe omitir este parámetro para generar colecciones con comodines (*) para bases de datos generadas dinámicamente.	false
`databaseRegex`	string	Patrón Regex a utilizar para crear la base de datos de comodines (*).	false
`defaultFormat`	enum	Formato de archivo que `MongoDB` Cloud utiliza si encuentra un archivo sin extensión al `storeName` buscar. Enumeración: .avro, .avro.bz,2.avro.gz, .bson, .bson.bz,2.bson.gz, .bsonx, .csv, .csv.bz,2.csv.gz, .json, .json.bz,2.json.gz, .orc, .parquet, .tsv, .tsv.bz,2.tsv.gz	false
`path`	string	Archivo `path` que controla cómo `MongoDB` Cloud busca y analiza los archivos en `storeName` antes de asignarlos a una colección. Especifique / para capturar todos los archivos y carpetas de la ruta de prefijo.	false
`provenanceFieldName`	string	Nombre del campo que incluye la procedencia de los documentos en los resultados. `MongoDB` Atlas devuelve diferentes campos en los resultados para cada proveedor compatible.	false
`storeName`	string	Etiqueta legible por humanos que identifica el almacén de datos que `MongoDB` Cloud asigna a la colección.	false
`urls`	[]cadena	URL de los archivos de datos de acceso público. No se pueden especificar URL que requieran autenticación. Atlas Data Lake crea una partición para cada `URL`. Si se deja vacío o se omite, Data Lake utiliza las URL del almacén especificado en el parámetro `storeName`.	false

AtlasDataFederation.spec.almacenamiento.bases de datos.vistas

`Name`	Tipo	Descripción	Requerido
`name`	string	Etiqueta legible por humanos que identifica la vista, que corresponde a una canalización de agregación en una colección.	false
`pipeline`	string	Etapas de agregación `pipeline` para aplicar a la colección de origen.	false
`source`	string	Etiqueta legible por humanos que identifica la colección `source` para la vista.	false

AtlasDataFederation.spec.storage.stores

Tienda es un grupo de configuraciones que definen dónde se almacenan los datos.

`Name`	Tipo	Descripción	Requerido
`additionalStorageClasses`	[]cadena	Colección de clases de almacenamiento `AWS` `S3`. Atlas Data Lake incluye los archivos de estas clases de almacenamiento en los resultados de la consulta.	false
`bucket`	string	Etiqueta legible que identifica el bucket `AWS` `S3`. Esta etiqueta debe coincidir exactamente con el nombre de un `S3` `bucket` al que el data lake pueda acceder con las credenciales de Administración de Identidad y Acceso (`AWS`) configuradas (`IAM`).	false
`delimiter`	string	El `delimiter` separa los segmentos de ruta en el almacén de datos. `MongoDB` Atlas usa el `delimiter` para recorrer eficientemente los depósitos `S3` con una estructura de directorios jerárquica. Puede especificar cualquier carácter compatible con las claves de objeto `S3` como delimitador.	false
`includeTags`	booleano	Marca que indica si se deben usar etiquetas `S3` en los archivos de la ruta dada como atributos de partición adicionales. Si se establece como verdadero, Data Lake agrega las etiquetas `S3` como atributos de partición adicionales y añade nuevos elementos `BSON` de nivel superior que asocian cada etiqueta a cada documento.	false
`name`	string	Etiqueta legible que identifica el almacén de datos. El campo `storeName` hace referencia a estos valores como parte de la configuración de mapeo. Para usar Atlas `MongoDB` como almacén de datos, el lago de datos requiere una instancia sin servidor o un clúster `M10` o superior.	false
`prefix`	string	Prefijo que `MongoDB` Cloud aplica al buscar archivos en el bucket `S3`. El almacén de datos antepone el valor de `prefix` a la ruta para crear la ruta completa para los archivos que se van a ingresar. Si se omite, `MongoDB` nube busca todos los archivos desde la raíz de la `S3` bucket.	false
`provider`	string	El `provider` se utiliza para almacenes de datos.	false
`public`	booleano	Marca que indica si el bucket es público. Si se establece en "true", `MongoDB` Cloud no utiliza el rol de `AWS` Administración de Identidad y Acceso`IAM` () configurado para acceder al `S3` bucket. Si se establece en "false", el `AWS` `IAM` rol configurado debe incluir permisos para acceder al `S3` bucket.	false
`region`	string	Ubicación física donde `MongoDB` Cloud implementa los nodos de su clúster `MongoDB` alojados en `AWS`. La `region` que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos. Cuando `MongoDB` Atlas implementa un clúster dedicado, comprueba si existe una conexión `VPC` o `VPC` para ese proveedor y región. De no ser así, `MongoDB` Atlas las crea como parte de la implementación. Para limitar una nueva conexión de peering `VPC` a un bloque y región `CIDR`, cree primero la conexión. Implemente el clúster después de que se inicie la conexión.	false

Estado de AtlasDataFederation

DataFederationStatus define el estado observado de AtlasDataFederation.

`Name`	Tipo	Descripción	Requerido
`conditions`	[]objeto	Condiciones es la lista de estados que muestra el estado actual del recurso personalizado de Atlas	true
`mongoDBVersion`	string	`MongoDBVersion` es la versión de `MongoDB` que ejecuta el clúster, en formato .	false
`observedGeneration`	entero	`ObservedGeneration` Indica la generación de la especificación del recurso que el operador Atlas conoce. El operador Atlas actualiza este campo con el valor 'metadata.generation' en cuanto inicia la conciliación del recurso. Formato: int64	false

AtlasDataFederation.status.conditions

La condición describe el estado de un recurso personalizado de Atlas en un momento determinado.

`Name`	Tipo	Descripción	Requerido
`status`	string	Estado de la condición; uno de Verdadero, Falso, Desconocido.	true
`type`	string	Tipo de condición de recurso personalizado de Atlas.	true
`lastTransitionTime`	string	Última vez que la condición cambió de un estado a otro. Representado en `ISO` 8601 formato. Formato: fecha y hora.	false
`message`	string	A `message` proporcionando detalles sobre la transición.	false
`reason`	string	El `reason` para la última transición de la condición.	false

Volver

Equipo Atlas

Autorización federada de Atlas