MongoDB.local SF, Jan 15: See the speaker lineup & ship your AI vision faster. Use WEB50 to save 50%
Find out more >
Menu Docs
Página inicial do Docs
/ /
/ / /

AtlasDataFederation Recurso personalizado

Observação

O Atlas Kubernetes Operator não oferece suporte ao recurso personalizado AtlasDataFederation para o Atlas for Government.

O recurso personalizado do AtlasDataFederation configura uma instância do banco de dados federado no Atlas. Quando você cria o recurso personalizado AtlasDataFederation, o Atlas Kubernetes Operator tenta criar ou atualizar uma instância do banco de dados federado no Atlas. Você pode utilizar uma instância do banco de dados federado para executar queries federadas.

Importante

Os Recursos Personalizados Não Excluem Mais Objetos por Padrão

  • O Atlas Kubernetes Operator usa arquivos de configuração de recurso personalizado para gerenciar sua configuração do Atlas , mas a partir do Atlas Kubernetes Operator,2.0 os recursos personalizados que você exclui no Kubernetes não são mais (por padrão) excluídos no Atlas. Em vez disso, o Atlas Kubernetes Operator simplesmente para de gerenciar estes recursos no Atlas. Por exemplo, se você excluir um AtlasProject Recurso Personalizado em Kubernetes, por padrão, o Atlas Kubernetes Operator não excluirá mais automaticamente o projeto correspondente do Atlas. Essa mudança no comportamento destina-se a ajudar a evitar exclusões acidentais ou inesperadas. Para saber mais, incluindo como reverter este comportamento para o padrão utilizado antes do Atlas Kubernetes 2 0Operator., consulte Novo padrão: proteção de exclusão no Atlas Kubernetes 2 0Operator..

    Da mesma forma, o Atlas Kubernetes Operator não exclui equipes do Atlas se você as remover de um projeto do Atlas no Kubernetes com o Atlas Kubernetes Operator.

  • Defina explicitamente os detalhes de configuração desejados para evitar o uso implícito de valores de configuração padrão do Atlas . Em alguns casos, herdar os padrões do Atlas pode resultar em um loop de reconciliação que pode impedir que seu recurso personalizado atinja um estado READY. Por exemplo, definir explicitamente o comportamento de autoscaling desejado em seu recurso personalizado AtlasDeployment, conforme mostrado no exemplo incluído, garante que um tamanho de instância estática em seu recurso personalizado não esteja sendo aplicado repetidamente a um sistema do Atlas que tenha o autoscaling ativado.

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

O Atlas Kubernetes Operator usa o Atlas Clusters API Resource e o Advanced Clusters API Resource para criar uma nova instância do banco de dados federado ou atualizar uma instância do banco de dados federado existente. Se você especificar valores para os campos em spec.serverlessSpec, o Atlas Kubernetes Operator usará o Recurso Atlas de Instância sem Servidor API para criar ou configurar endpoints privados para sua instância do banco de dados federado.

Se você remover o recurso AtlasDataFederation do cluster do Kubernetes, o Atlas Kubernetes Operator removerá a instância do banco de dados federado do Atlas.

O exemplo a seguir mostra uma especificação de recurso personalizada AtlasDataFederation com endpoints 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

AtlasDataFederation é o esquema para a API do Atlas Data Federation .

Name
Tipo
Descrição
Obrigatório

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasDataFederation

true

metadata

objeto

Consulte a documentação do Kubernetes API para os campos do campo metadata.

true

spec

objeto

DataFederationSpec define o estado alvo de AtlasDataFederation.

false

status

objeto

DataFederationStatus define o estado observado de AtlasDataFederation.

false

DataFederationSpec define o estado de destino do AtlasDataFederation.

Name
Tipo
Descrição
Obrigatório

name

string

Etiqueta legível por humanos que identifica a instância do banco de dados federado.

true

projectRef

objeto

O projeto é uma referência ao recurso AtlasProject ao qual o sistema pertence.

true

cloudProviderConfig

objeto

Configuração do provedor de nuvem onde essa Instância do Banco de Dados Federado está hospedada.

false

dataProcessRegion

objeto

Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.

false

privateEndpoints

[] objeto

Endpoint privado para instâncias do banco de dados federados e Online Archives para adicionar ao projeto especificado.

false

storage

objeto

Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Atlas .

false

O projeto é uma referência ao recurso AtlasProject ao qual a implantação pertence.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Configuração do provedor de nuvem onde essa Instância do Banco de Dados Federado está hospedada.

Name
Tipo
Descrição
Obrigatório

aws

objeto

Configuração para executar a Data Federation no AWS.

