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
/ /
/ / /

AtlasProject Recurso personalizado

O recurso personalizado do AtlasProject configura o projeto no Atlas. Ao criar o recurso personalizado AtlasProject , o Atlas Kubernetes Operator tenta criar um novo projeto no Atlas.

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 no 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 realiza uma das seguintes ações:

Você pode usar o parâmetro spec.connectionSecretRef.name para definir o segredo de conexão para o recurso personalizado AtlasProject. Este parâmetro substitui o global segredo de conexão padrão.

Por padrão, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o Recurso PersonalizadoAtlasProject . Para armazenar segredos em outro namespace, especifique o spec.connectionSecretRef. parâmetro do namespace .

Para se conectar à API de administração do Atlas, o Atlas Kubernetes Operator lê o ID da organização e as chaves API dos segredos do Atlas Kubernetes Operator.

Você também pode editar a especificação do recurso personalizado do AtlasProject para configurar as seguintes opções:

Se você remover o recurso AtlasProject do seu cluster Kubernetes, o Atlas Kubernetes Operator removerá o projeto do Atlas. Antes, é necessário remover todos os clusters do projeto. Caso contrário, o Atlas rejeita a solicitação de exclusão.

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject :

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test project
connectionSecretRef:
name: my-atlas-key
projectIpAccessList:
- cidrBlock: "203.0.113.0/24"
comment: "CIDR block for Application Server B - D"

O exemplo a seguir mostra uma especificação de recurso personalizada AtlasProject que se integra ao Prometheus:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: TestPrometheusIntegration
connectionSecretRef:
name: my-atlas-key
projectIpAccessList:
- cidrBlock: "0.0.0.0/1"
comment: "Everyone has access. For test purposes only."
- cidrBlock: "128.0.0.0/1"
comment: "Everyone has access. For test purposes only."
integrations:
- type: "PROMETHEUS"
enabled: "true"
username: "prometheus-user"
passwordRef:
name: "password-name"
namespace: "password-namespace"
scheme: "http"
serviceDiscovery: "http"

Para saber mais, consulte Integração com serviços de terceiros.

Observação

Atlas Kubernetes Operator oferece um exemplo de dashboard do Grafana que você pode importar para o Grafana.

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que fornece ao green-leaf-team a função Organization Owner para esse projeto. Os membros da equipe são definidos no recurso personalizado do AtlasTeam.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test project
teams:
- teamRef:
name: green-leaf-team
roles:
- ORGANIZATION_OWNER

Para saber mais, consulte Configurar equipes.

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que define a janela de manutenção para as 5h todas as terças-feiras com o adiamento automático desabilitado:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test project
projectIpAccessList:
- ipAddress: "192.0.2.15"
comment: "IP address for Application Server A"
maintenanceWindow:
dayOfWeek: 3
hourOfDay: 5
autoDefer: false

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que desabilita a coleta de estatísticas do banco de dados em métricas de cluster, explorador de dados, Performance Advisor de desempenho, Painel de desempenho em tempo real e Consultor de esquema.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test project
projectIpAccessList:
- ipAddress: "192.0.2.15"
comment: "IP address for Application Server A"
settings:
isCollectDatabaseSpecificsStatisticsEnabled: false
isDataExplorerEnabled: false
isExtendedStorageSizesEnabled: false
isPerformanceAdvisorEnabled: false
isRealtimePerformancePanelEnabled: false
isSchemaAdvisorEnabled: false

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que configura um alerta Atlas Triggers se a oplog window atingir menos de uma hora:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test Atlas Operator Project
connectionSecretRef:
name: my-atlas-key
alertConfigurations:
- eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
enabled: true,
notifications:
- delayMin: 0
emailEnabled: true
intervalMin: 60
roles: [ "GROUP_OWNER" ]
smsEnabled: false
typeName: "GROUP"
threshold:
operator: "LESS_THAN",
threshold: "1",
units: "HOURS"
alertConfigurationSyncEnabled: true
withDefaultAlertsSettings: false

O exemplo abaixo mostra uma especificação de recurso personalizada AtlasProject que configura um alerta que envia notificações pelo Slack:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
name: my-project
spec:
name: Test Atlas Operator Project
connectionSecretRef:
name: my-atlas-key
alertConfigurations:
- eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
enabled: true
notifications:
- delayMin: 0
emailEnabled: true
intervalMin: 60
roles: [ "GROUP_OWNER" ]
smsEnabled: false
- typeName: "SLACK"
apiTokenRef:
name: key-name
namespace: key-namespace
threshold:
operator: "LESS_THAN"
threshold: "1"
units: "HOURS"
alertConfigurationSyncEnabled: true
withDefaultAlertsSettings: false

AtlasProject é o esquema para a API de atlasprojects

Name
Tipo
Descrição
Obrigatório

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasProject

true

metadata

objeto

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

true

spec

objeto

AtlasProjectSpec define o estado alvo do projeto no Atlas

false

status

objeto

AtlasProjectStatus define o estado observado de AtlasProject

false

AtlasProjectSpec define o estado de destino do projeto no Atlas

Name
Tipo
Descrição
Obrigatório

name

string

O Nome é o name do projeto que é criado no Atlas pelo operador se ainda não existir. O comprimento de name não deve exceder 64 caracteres. O name deve conter somente letras, números, espaços, traços e sublinhados. Validações:

  • self == oldSelf: O nome não pode ser modificado após a criação do projeto

true

alertConfigurationSyncEnabled

booleano

AlertConfigurationSyncEnabled é um sinalizador que ativa/desativa a sincronização de configurações de alerta para o projeto atual. Se verdadeiro - as configurações de alerta do projeto serão sincronizadas de acordo com AlertConfigurations. Caso contrário, as configurações de alerta não serão modificadas pelo operador. Eles podem ser gerenciados através do API, CLI e UI.

false

alertConfigurations

[] objeto

