/ /

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. Cuando creas el recurso personalizado AtlasDataFederation, Atlas Kubernetes Operator intenta crear o actualizar una instancia federada de base de datos en Atlas. Puedes usar una instancia de base de datos federada para ejecutar queries federados.

Importante

Recursos personalizados ya no borran objetos por defecto

El operador de Kubernetes de Atlas utiliza Los archivos de configuración de recursos personalizados para gestionar tu configuración de Atlas, pero a partir de Atlas Kubernetes Operator 2.0, los recursos personalizados que borras en Kubernetes ya no se eliminan en Atlas (por defecto). En su lugar, Atlas Kubernetes Operator simplemente deja de gestionar esos recursos en Atlas. Por ejemplo, si eliminas un AtlasProject Custom 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 personalizado AtlasDeployment, 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

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 AtlasDataFederation especificación de recurso personalizado con nodos 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

Atlas Data Federation

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 objetivo de AtlasDataFederation.

`Name`	Tipo	Descripción	Requerido
`name`	string	Etiqueta legible por humanos que identifica la instancia federada de base de datos.	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 se aloja esta instancia federada de base de datos.	false
`dataProcessRegion`	Objeto	Información sobre la región del proveedor de nube a la que la instancia federada de base de datos enruta las conexiones de los clientes.	false
`privateEndpoints`	[]objeto	Endpoint privado para instancias de bases de datos federadas y ficheros en línea para agregar al proyecto especificado.	false
`storage`	Objeto	Información de configuración para cada almacén de datos y su mapeo a bases de datos `MongoDB` Atlas.	false

AtlasDataFederation.spec.projectRef

El 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	namespace del recurso de Kubernetes	false

AtlasDataFederation.spec.cloudProviderConfig

Configuración para el proveedor de nube donde se aloja esta instancia federada de base de datos.

`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 bucket de datos `S3` al que el rol adicional `ID` tiene autorización de acceso. Es obligatorio si se especifica `cloudProviderConfig`.	false

AtlasDataFederation.spec.dataProcessRegion

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

`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 redirige las conexiones de los clientes. Enum: `SYDNEY_AUS`, `MUMBAI_IND`, `FRANKFURT_DEU`, `DUBLIN_IRL`, `LONDON_GBR`, `VIRGINIA_USA`, `OREGON_USA`, `SAOPAULO_BRA`, `SINGAPORE_SGP`	false

AtlasDataFederation.spec.puntos finales privados

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

AtlasDataFederation.spec.almacenamiento

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

`Name`	Tipo	Descripción	Requerido
`databases`	[]objeto	Arreglo que contiene `databases` interrogables y 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 con este lago de datos. Las bases de datos contienen colecciones y vistas.

`Name`	Tipo	Descripción	Requerido
`collections`	[]objeto	Arreglo de `collections` y fuentes de datos que se mapean 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	Arreglo que contiene los almacenes de datos que mapean a una colección para este lago de datos.	false
`name`	string	Etiqueta legible por humanos que identifica la colección en 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	Indicador que valida el esquema en las URL especificadas. Si es verdadero, permite un esquema `HTTP` inseguro, no verifica la cadena de certificados y el nombre de host del servidor, y acepta cualquier certificado con cualquier nombre de host presentado por el servidor. Si es falso, permite solo el esquema seguro `HTTPS`.	false
`collection`	string	Etiqueta legible por humanos que identifica a `collection` en la base de datos. Para crear una colección comodín (*), debes omitir este parámetro.	false
`collectionRegex`	string	Patrón Regex para usar en la creación de la colección comodín (*).	false
`database`	string	Etiqueta legible por humanos que identifica la base de datos, que contiene la colección en el clúster. Debes omitir este parámetro para generar colecciones comodín (*) para bases de datos generadas dinámicamente.	false
`databaseRegex`	string	Patrón de expresión regular que se utilizará para crear la base de datos comodín (*).	false
`defaultFormat`	enum	Formato de archivo que utiliza `MongoDB` Cloud si encuentra un archivo sin extensión de archivo mientras busca en `storeName`. Enum: .avro, .avro.bz2, .avro.gz, .bson, .bson.bz2, .bson.gz, .bsonx, .csv, .csv.bz2, .csv.gz, .json, .json.bz2, .json.gz, .orc, .parquet, TSV, .tsv.bz2, .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.views

`Name`	Tipo	Descripción	Requerido
`name`	string	Etiqueta legible por humanos que identifica la vista, la cual corresponde a una pipeline 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.almacenamiento.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 `AWS` `S3` clases de almacenamiento. Atlas Data Lake incluye los archivos en estas clases de almacenamiento en los resultados de la query.	false
`bucket`	string	Etiqueta legible por humanos que identifica el cubo `AWS` `S3`. Esta etiqueta debe coincidir exactamente con el nombre de un `S3` `bucket` al que el lago de datos pueda acceder con las `AWS` credenciales configuradas de Identity and Access Management (`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	Indicador que señala si se deben utilizar las etiquetas `S3` en los archivos de la ruta dada como atributos adicionales de partición. Si se establece en verdadero, el lago de datos añade las etiquetas `S3` como atributos de partición adicionales y agrega nuevos elementos `BSON` de nivel superior que asocian cada etiqueta a cada documento.	false
`name`	string	Etiqueta legible para humanos que identifica el almacén de datos. El campo `storeName` hace referencia a estos valores como parte de la configuración del mapeo. Para utilizar `MongoDB` Atlas como lugar de almacenamiento 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` utilizado para los almacenes de datos.	false
`public`	booleano	Indicador que indica si el depósito es público. Si se establece como verdadero, `MongoDB` nube no utiliza el rol configurado de `AWS` Identity and Access gestión (`IAM`) para acceder al depósito `S3` . Si se establece en falso, la configuración `AWS` `IAM` rol debe incluir permisos para acceso al `S3` bucket.	false
`region`	string	Ubicación física donde `MongoDB` Cloud implementa los nodos de clúster alojados en `AWS`- `MongoDB`. El `region` que elijas puede afectar la latencia de la red para los clientes que acceden a tus bases de datos. Cuando `MongoDB` Atlas despliega un clúster dedicado, verifica si existe una conexión `VPC` o `VPC` para ese proveedor y región. Si no, `MongoDB` Atlas los crea como parte de la implementación. Para limitar una nueva conexión de emparejamiento de `VPC` a un bloque y región de `CIDR`, crea primero la conexión. Implementa el clúster después de que comience la conexión.	false

AtlasDataFederation.status

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 se ejecuta en el clúster, en . formato.	false
`observedGeneration`	entero	`ObservedGeneration` indica la generación de la especificación del recurso de la que el operador Atlas tiene conocimiento. El operador de Atlas actualiza este campo al valor de 'metadatos.generation' tan pronto como comience 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 recursos personalizados 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	Un `message` que proporciona detalles sobre la transición.	false
`reason`	string	El `reason` para la última transición de la condición.	false

Volver

AtlasTeam

AtlasFederatedAuth