false

Configuração para executar a Data Federation no AWS.

Name
Tipo
Descrição
Obrigatório

roleId

string

Identificador exclusivo da função que o data lake pode usar para acessar os armazenamentos de dados.Obrigatório se especificar cloudProviderConfig.

false

testS3Bucket

string

Nome do bucket de dados S3 que o role fornecido ID está autorizado a acessar.Obrigatório se especificar cloudProviderConfig.

false

Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.

Name
Tipo
Descrição
Obrigatório

cloudProvider

enum

Nome do serviço de nuvem que hospeda a infraestrutura da Instância do Banco de Dados Federado. Enum: AWS

false

region

enum

Nome do region para o qual o data lake encaminha as conexões do cliente . SYDNEY_AUSMUMBAI_INDFRANKFURT_DEUDUBLIN_IRLLONDON_GBRVIRGINIA_USAOREGON_USASAOPAULO_BRAEnum:,,,,,,,, SINGAPORE_SGP

false

Name
Tipo
Descrição
Obrigatório

endpointId

string

String única alfanumérica de 24 caracteres que identifica o endpoint privado.

false

provider

string

Etiqueta legível por humanos que identifica o provedor de serviços de nuvem. O Atlas Data Lake suporta apenas Amazon Web Services.

false

type

string

Etiqueta legível por humanos que identifica o recurso type associado a este endpoint privado.

false

Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados MongoDB Atlas .

Name
Tipo
Descrição
Obrigatório

databases

[] objeto

Array que contém o databases consultável e as coleções para este data lake.

false

stores

[] objeto

Array que contém os dados stores para o data lake.

false

Banco de dados associado a este data lake. Os bancos de dados contêm collections e visualizações.

Name
Tipo
Descrição
Obrigatório

collections

[] objeto

Array de collections e fontes de dados que mapeiam para um armazenamento de dados de armazenamentos.

false

maxWildcardCollections

inteiro

Número máximo de coleções de curingas no banco de dados. Isso se aplica apenas a S3 fontes de dados. O valor mínimo é 1, o valor máximo é 1000. O valor padrão é 100.

false

name

string

Rótulo legível por humanos que identifica o banco de dados para o qual o data lake mapeia os dados.

false

views

[] objeto

Array de pipelines de agregação que se aplicam à coleção. Isso se aplica apenas a S3 fontes de dados.

false

Mapas de coleção para um armazenamento de dados de armazenamentos.

Name
Tipo
Descrição
Obrigatório

dataSources

[] objeto

Array que contém os armazenamentos de dados que mapeiam para uma coleção para esse data lake.

false

name

string

Etiqueta legível para humanos que identifica a collection para a qual o MongoDB Atlas mapeia os dados nos armazenamentos de dados.

false

Name
Tipo
Descrição
Obrigatório

allowInsecure

booleano

Sinalizador que valida o esquema nas URLs especificadas. Se verdadeiro, permite o esquema HTTP inseguro, não verifica a cadeia de certificados e o nome do host do servidor e aceita qualquer certificado com qualquer nome de host apresentado pelo servidor. Se falso, permite somente o esquema HTTPS seguro.

false

collection

string

Rótulo legível por humanos que identifica o collection no banco de dados. Para criar uma collection de curinga(), você deve omitir este parâmetro.

false

collectionRegex

string

Padrão regex a ser usado para criar a coleção curinga().

false

database

string

Rótulo legível por humanos que identifica o banco de dados, que contém a coleção no cluster. Você deve omitir este parâmetro para gerar coleções curinga() para bancos de dados gerados dinamicamente.

false

databaseRegex

string

Padrão regex a ser usado para criar o banco de dados wildcard().

false

defaultFormat

enum

Formato de arquivo que MongoDB o Cloud usa storeName se encontrarum arquivo sem extensão de arquivo ao pesquisar.2 2Enum:.avro,.avro.bz,.avro.gz,.bson,.bson.bz,.bson.gz,.bsonx,.csv,.csv.bz,.csv2 22.gz,.json,.json.bz,.json.gz,.orc,.parquet,.tsv,.tsv.bz,.tsv.gz

false

path

string

Arquivo path que controla como o MongoDB Cloud procura e analisa arquivos no storeName antes de mapeá-los para uma collection. Especifique / para capturar todos os arquivos e pastas do caminho do prefixo.

false

provenanceFieldName

string

Nome do campo que inclui a procedência dos documentos nos resultados. MongoDB O Atlas retorna campos diferentes nos resultados de cada provedor suportado.

false

storeName

string