AlertConfiguration é uma lista de configurações de alerta configuradas para o projeto atual. Se você utilizar esta configuração, você também deverá definir spec.''alertConfigurationSyncEnabled'' como true para o Atlas Kubernetes Operator modificar as configurações de alerta do projeto. Se você omitir ou deixar esta configuração vazia, o Atlas Kubernetes Operator não alterará as configurações de alerta do projeto. Ao criar um projeto, o Atlas aplicará as configurações de alerta de projeto padrão.

false

auditing

objeto

Auditoria representa MongoDB Janelas de Manutenção.

false

backupCompliancePolicyRef

objeto

BackupCompliancePolicyRef é uma referência ao recurso personalizado de conformidade de backup.

false

cloudProviderAccessRoles

[] objeto

CloudProviderAccessRoles é uma lista de funções de acesso do fornecedor de nuvem configuradas para o projeto atual. Obsoleto: esta configuração foi descontinuada em favor de CloudProviderIntegrations

false

cloudProviderIntegrations

[] objeto

CloudProviderIntegrations é uma lista de integrações com fornecedores de nuvem configurados para o projeto atual.

false

connectionSecretRef

objeto

ConnectionSecret é o nome do secret do Kubernetes que contém as informações sobre a forma de se conectar ao Atlas (organização ID, API chaves). A configuração padrão da conexão do operador será usada se não for fornecida.

false

customRoles

[] objeto

CustomRoles permite criar e alterar funções personalizadas em seu cluster. Utilize funções personalizadas para especificar conjuntos personalizados de ações que as funções integradas do Atlas não conseguem descrever. Obsoleto: migrar para o recurso personalizado AtlasCustomRoles de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

encryptionAtRest

objeto

EncryptionAtRest permite definir criptografia para provedores do AWS, Azure e GCP.

false

integrations

[] objeto

Integrações é uma lista de MongoDB Atlas integrations para o projeto. Obsoleto: migrar para o recurso personalizado AtlasThirdPartyIntegration de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

maintenanceWindow

objeto

MaintenanceWindow permite especificar um horário preferencial da semana para executar operações de manutenção. Veja mais informações em https://www.mongodb.com/pt-br/docs/atlas/reference/api/maintenance-windows/

false

networkPeers

[] objeto

NetworkPeers é uma lista de peers de rede configurados para o projeto atual. Obsoleto: Migre para os recursos personalizados AtlasNetworkPeering e AtlasNetworkContainer de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

privateEndpoints

[] objeto

PrivateEndpoints é uma lista de pontos de extremidade privados configurados para o projeto atual. Obsoleto: migrar para o AtlasPrivateEndpoint recurso personalizado de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

projectIpAccessList

[] objeto

ProjectIPAccessList permite o uso da lista de acesso IP para um projeto. Veja mais informações em https://mongodb.com/pt-br/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migrar para o AtlasIPAccessList Recurso Personalizado de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

regionUsageRestrictions

enum

RegionUsageRestrictions designe a região AWS do projeto ao usar o Atlas for Government. Este parâmetro não deve ser utilizado com Atlas comercial. No Atlas para governo, não configurar este campo (padrão para NONE) significa que o projeto está restrito a COMMERCIAL_FEDRAMP_REGIONS_ONLY. enumeração: NONE, GOV_REGIONS_ONLY, COMMERCIAL_FEDRAMP_REGIONS_ONLY padrão: NONE

false

settings

objeto

Configurações permite definir as Configurações do projeto.

false

teams

[] objeto

As equipes permitem que você conceda funções de acesso ao projeto a vários usuários.

false

withDefaultAlertsSettings

booleano

Sinalizador que indica se o Atlas Kubernetes Operator cria um projeto com as configurações de alerta padrão. Se você utilizar esta configuração, você também deverá definir spec.''alertConfigurationSyncEnabled'' como true para o Atlas Kubernetes Operator modificar as configurações de alerta do projeto. Se você definir esse parâmetro como falso ao criar um projeto, o Atlas não adicionará as configurações de alerta padrão ao seu projeto. Esta configuração não tem efeito sobre projetos existentes. Padrão: true

false

x509CertRef

objeto

X509CertRef é uma referência ao Kubernetes Secret que contém o certificado PEMcodificado em CA. O Atlas Kubernetes Operator observa segredos apenas com o rótulo atlas.mongodb.com/type=credentials para evitar assistir a segredos desnecessários.

false

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Se omitido, a configuração será desabilitada.

false

eventTypeName

string

O tipo de evento que trigger um alerta.

false

matchers

[] objeto

Você pode filtrar usando a array matchers somente quando o EventTypeName especifica um evento para um host, conjunto de réplicas ou cluster fragmentado.

false

metricThreshold

objeto

MetricThreshold faz com que um alerta seja acionado.

false

notifications

[] objeto

As notificações estão sendo enviadas quando uma condição de alerta é detectada.

false

severityOverride

enum

SeverityOverride opcionalmente, substitui o nível de gravidade padrão de um alerta. enumeração: INFO, WARNING, ERROR, CRITICAL

false

threshold

objeto

O limite faz com que um alerta seja acionado.

false

Name
Tipo
Descrição
Obrigatório

fieldName

string

Nome do campo no objeto de destino a ser correspondido.

false

operator

string

O operator para testar o valor do campo.

false

value

string

Valor para testar com o operador especificado.

false

MetricThreshold faz com que um alerta seja acionado.

Name
Tipo
Descrição
Obrigatório

threshold

string

Valor limite fora do qual um alerta será acionado.

true

metricName

string

Nome da métrica a ser verificada.

false

mode

string

Isso deve ser definido como AVERAGE. O Atlas calcula o valor da métrica atual como uma média.

false

operator

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite.

false

units

string

O units para o valor limite.

false

Name
Tipo
Descrição
Obrigatório

apiTokenRef

objeto

Segredo contendo um token Slack API ou token de Bot. Preenchido para o tipo de notificações do SLACK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

channelName

string

Nome do canal do Slack. Preenchido para o tipo de notificações do SLACK.

false

datadogAPIKeyRef

objeto

Segredo contendo uma chave Datadog API. Encontrado no painel do Datadog. Preenchido para o tipo de notificações do DATADOG.

false

datadogRegion

string

Região que indica qual API URL usar.

false

delayMin

inteiro

Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação.

false

emailAddress

string

Endereço de e-mail para o qual as notificações de alerta são enviadas. Preenchido para o tipo de notificações do EMAIL.

false

emailEnabled

booleano

Sinalizador que indica se notificações por e-mail devem ser enviadas. Preenchido para tipos de notificações do ORG, GROUP e USER.

false

flowName

string

Nome do fluxo Flowdock em letras minúsculas.

false

flowdockApiTokenRef

objeto

O token Flowdock API pessoal. Preenchido para o tipo de notificações do FLOWDOCK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

intervalMin

inteiro

Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.

false

mobileNumber

string

Número de celular para o qual notificações de alerta são enviadas. Preenchido para o tipo de notificações do SMS.

false

opsGenieApiKeyRef

objeto

OpsGenie API Chave. Preenchido para o tipo de notificações do OPS_GENIE. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

opsGenieRegion

string

Região que indica qual API URL usar.

false

orgName

string

Nome da organização Flowdock em letras minúsculas. Este é o nome que aparece após http://www.flowdock.com/app/ na string URL. Preenchido para o tipo de notificações do FLOWDOCK.

false

roles

[]string

Os seguintes roles concedem privilégios dentro de um projeto.

false

serviceKeyRef

objeto

PagerDuty chave de serviço. Preenchido para o tipo de notificações do PAGER_DUTY. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

false

smsEnabled

booleano

Sinalizador que indica se as notificações de mensagem de texto devem ser enviadas. Preenchido para tipos de notificações do ORG, GROUP e USER.

false

teamId

string

Identificador único de uma equipe.

false

teamName

string

Etiqueta para a equipe que recebe esta notificação.

false

typeName

string

Tipo de notificação de alerta .

false

username

string

Nome do Atlas user para o qual enviar notificações. Somente um usuário no projeto que possui a configuração de alerta é permitido aqui. Preenchido para o tipo de notificações do USER.

false

victorOpsSecretRef

objeto

Segredo contendo uma chave VictorOps API e uma chave de roteamento. Preenchido para o tipo de notificações do VICTOR_OPS. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

false

Segredo contendo um token de API do Slack ou token de Bot. Preenchido para o tipo de notificações SLACK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Segredo contendo uma chave API Datadog. Encontrado no painel do Datadog. Preenchido para o tipo de notificações DATADOG.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

O token da API pessoal do Flowdock. Preenchido para o tipo de notificações Flowdock. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Chave API OpsGenie. Preenchido para o tipo de notificações OPS_GENIE. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Chave de serviço PagerDuty. Preenchido para o tipo de notificações PAGER_DUTY. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Segredo contendo uma chave de API VictorOps e uma chave de roteamento. Preenchido para o tipo de notificações VICTOR_OPS. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

O limite faz com que um alerta seja acionado.

Name
Tipo
Descrição
Obrigatório

operator

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. Aceita os seguintes valores: GREATER_THAN, LESS_THAN.

false

threshold

string

Valor limite fora do qual um alerta será acionado.

false

units

string

O units para o valor limite.

false

Auditar representa as janelas de manutenção do MongoDB Windows.

Name
Tipo
Descrição
Obrigatório

auditAuthorizationSuccess

booleano

Indica se o sistema de auditoria captura tentativas de autenticação bem-sucedidas para filtros de auditar usando o evento de auditoria "atype" : "authCheck". Para mais informações, consulte auditAuthorizationSuccess.

false

auditFilter

string

JSONfiltro de formato auditar usado pelo projeto.

false

enabled

booleano

Indica se o projeto associado ao {GROUP-ID} tem a auditoria de banco de dados habilitada.

false

BackupCompliancePolicyRef é uma referência ao recurso personalizado de compliance de backup.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

CloudProviderAccessRole define uma integração com um provedor de nuvem DEPrecated: este tipo é preterido em favor do CloudProviderIntegration

Name
Tipo
Descrição
Obrigatório

providerName

string

ProviderName é o nome do provedor de nuvem. Atualmente, apenas AWS é suportado.

true

iamAssumedRoleArn

string

IamAssumedRoleArn é o ARN da função IAM que é assumida pelo Atlas cluster.

false

CloudProviderIntegration define uma integração com um provedor de nuvem

Name
Tipo
Descrição
Obrigatório

providerName

string

ProviderName é o nome do provedor de nuvem. Atualmente, apenas AWS é suportado.

true

iamAssumedRoleArn

string

IamAssumedRoleArn é o ARN da função IAM que é assumida pelo Atlas cluster.

false

ConnectionSecret é o nome do secret do Kubernetes que contém as informações sobre a forma de se conectar ao Atlas (ID da organização, chaves de API). A configuração padrão da conexão do operador será usada se não for fornecida.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

CustomRole permite criar e alterar um função personalizada em seu cluster. Utilize funções personalizadas para especificar conjuntos personalizados de ações que as funções integradas do Atlas não conseguem descrever. Obsoleto: Migrar para o recurso personalizado AtlasCustomRoles de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ek8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

name

string

Etiqueta legível por humanos que identifica a função. Este name deve ser exclusivo para esta função personalizada neste projeto.

true

actions

[] objeto

Lista do privilégio individual actions que a função concede.

false

inheritedRoles

[] objeto

Lista das funções incorporadas que esta função personalizada herda.

false

Name
Tipo
Descrição
Obrigatório

name

string

Etiqueta legível por humanos que identifica a ação do privilégio.

true

resources

[] objeto

Lista de resources nos quais você concede a ação.

true

Name
Tipo
Descrição
Obrigatório

cluster