Rótulo legível por humanos que identifica o armazenamento de dados que o MongoDB Cloud mapeia para a coleção.

false

urls

[]string

URLs dos arquivos de dados acessíveis publicamente. Não é possível especificar URLs que exijam autenticação. O Atlas Data Lake cria uma partição para cada URL. Se vazio ou omitido, o Data Lake usa as URLs do armazenamento especificado no parâmetro storeName.

false

Name
Tipo
Descrição
Obrigatório

name

string

Etiqueta legível para humanos que identifica a visualização, que corresponde a uma aggregation pipeline em uma collection.

false

pipeline

string

Estágios de agregação pipeline para aplicar à coleção de origem.

false

source

string

Etiqueta legível por humanos que identifica a collection source para a visualização.

false

Armazenar é um grupo de configurações que definem onde os dados são armazenados.

Name
Tipo
Descrição
Obrigatório

additionalStorageClasses

[]string

Coleção de AWS S3 classes de armazenamento. O Atlas Data Lake inclui os arquivos nessas classes de armazenamento nos resultados da query.

false

bucket

string

Etiqueta legível por humanos que identifica o bucket AWS S3 . Esse rótulo deve corresponder exatamente ao nome de um S3 bucket que o data lake pode acessar com as credenciais configuradas do AWS Gerenciamento de Identidade e Acesso (IAM).

false

delimiter

string

O delimiter que separa os segmentos de caminho no armazenamento de dados. O MongoDB Atlas utiliza o delimiter para percorrer com eficiência os buckets do S3 com uma estrutura de diretório hierárquica. Você pode especificar qualquer caractere suportado pelas chaves de objeto S3 como delimitador.

false

includeTags

booleano

Sinalizador que indica se as tags S3 devem ser usadas nos arquivos no caminho fornecido como atributos de partição adicionais. Se definido como true, o data lake adicionará as tags S3 como atributos de partição adicionais e adicionará novos elementos BSON de nível superior associando cada tag a cada documento.

false

name

string

Rótulo legível por humanos que identifica o armazenamento de dados. O campo storeName referencia estes valores como parte da configuração de mapeamento. Para utilizar o MongoDB Atlas como um armazenamento de dados, o data lake exige uma instância sem servidor ou um cluster M10 ou superior.

false

prefix

string

Prefixo que o MongoDB Cloud aplica ao procurar arquivos no bucket S3. O armazenamento de dados acrescenta o valor de prefix ao caminho para criar o caminho completo para a ingestão dos arquivos. Se omitido, o MongoDB Cloud pesquisa todos os arquivos a partir da raiz do bucket S3.

false

provider

string

O provider usado para armazenamentos de dados.

false

public

booleano

Sinalizador que indica se o bucket é público. Se definido como true, MongoDB Cloud não usa a função AWS Identity and Access Management (IAM) configurada para acessar o bucket S3. Se definido como falso, o role AWS IAM configurado deverá incluir permissões para acessar o bucket S3.

false

region

string

Local físico onde a MongoDB Cloud implementa seus nós de cluster MongoDB hospedados no AWS. O region escolhido pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Quando o MongoDB Atlas implementa um cluster dedicado, ele verifica se existe uma conexão VPC ou VPC para este provedor e região. Caso contrário, o MongoDB Atlas os cria como parte do sistema. Para limitar uma nova conexão de emparelhamento do VPC a um bloco e região do CIDR, crie a conexão primeiro. Implemente o cluster após o início da conexão.

false

DataFederationStatus define o estado observado de AtlasDataFederation.

Name
Tipo
Descrição
Obrigatório

conditions

[] objeto

Condições é a lista de status que mostra o estado atual do Recurso Personalizado do Atlas

true

mongoDBVersion

string

MongoDBVersion é a versão do MongoDB que o cluster executa, em . formato.

false

observedGeneration

inteiro

ObservedGeneration indica a geração da especificação de recursos que o Operador Atlas está ciente. O Operador do Atlas atualiza este campo para o valor de 'metadata.generation' assim que inicia a reconciliação do recurso. Formato: int64

false

A condição descreve o estado de um recurso personalizado do Atlas em um determinado ponto.

Name
Tipo
Descrição
Obrigatório

status

string

Status da condição; um de verdadeiro, falso, desconhecido.

true

type

string

Tipo de condição do Atlas Custom Resource.

true

lastTransitionTime

string

Última vez que a condição fez a transição de um status para outro. Representado no ISO 8601 formato. Formato: data/hora

false

message

string

Um message fornecendo detalhes sobre a transição.

false

reason

string

O reason para a última transição da condição.

false

Voltar

AtlasTeam

Nesta página