booleano

Sinalizador que indica se a ação deve ser concedida no recurso cluster. Se verdadeiro, o MongoDB Nuvem ignora os parâmetros do Banco de Dados e da Coleção.

false

collection

string

Etiqueta legível por humanos que identifica o collection no qual você concede a ação a um usuário MongoDB .

false

database

string

Etiqueta legível por humanos que identifica o database no qual você concede a ação a um usuário MongoDB .

false

Name
Tipo
Descrição
Obrigatório

database

string

Etiqueta legível por humanos que identifica o database no qual alguém concede a ação a um usuário MongoDB .

true

name

string

Etiqueta legível por humanos que identifica a função herdada.

true

EncryptionAtRest permite definir a criptografia para provedores da AWS, do Azure e do GCP.

Name
Tipo
Descrição
Obrigatório

awsKms

objeto

AwsKms especifica os detalhes de configuração AWS KMS e se a criptografia em descanso está ativada para um projeto Atlas.

false

azureKeyVault

objeto

AzureKeyVault especifica os detalhes de configuração do Azure Key Vault e se a criptografia em descanso está habilitada para um projeto do Atlas.

false

googleCloudKms

objeto

GoogleCloudKms especifica os detalhes de configuração GCP KMS e se a criptografia em descanso está ativada para um projeto Atlas.

false

O AwsKms especifica os detalhes de configuração do AWS KMS e se a criptografia em descanso está habilitada para um projeto do Atlas.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Especifica se a criptografia em descanso é enabled para um projeto Atlas. Para desabilitar a criptografia em descanso, passe apenas este parâmetro com um valor de falso. Quando você desabilita a criptografia em descanso, o Atlas também remove os detalhes de configuração.

false

region

string

O AWS region no qual a chave mestra do cliente AWS existe.

false

secretRef

objeto

Uma referência como Secret contendo os campos AccessKeyID, SecretAccessKey, CustomerMasterKeyID e RoleID

false

valid

booleano

Especifica se a chave de criptografia definida para o provedor é valid e pode ser usada para criptografar e descriptografar dados.

false

Uma referência como Secret contendo os campos AccessKeyID, SecretAccessKey, CustomerMasterKeyID e RoleID

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

AzureKeyVault especifica os detalhes de configuração do Azure Key Vault e se a criptografia em descanso está habilitada para um projeto do Atlas.

Name
Tipo
Descrição
Obrigatório

azureEnvironment

string

O ambiente Azure onde residem as credenciais da conta Azure. Os valores válidos são os seguintes: AZURE, AZURE_CHINA, AZURE_GERMANY

false

clientID

string

O cliente ID, também conhecido como aplicativo ID, para um aplicativo Azure associado ao locatário Azure AD.

false

enabled

booleano

Especifica se a criptografia em descanso é enabled para um projeto Atlas. Para desabilitar a criptografia em descanso, passe apenas este parâmetro com um valor de falso. Quando você desabilita a criptografia em descanso, o Atlas também remove os detalhes de configuração.

false

resourceGroupName

string

O nome do grupo de recursos do Azure que contém um Azure Key Vault.

false

secretRef

objeto

Uma referência a como Secret contendo os campos SubscriptionID, KeyVaultName, KeyIdentifier, Secret

false

tenantID

string

O identificador exclusivo para um locatário do Azure AD dentro de uma assinatura do Azure.

false

Uma referência como Segredo contendo os campos SubscriptionID, KeyVaultName, KeyIdentifier, Segredo

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

O GoogleCloudKms especifica os detalhes de configuração do GCP KMS e se a criptografia em descanso está ativada para um projeto do Atlas.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Especifica se a criptografia em descanso é enabled para um projeto Atlas. Para desabilitar a criptografia em descanso, passe apenas este parâmetro com um valor de falso. Quando você desabilita a criptografia em descanso, o Atlas também remove os detalhes de configuração.

false

secretRef

objeto

Uma referência a como Secret contendo os campos ServiceAccountKey, KeyVersionResourceID

false

Uma referência a como Secret contendo os campos ServiceAccountKey, KeyVersionResourceID

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Integração para o projeto entre Atlas e um serviço de terceiros. Obsoleto: Migre para o recurso personalizado AtlasThirdPartyIntegration de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

accountId

string

Sequência exclusiva de 40dígitos hexadecimais que identifica sua conta New Relic.

false

apiKeyRef

objeto

Referência a um secret do Kubernetes contendo sua chave API para Datadog, OpsGenie ou Victor Ops.

false

apiTokenRef

objeto

Referência a um secret do Kubernetes contendo a chave que permite ao Atlas acessar sua conta do Slack.

false

channelName

string

Nome do canal do Slack para o qual o Atlas envia notificações de alerta.

false

enabled

booleano

Sinalizador que indica se alguém ativou a integração Prometeus.

false

flowName

string

DEPRECATED: Nome do fluxo Flowdock. Este campo foi removido do Atlas e não tem efeito.

false

licenseKeyRef

objeto

Referência a um Kubernetes Secret contendo sua string única de 40dígitos hexadecimais que identifica sua licença do New Relic.

false

microsoftTeamsWebhookUrl

string

Endereço web de ponto de extremidade do webhook do Microsoft Teams para o qual o Atlas envia notificações.

false

name

string

false

orgName

string

DEPRECATED: nome da organização Flowdock. Este campo foi removido do Atlas e não tem efeito.

false

passwordRef

objeto

Referência a um secret do Kubernetes contendo a senha para permitir que o Atlas acesse sua conta Prometheus.

false

readTokenRef

objeto

Referência a um secret do Kubernetes contendo a chave de query associada à sua conta New Relic.

false

region

string

Código de região que indica qual API regional o Atlas usa para acessar PagerDuty, Datadog ou OpsGenie.

false

routingKeyRef

objeto

Referência a um secret do Kubernetes contendo a chave de roteamento associada à sua conta Splunk On-Call. Usado para Victor Ops.

false

scheme

string

false

secretRef

objeto

Referência a um secret do Kubernetes que contém o segredo do seu webhook.

false

serviceDiscovery

string

Método desejado para descobrir o serviço Prometheus.

false

serviceKeyRef

objeto

Referência a um Kubernetes Secret contendo a chave de serviço associada à sua conta PagerDuty.

false

teamName

string

Etiqueta legível por humanos que identifica sua equipe do Slack .

false

type

enum

Integração de terceiros type, como Slack, New Relic etc. Cada integração type requer um conjunto distinto de campos de configuração. Por exemplo, se você definir type como DATADOG, deverá configurar somente os subcampos datadog. enumeração: PAGER_DUTY, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, FLOWDOCK, WEBHOOK, MICROSOFT_TEAMS, PROMETHEUS

false

url

string

Endereço web do ponto de extremidade para o qual o Atlas envia notificações. Usado para webhooks.

false

username

string

Etiqueta legível por humanos que identifica o webhook de entrada do Prometheus.

false

writeTokenRef

objeto

Referência a um secret do Kubernetes contendo a chave de inserção associada à sua conta New Relic.

false

Referência a um secret do Kubernetes contendo sua chave de API para Datadog, OpsGenie ou Victor Ops.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a chave que permite ao Atlas acessar sua conta do Slack.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um Kubernetes Secret contendo sua string única de 40dígitos hexadecimais que identifica sua licença do New Relic.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a senha para permitir que o Atlas acesse sua conta Prometheus.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a chave de query associada à sua conta New Relic.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a chave de roteamento associada à sua conta Splunk On-Call. Usado para Victor Ops.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes que contém o segredo do seu webhook.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a chave de serviço associada à sua conta PagerDuty.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Referência a um secret do Kubernetes contendo a chave de inserção associada à sua conta New Relic.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

O maintenanceWindow permite especificar um horário preferencial na semana para executar operações de manutenção. Veja mais informações em https://www.mongodb.com/pt-br/docs/atlas/reference/api/maintenance-windows/

Name
Tipo
Descrição
Obrigatório

autoDefer

booleano

Sinalizador que indica se qualquer manutenção de projeto agendada deve ser adiada automaticamente por uma semana.

false

dayOfWeek

inteiro

Dia da semana em que você gostaria que a período de manutenção começasse como um número inteiro baseado em 1. 1Domingo,2 3 4 5 6 7segunda-feira, ter- Mínimo: 1 Máximo: 7

false

defer

booleano

Sinalizador que indica se a próxima manutenção de projeto agendada deve ser adiada por uma semana. Não é possível especificar se startASAP for verdadeiro

false

hourOfDay

inteiro

Hora do dia em que você gostaria que a período de manutenção começasse. Este parâmetro utiliza o relógio de 24horas, em que meia-noite é 0 e meio-dia é 12. Mínimo: 0 Máximo: 23

false

startASAP

booleano

Sinalizador que indica se a manutenção do projeto foi direcionada para iniciar imediatamente. Não é possível especificar se adiar é verdadeiro

false

NetworkPeer configurado para o Projeto atual. Obsoleto: migrar para os recursos personalizados AtlasNetworkPeering e AtlasNetworkContainer de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

accepterRegionName

string

AccepterRegionName é o nome da região do provedor do VPC do usuário.

false

atlasCidrBlock

string

Atlas CIDR. Precisa ser definido se ContainerID não estiver definido.

false

awsAccountId

string

AccountID do VPC do usuário.

false

azureDirectoryId

string

AzureDirectoryID é o identificador exclusivo de um diretório Azure AD.

false

azureSubscriptionId

string

AzureSubscriptionID é o identificador exclusivo da assinatura do Azure na qual a VNet reside.

false

containerId

string

ID do contêiner de emparelhamento de rede. Se não for definido, o operador criará um novo contêiner com ContainerRegion e AtlasCIDRBlock entrada.

false

containerRegion

string

ContainerRegion é o nome da região do provedor do contêiner de emparelhamento da rede Atlas. Se não estiver definido, AccepterRegionName será usado.

false

gcpProjectId

string

Usuário GCP Projeto ID. É aplicável apenas para GCP.

false

networkName

string

GCP Nome do emparelhamento de rede. É aplicável apenas para GCP.

false

providerName

string

ProviderName é o nome do provedor. Se não for definido, será definido como "AWS".

false

resourceGroupName

string

ResourceGroupName é o nome do seu grupo de recursos do Azure.

false

routeTableCidrBlock

string

Usuário VPC CIDR.

false

vnetName

string

VNetName é o nome da sua VNet do Azure. É aplicável apenas ao Azure.

false

vpcId

string

AWS VPC ID.

false

Ponto de extremidade privado é uma lista de pontos de extremidade privados configurados para o projeto atual. Obsoleto: migrar para o recurso personalizado AtlasPrivateEndpoint de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

provider

enum

Nuvem provider para a qual você deseja recuperar pontos de extremidade privados. O Atlas aceita AWS, GCP ou AZURE. enumeração: AWS, GCP, AZURE, TENANT

true

region

string

Provedor de nuvem region para o qual você deseja criar o serviço de pontos de extremidade privados.

true

endpointGroupName

string

Identificador único do grupo de pontos de extremidade. O grupo de pontos de extremidade engloba todos os pontos de extremidade que você criou no Google Cloud.

false

endpoints

[] objeto

Coleção de endpoints privados individuais que compõem seu grupo de pontos de extremidade.

false

gcpProjectId

string

Identificador exclusivo do projeto do Google Cloud no qual você criou seus pontos de extremidade.

false

id

string

Identificador exclusivo do ponto de extremidade privado que você criou em sua AWS VPC ou na VNet do Azure.

false

ip

string

Endereço IP privado da interface de rede de pontos de extremidade privados que você criou em sua VNet do Azure.

false

Name
Tipo
Descrição
Obrigatório

endpointName

string

Regra de encaminhamento que corresponde ao ponto de extremidade que você criou no Google Cloud.

false

ipAddress

string

Endereço IP privado do ponto de extremidade que você criou no Google Cloud.

false

IPAccessList permite o uso da lista de acesso IP para um projeto. Veja mais informações em https://mongodb.com/pt-br/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migre para o recurso personalizado AtlasIPAccessList de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

awsSecurityGroup

string

Identificador exclusivo do grupo de segurança AWS nesta entrada da lista de acesso.

false

cidrBlock

string

Faixa de endereços IP em notação CIDR nesta entrada de lista de acesso.

false

comment

string

Comentário associado a esta entrada da lista de acesso.

false

deleteAfterDate

string

Registro de data/hora em ISO 8601 formato de data e hora em UTC após o qual o Atlas exclui a entrada temporária da lista de acesso.

false

ipAddress

string

Entrada usando um endereço IP nesta entrada da lista de acesso.

false

Configurações permite definir as Configurações do projeto.

Name
Tipo
Descrição
Obrigatório

isCollectDatabaseSpecificsStatisticsEnabled

booleano

Sinalizador que indica se é necessário coletar métricas específicas do banco de dados para o projeto especificado.

false

isDataExplorerEnabled

booleano

Sinalizador que indica se o Data Explorer deve ser ativado para o projeto especificado.

false

isExtendedStorageSizesEnabled

booleano

Sinalizador que indica se os tamanhos de armazenamento estendidos devem ser habilitados para o projeto especificado.

false

isPerformanceAdvisorEnabled

booleano

Sinalizador que indica se o Performance Advisor e o Profiler devem ser habilitados para o projeto especificado.

false

isRealtimePerformancePanelEnabled

booleano

Sinalizador que indica se deseja ativar o Real-Time Performance Panel para o projeto especificado.

false

isSchemaAdvisorEnabled

booleano

Sinalizador que indica se o Schema Advisor deve ser ativado para o projeto especificado.

false

Name
Tipo
Descrição
Obrigatório

roles

[]enum

Funções que os usuários da equipe têm dentro do projeto. enumeração: GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY

true

teamRef

objeto

Referência ao recurso personalizado AtlasTeam que será atribuído ao projeto.

true

Referência ao recurso personalizado do AtlasTeam que será atribuído ao projeto.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

X509CertRef é uma referência ao Kubernetes Secret que contém o certificado CA codificado por PEM. O Atlas Kubernetes Operator observa segredos apenas com o rótulo atlas.mongodb.com/type=credentials para evitar assistir a segredos desnecessários.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

AtlasProjectStatus define o estado observado do AtlasProject

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

alertConfigurations

[] objeto

AlertConfigurations contém uma lista de status de configuração de alerta

false

authModes

[]string

AuthModes contém uma lista de modos de autenticação configurados "SCRAM" é o método de autenticação padrão e requer uma senha para cada usuário "X509" significa que a autenticação X.509 autogerenciada está configurada

false

cloudProviderIntegrations

[] objeto

CloudProviderIntegrations contém uma lista de funções de acesso do provedor de nuvem configurados. Somente suporte AWS

false

customRoles

[] objeto

CustomRoles contém uma lista de status de funções personalizadas

false

expiredIpAccessList

[] objeto

A lista de IP entradas da lista de acesso que expiraram devido a 'deleteAfterDate' ser menor que a data atual. Observe que este campo é atualizado pelo operador Atlas somente após as alterações de especificação

false

id

string

O ID do Projeto Atlas

false

networkPeers

[] objeto

A lista de emparelhamento de rede configurados para o projeto atual

false

observedGeneration

inteiro

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

false

privateEndpoints

[] objeto

A lista de pontos de extremidade privados configurados para o projeto atual

false

prometheus

objeto

Prometheus contém o status da integração de Prometheus, incluindo o prometheusDiscoveryURL

false

teams

[] objeto

As equipes contêm uma lista de status de tarefa do teams

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 recurso.

true

lastTransitionTime

string

Última vez que a condição fez a transição de um status para outro. Representado no formato ISO 8601. 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

Name
Tipo
Descrição
Obrigatório

acknowledgedUntil

string

A data até a qual o alerta foi reconhecido. Não estará presente se o alerta nunca tiver sido reconhecido.

false

acknowledgementComment

string

O comentário deixado pelo usuário que reconheceu o alerta. Não estará presente se o alerta nunca tiver sido reconhecido.

false

acknowledgingUsername

string

O nome de usuário que reconheceu o alerta. Não estará presente se o alerta nunca tiver sido reconhecido.

false

alertConfigId

string

ID da configuração de alerta que acionou este alerta.

false

clusterId

string

O ID do cluster ao qual este alerta se aplica. Presente somente para alertas do tipo BACKUP, REPLICA_SET e CLUSTER.

false

clusterName

string

O nome do cluster ao qual esse alerta se aplica. Presente apenas para alertas do tipo BACKUP, REPLICA_SET e CLUSTER.

false

created

string

Registro de data/hora no formato de data e hora ISO 8601 no UTC quando esta configuração de alerta foi criada.

false

currentValue

objeto

CurrentValue representa o valor atual da métrica que acionou o alerta. Presente apenas para alertas do tipo HOST_METRIC.

false

enabled

booleano

Se omitido, a configuração será desabilitada.

false

errorMessage

string

ErrorMessage é massagamento se a configuração de alerta estiver em um estado incorreto.

false

eventTypeName

string

O tipo de evento que trigger um alerta.

false

groupId

string

Identificador único do projeto que possui esta configuração de alerta .

false

hostId

string

ID do hospedar ao qual a métrica pertence. Presente apenas para alertas do tipo HOST, HOST_METRIC e REPLICA_SET.

false

hostnameAndPort

string

O nome do host e a porta de cada host ao qual o alerta se aplica. Presente apenas para alertas do tipo HOST, HOST_METRIC e REPLICA_SET.

false

id

string

Identificador único.

false

lastNotified

string

Quando a última notificação foi enviada para este alerta. Presente somente se notificações tiverem sido enviadas.

false

matchers

[] objeto

Você pode filtrar usando a array matchers somente quando o EventTypeName especifica um evento para um host, conjunto de réplicas ou cluster fragmentado.

false

metricName

string

O nome da medida cujo valor ultrapassou o limite. Somente presente se eventTypeName estiver definido como OUTSIDE_METRIC_THRESHOLD.

false

metricThreshold

objeto

MetricThreshold faz com que um alerta seja acionado.

false

notifications

[] objeto

As notificações estão sendo enviadas quando uma condição de alerta é detectada.

false

replicaSetName

string

Nome do conjunto de réplicas. Presente somente para alertas do tipo HOST, HOST_METRIC, BACKUP e REPLICA_SET.

false

resolved

string

Quando o alerta foi fechado. Presente apenas se o status for CLOSED.

false

severityOverride

string

Gravidade do alerta.

false

sourceTypeName

string

Para alertas do tipo BACKUP, o tipo de servidor que está sendo copiado.

false

status

string

O estado atual do alerta. Os valores possíveis são: TRACKING, OPEN, CLOSED, CANCELED

false

threshold

objeto

O limite faz com que um alerta seja acionado.

false

updated

string

Registro de data/hora no formato de data e hora ISO 8601 no UTC quando esta configuração de alerta foi atualizada pela última vez.

false

CurrentValue representa o valor atual da métrica que acionou o alerta. Presente apenas para alertas do tipo HOST_METRIC.

Name
Tipo
Descrição
Obrigatório

number

string

O valor da métrica.

false

units

string

O units pelo valor. Depende do tipo de métrica.

false

Name
Tipo
Descrição
Obrigatório

fieldName

string

Nome do campo no objeto de destino a ser correspondido.

false

operator

string

O operator para testar o valor do campo.

false

value

string

Valor para testar com o operador especificado.

false

MetricThreshold faz com que um alerta seja acionado.

Name
Tipo
Descrição
Obrigatório

threshold

string

Valor limite fora do qual um alerta será acionado.

true

metricName

string

Nome da métrica a ser verificada.

false

mode

string

Isso deve ser definido como AVERAGE. O Atlas calcula o valor da métrica atual como uma média.

false

operator

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite.

false

units

string

O units para o valor limite.

false

Name
Tipo
Descrição
Obrigatório

apiToken

string

Token Slack API ou token de Bot. Preenchido para o tipo de notificações do SLACK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

channelName

string

Nome do canal do Slack. Preenchido para o tipo de notificações do SLACK.

false

datadogApiKey

string

Chave Datadog API. Encontrado no painel do Datadog. Preenchido para o tipo de notificações do DATADOG.

false

datadogRegion

string

Região que indica qual API URL usar

false

delayMin

inteiro

Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação.

false

emailAddress

string

Endereço de e-mail para o qual as notificações de alerta são enviadas. Preenchido para o tipo de notificações do EMAIL.

false

emailEnabled

booleano

Sinalizador que indica se notificações por e-mail devem ser enviadas. Preenchido para tipos de notificações do ORG, GROUP e USER.

false

flowName

string

Nome do fluxo do Flowdock em letras minúsculas.

false

flowdockApiToken

string

O token Flowdock API pessoal. Preenchido para o tipo de notificações do FLOWDOCK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

intervalMin

inteiro

Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos.

false

mobileNumber

string

Número de celular para o qual notificações de alerta são enviadas. Preenchido para o tipo de notificações do SMS.

false

opsGenieApiKey

string

Chave Opsgenie API. Preenchido para o tipo de notificações do OPS_GENIE. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.

false

opsGenieRegion

string

Região que indica qual API URL usar.

false

orgName

string

Nome da organização Flowdock em letras minúsculas. Este é o nome que aparece após http://www.flowdock.com/app/ na string URL. Preenchido para o tipo de notificações do FLOWDOCK.

false

roles

[]string

Os seguintes roles concedem privilégios dentro de um projeto.

false

serviceKey

string

PagerDuty chave de serviço. Preenchido para o tipo de notificações do PAGER_DUTY. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

false

smsEnabled

booleano

Sinalizador que indica se as notificações de mensagem de texto devem ser enviadas. Preenchido para tipos de notificações do ORG, GROUP e USER.

false

teamId

string

Identificador único de uma equipe.

false

teamName

string

Etiqueta para a equipe que recebe esta notificação.

false

typeName

string

Tipo de notificação de alerta .

false

username

string

Nome do Atlas user para o qual enviar notificações. Somente um usuário no projeto que possui a configuração de alerta é permitido aqui. Preenchido para o tipo de notificações do USER.

false

victorOpsApiKey

string

VictorOps API chave. Preenchido para o tipo de notificações do VICTOR_OPS. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

false

victorOpsRoutingKey

string

VictorOps chave de roteamento. Preenchido para o tipo de notificações do VICTOR_OPS. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.

false

O limite faz com que um alerta seja acionado.

Name
Tipo
Descrição
Obrigatório

operator

string

Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. aceita os seguintes valores: GREATER_THAN, LESS_THAN

false

threshold

string

Valor limite fora do qual um alerta será acionado.

false

units

string

O units para o valor limite

false

Name
Tipo
Descrição
Obrigatório

atlasAssumedRoleExternalId

string

ID externo exclusivo que o MongoDB Atlas usa quando assume a função IAM em sua conta da Amazon Web Services.

true

providerName

string

Rótulo legível por humanos que identifica o fornecedor de nuvem da função.

true

atlasAWSAccountArn

string

Amazon Recurso que identifica a conta de usuário do Amazon Web Services que o MongoDB Atlas utiliza quando assume a função de Gerenciamento de Identidade e Acesso.

false

authorizedDate

string

Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

false

createdDate

string

Data e hora em que alguém criou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

false

errorMessage

string

Mensagem de erro do aplicativo retornada.

false

featureUsages

[] objeto

Lista que contém recursos do aplicativo associados a essa função do Amazon Web Services Identity and Access Management.

false

iamAssumedRoleArn

string

Nome do recurso da Amazon que identifica a função de gerenciamento de acesso e identidade do Amazon Web Services que o MongoDB nuvem assume quando acessa recursos em sua conta do AWS.

false

roleId

string

String única de 24 dígitos hexadecimais que identifica a role.

false

status

string

Provisionamento status da conta de serviço. Os valores são IN_PROGRESS, COMPLETE, FAILED ou NOT_INITIATED.

false

Name
Tipo
Descrição
Obrigatório

featureId

string

Identificar características do data lake vinculado a essa função do Amazon Web Services Gerenciamento de Identidade e Acesso.

false

featureType

string

Etiqueta legível por humanos que descreve um recurso do MongoDB nuvem vinculado a esta função do Amazon Web Services Identity and Access gerenciamento.

false

Name
Tipo
Descrição
Obrigatório

name

string

Função name que é exclusiva

true

status

string

O status da função personalizada fornecida (OK ou FAILED)

true

error

string

A mensagem quando a função personalizada está no status FAILED

false

IPAccessList permite o uso da lista de acesso IP para um projeto. Veja mais informações em https://mongodb.com/pt-br/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migre para o recurso personalizado AtlasIPAccessList de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descrição
Obrigatório

awsSecurityGroup

string

Identificador exclusivo do grupo de segurança AWS nesta entrada da lista de acesso.

false

cidrBlock

string

Faixa de endereços IP em notação CIDR nesta entrada de lista de acesso.

false

comment

string

Comentário associado a esta entrada da lista de acesso.

false

deleteAfterDate

string

Registro de data/hora em ISO 8601 formato de data e hora em UTC após o qual o Atlas exclui a entrada temporária da lista de acesso.

false

ipAddress

string

Entrada usando um endereço IP nesta entrada da lista de acesso.

false

Name
Tipo
Descrição
Obrigatório

id

string

Identificador único para NetworkPeer.

true

providerName

string

Provedor de nuvem para o qual você deseja recuperar um emparelhamento de rede.

true

region

string

Região para a qual você deseja criar o emparelhamento. Não é necessário para GCP

true

atlasGcpProjectId

string

ProjectID do contêiner Atlas. Aplicável somente para GCP. É necessário adicionar uma conexão de peering de rede.

false

atlasNetworkName

string

Nome da rede Atlas. Aplicável somente para GCP. É necessário adicionar uma conexão de peering de rede.

false

connectionId

string

Identificador único da conexão de peering de rede. Aplicável somente para AWS.

false

containerId

string

ContainerID do contêiner de emparelhamento da rede Atlas

false

errorMessage

string

Estado de erro do peer de rede. Aplicável somente para GCP.

false

errorState

string

Estado de erro do peer de rede. Aplicável apenas para Azure.

false

errorStateName

string

Estado de erro do peer de rede. Aplicável somente para AWS.

false

gcpProjectId

string

ProjectID do vpc do usuário. Aplicável somente para GCP.

false

status

string

Status do emparelhamento de rede. Aplicável apenas para GCP e Azure.

false

statusName

string

Status do emparelhamento de rede. Aplicável somente para AWS.

false

vpc

string

VPC é um campo de uso geral para armazenar o nome do VPC. VPC é vpcID para AWS, usuário networkName para GCP e vnetName para Azure.

false

Name
Tipo
Descrição
Obrigatório

provider

string

Nuvem provider para a qual você deseja recuperar pontos de extremidade privados. O Atlas aceita AWS ou AZURE.

true

region

string

Provedor de nuvem region para o qual você deseja criar o serviço de pontos de extremidade privados.

true

endpoints

[] objeto

Coleção de GCP endpoints privados individuais que compõem seu grupo de pontos de extremidade de rede.

false

id

string

Identificador exclusivo para AWS ou AZURE conexão de link privado.

false

interfaceEndpointId

string

Identificador exclusivo do AWS ou do ponto de extremidade da interface Azure Private Link.

false

serviceAttachmentNames

[]string

Strings únicas de caracteres alfanuméricos e especiais que identificam os anexos de serviço associados ao serviço de ponto de extremidade do Private Service Connect GCP.

false

serviceName

string

Nome do AWS ou Azure Private Link que o Atlas gerencia.

false

serviceResourceId

string

Identificador exclusivo do Azure Private Link (para AWS o mesmo que ID).

false

Name
Tipo
Descrição
Obrigatório

endpointName

string

Rótulo legível por humanos que identifica a regra de encaminhamento do consumidor do Google Cloud que você criou.

true

ipAddress

string

Um endereço Private Internet Protocol versão 4 (IPv4) para o qual esta regra de encaminhamento do consumidor do Google Cloud se resolve.

true

status

string

Estado do grupo de pontos de extremidade do Atlas MongoDB quando a nuvem MongoDB recebeu essa solicitação.

true

O Prometheus contém o status da integração do Prometheus, incluindo o prometheusDiscoveryURL

Name
Tipo
Descrição
Obrigatório

prometheusDiscoveryURL

string

URL do qual Prometeu obtém os alvos.

false

scheme

string

Protocolo scheme usado para solicitações de Prometheus.

false

Name
Tipo
Descrição
Obrigatório

teamRef

objeto

ResourceRefNamespaced é uma referência a um Recurso Kubernetes que permite configurar o namespace

true

id

string

false

ResourceRefNamespaced é uma referência a um Recurso do Kubernetes que permite configurar o namespace

Name
Tipo
Descrição
Obrigatório

name

string

Nome do Recurso Kubernetes

true

namespace

string

Namespace do Recurso Kubernetes

false

Voltar

Recursos personalizados

Nesta página