/ /

`AtlasProject` カスタムリソース

AtlasProjectカスタムリソースは Atlas のプロジェクトを構成します。 AtlasProjectカスタムリソースを作成すると、Atlas Kubernetes Operator は Atlas に新しいプロジェクトを作成しようとします。

重要

カスタムリソースはデフォルトでオブジェクトを削除しなくなりました

Atlas Kubernetes Operator は、カスタムリソース構成ファイルを使用して Atlas 構成を管理しますが、Atlas Kubernetes Operator2.0 以降、 Kubernetesで削除したカスタムリソースは Atlas で削除されなくなりました（デフォルトでは）。代わりに、Atlas Kubernetes Operator は Atlas 内のそれらのリソースの管理を停止します。例、AtlasProject Kubernetesでカスタムリソースを削除すると、デフォルトでは、Atlas Kubernetes Operator は Atlas から対応するプロジェクトを自動的に削除しなくなります。この動作の変更は、誤ってまたは予期せずに削除されるのを防ぐことを目的としています。この動作を Atlas Kubernetes Operator.2 0より前に使用されていたデフォルトに戻す方法などの詳細については、「新しいデフォルト: Atlas Kubernetes演算子.2 の削除保護」を参照してください。0
同様に、Atlas Kubernetes Operator を使用してKubernetesの Atlasプロジェクトからチームを削除しても、Atlas Kubernetes Operator は Atlas からチームを削除しません。

デフォルトのAtlas 構成値が暗黙的に使用されるのを避けるために、必要な構成の詳細を明示的に定義します。場合によっては、Atlas のデフォルトを継承すると調整ループが発生し、カスタムリソースがREADY 状態に達しなくなります。例、含まれている例に示すように、 AtlasDeployment カスタムリソースで必要なオートスケーリング動作を明示的に定義すると、カスタムリソース内の静的インスタンスサイズが、オートスケーリングが有効になっている Atlas 配置に繰り返し適用されないことが保証されます。

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

Atlas Kubernetes Operator は、次のいずれかのアクションを実行します。

接続シークレットによって構成される組織内に新しいプロジェクトを作成します。
既存のプロジェクトを再利用します。この場合、Atlas Kubernetes Operator は、 spec.nameを持つプロジェクトが存在するかどうかを確認します。プロジェクトが存在する場合、Atlas Kubernetes Operator は作成をスキップします。調整後、Atlas Kubernetes Operator はstatus.idフィールドをプロジェクトの ID を使用して更新します。

You can use the spec.connectionSecretRef.name parameter to set the connection secret for the AtlasProject custom resource. This parameter overrides the default global connection secret.

By default, Atlas Kubernetes Operator keeps connection secrets in the same namespace as the AtlasProject Custom Resource. To store secrets in another namespace, specify the spec.connectionSecretRef.namespace parameter.

Atlas APIに接続するために、Atlas Kubernetes Operator は Atlas Kubernetes Operator シークレットから組織IDとAPIキーを読み取ります。

また、 AtlasProjectカスタムリソース仕様を編集して、次のオプションを構成することもできます。

An IP access list with the spec.projectIpAccessList parameter. This IP access list grants network access to Atlas clusters in the project.
Teams with the spec.teams parameter. A team lets you grant an access role to an entire group of Atlas users for a particular project.
The maintenance window with the spec.maintenanceWindow parameter. The maintenance window sets the hour and day that Atlas starts weekly maintenance on your database deployments.

Network peering with the spec.networkPeers parameter. Network peering allows you to connect securely to your AWS, Azure, or Google Cloud VPC.
Encryption at rest using customer-managed keys with the spec.encryptionAtRest parameter. Encryption at rest using customer-managed keys allows you to add an additional layer of security by using your cloud provider's KMS together with the MongoDB encrypted storage engine.
Private endpoints with the spec.privateEndpoints parameter.
X.509 authentication with the spec.x509CertRef.name parameter.
Project settings with the spec.settings parameter, including settings to enable and disable the following:
- クラスターメトリクスでのデータベース統計のコレクション
- Data Explorer
- Performance Advisor
- リアルタイムパフォーマンスパネル
- スキーマアドバイザー
- Project alerts configurations with the spec.alertConfigurationSyncEnabled and spec.alertConfigurations parameters.
  これらの設定がどのように影響するかについては、「考慮事項」を参照してください。

Kubernetes クラスターからAtlasProjectリソースを削除すると、Atlas Kubernetes Operator は Atlas からプロジェクトを削除します。プロジェクト内のすべてのクラスターを削除する必要があります。それ以外の場合、Atlas は削除リクエストを拒否します。

例

次の例は、 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"

Prometheus の例

次の例は、Prometheus と統合するAtlasProjectカスタムリソース仕様を示しています。

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"

詳細については、「サードパーティサービスとの統合」を参照してください。

注意

Atlas Kubernetes Operator は、 Grafana にインポートできるサンプルGrafana ダッシュボードを提供します。

チームの例

次の例は、このプロジェクトのgreen-leaf-teamにOrganization Ownerロールを付与するAtlasProjectカスタムリソース仕様を示しています。チームメンバーは、 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

詳しくは、「チームの構成」を参照してください。

メンテナンスウィンドウの例

次の例では、自動延期を無効にして、メンテナンスウィンドウを毎週火曜日の午前 5 時 00 分に設定するAtlasProjectカスタムリソース仕様を示しています。

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

プロジェクト設定の例

次の例では、クラスターメトリクス、データエクスプローラー、 Performance Advisor 、リアルタイムパフォーマンスパネル、スキーマアドバイザーのデータベース統計のコレクションを無効にする AtlasProject カスタムリソース仕様を示しています。

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

アラート構成の例

次の例では、oplog window が 1 時間未満の場合にトリガーされるアラートを構成するAtlasProjectカスタムリソース仕様を示しています。

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

サードパーティアラートの構成例

次の例では、Slack に通知を送信するアラートを構成するAtlasProjectカスタムリソース仕様を示しています。

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

パラメーター

Atlas プロジェクト

AtlasProject is the Schema for the atlasprojects API

`Name`	タイプ	説明	必須
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasProject`	true
`metadata`	オブジェクト	`metadata`フィールドのフィールドについては、 Kubernetes `API` のドキュメントを参照してください。	true
`spec`	オブジェクト	`AtlasProjectSpec` defines the target state of Project in Atlas	false
`status`	オブジェクト	`AtlasProjectStatus` defines the observed state of `AtlasProject`	false

AtlasProject.spec

AtlasProjectSpec defines the target state of Project in Atlas

`Name`	タイプ	説明	必須
`name`	string	Name is the `name` of the Project that is created in Atlas by the Operator if it doesn't exist yet. The `name` length must not exceed 64 characters. The `name` must contain only letters, numbers, spaces, dashes, and underscores. Validations: self == `oldSelf`: Name cannot be modified after project creation	true
`alertConfigurationSyncEnabled`	ブール値	`AlertConfigurationSyncEnabled` is a flag that enables/disables Alert Configurations sync for the current Project. If true - project alert configurations will be synced according to `AlertConfigurations`. If not - alert configurations will not be modified by the operator. They can be managed through the `API`, `CLI`, and `UI`.	false
`alertConfigurations`	[]オブジェクト	`AlertConfiguration` is a list of Alert Configurations configured for the current Project. If you use this setting, you must also set spec.``alertConfigurationSyncEnabled`` to true for Atlas Kubernetes Operator to modify project alert configurations. If you omit or leave this setting empty, Atlas Kubernetes Operator doesn't alter the project's alert configurations. If creating a project, Atlas applies the default project alert configurations.	false
`auditing`	オブジェクト	Auditing represents `MongoDB` Maintenance Windows.	false
`backupCompliancePolicyRef`	オブジェクト	`BackupCompliancePolicyRef` is a reference to the backup compliance custom resource.	false
`cloudProviderAccessRoles`	[]オブジェクト	`CloudProviderAccessRoles` is a list of Cloud Provider Access Roles configured for the current Project. Deprecated: This configuration was deprecated in favor of `CloudProviderIntegrations`	false
`cloudProviderIntegrations`	[]オブジェクト	`CloudProviderIntegrations` is a list of Cloud Provider Integration configured for the current Project.	false
`connectionSecretRef`	オブジェクト	`ConnectionSecret` is the name of the Kubernetes Secret which contains the information about the way to connect to Atlas (organization `ID`, `API` keys). The default Operator connection configuration will be used if not provided.	false
`customRoles`	[]オブジェクト	`CustomRoles` lets you create and change custom roles in your cluster. Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe. Deprecated: Migrate to the `AtlasCustomRoles` custom resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr	false
`encryptionAtRest`	オブジェクト	`EncryptionAtRest` allows to set encryption for `AWS`, Azure and `GCP` providers.	false
`integrations`	[]オブジェクト	Integrations is a list of `MongoDB` Atlas `integrations` for the project. Deprecated: Migrate to the `AtlasThirdPartyIntegration` custom resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr	false
`maintenanceWindow`	オブジェクト	`MaintenanceWindow` allows to specify a preferred time in the week to run maintenance operations. See more information at https://www.mongodb.com/ja-jp/docs/atlas/reference/api/maintenance-windows/	false
`networkPeers`	[]オブジェクト	`NetworkPeers` is a list of Network Peers configured for the current Project. Deprecated: Migrate to the `AtlasNetworkPeering` and `AtlasNetworkContainer` custom resources in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr	false
`privateEndpoints`	[]オブジェクト	`PrivateEndpoints` is a list of Private Endpoints configured for the current Project. Deprecated: Migrate to the `AtlasPrivateEndpoint` Custom Resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr	false
`projectIpAccessList`	[]オブジェクト	`ProjectIPAccessList` allows the use of the `IP` Access List for a Project. See more information at https://mongodb.com/ja-jp/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Deprecated: Migrate to the `AtlasIPAccessList` Custom Resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr	false
`regionUsageRestrictions`	列挙	`RegionUsageRestrictions` designate the project's `AWS` region when using Atlas for Government. This parameter should not be used with commercial Atlas. In Atlas for Government, not setting this field (defaulting to `NONE`) means the project is restricted to `COMMERCIAL_FEDRAMP_REGIONS_ONLY`. Enum: `NONE`, `GOV_REGIONS_ONLY`, `COMMERCIAL_FEDRAMP_REGIONS_ONLY` Default: `NONE`	false
`settings`	オブジェクト	Settings allows the configuration of the Project Settings.	false
`teams`	[]オブジェクト	Teams enable you to grant project access roles to multiple users.	false
`withDefaultAlertsSettings`	ブール値	Flag that indicates whether Atlas Kubernetes Operator creates a project with the default alert configurations. If you use this setting, you must also set spec.``alertConfigurationSyncEnabled`` to true for Atlas Kubernetes Operator to modify project alert configurations. If you set this parameter to false when you create a project, Atlas doesn't add the default alert configurations to your project. This setting has no effect on existing projects. Default: true	false
`x509CertRef`	オブジェクト	X509CertRef is a reference to the Kubernetes Secret which contains `PEM`-encoded `CA` certificate. Atlas Kubernetes Operator watches secrets only with the label atlas.mongodb.com/type=credentials to avoid watching unnecessary secrets.	false

AtlasProject.spec.alertConfigurations

`Name`	タイプ	説明	必須
`enabled`	ブール値	省略した場合、構成は無効になります。	false
`eventTypeName`	string	The type of event that will trigger an alert.	false
`matchers`	[]オブジェクト	`EventTypeName`がホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 `matchers`配列を使用してフィルタリングできます。	false
`metricThreshold`	オブジェクト	`MetricThreshold` causes an alert to be triggered.	false
`notifications`	[]オブジェクト	Notifications are sending when an alert condition is detected.	false
`severityOverride`	列挙	`SeverityOverride` optionally overrides the default severity level for an alert. Enum: `INFO`, `WARNING`, `ERROR`, `CRITICAL`	false
`threshold`	オブジェクト	Threshold causes an alert to be triggered.	false

AtlasProject.spec.alertConfigurations.matchers

`Name`	タイプ	説明	必須
`fieldName`	string	一致するターゲットオブジェクト内のフィールドの名前。	false
`operator`	string	The `operator` to test the field’s value.	false
`value`	string	指定された演算子でテストする値。	false

AtlasProject.spec.alertConfigurations.metricThreshold

MetricThreshold causes an alert to be triggered.

`Name`	タイプ	説明	必須
`threshold`	string	Threshold value outside which an alert will be triggered.	true
`metricName`	string	Name of the metric to check.	false
`mode`	string	This must be set to `AVERAGE`. Atlas computes the current metric value as an average.	false
`operator`	string	現在のメトリクス値をしきい値と照合するときに適用する演算子。	false
`units`	string	The `units` for the threshold value.	false

AtlasProject.spec.alertConfigurations.notifications

`Name`	タイプ	説明	必須
`apiTokenRef`	オブジェクト	Secret containing a Slack `API` token or Bot token. Populated for the `SLACK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`channelName`	string	Slack channel name. Populated for the `SLACK` notifications type.	false
`datadogAPIKeyRef`	オブジェクト	Secret containing a Datadog `API` Key. Found in the Datadog dashboard. Populated for the `DATADOG` notifications type.	false
`datadogRegion`	string	Region that indicates which `API` `URL` to use.	false
`delayMin`	integer	アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。	false
`emailAddress`	string	Email address to which alert notifications are sent. Populated for the `EMAIL` notifications type.	false
`emailEnabled`	ブール値	Flag indicating if email notifications should be sent. Populated for `ORG`, `GROUP`, and `USER` notifications types.	false
`flowName`	string	小文字の Flowdock フロー名。	false
`flowdockApiTokenRef`	オブジェクト	The Flowdock personal `API` token. Populated for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`intervalMin`	integer	解決されていない未確認アラートの連続した通知間で待機する時間（分）。	false
`mobileNumber`	string	Mobile number to which alert notifications are sent. Populated for the `SMS` notifications type.	false
`opsGenieApiKeyRef`	オブジェクト	`OpsGenie` `API` Key. Populated for the `OPS_GENIE` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`opsGenieRegion`	string	Region that indicates which `API` `URL` to use.	false
`orgName`	string	Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the `URL` string. Populated for the `FLOWDOCK` notifications type.	false
`roles`	[]string	The following `roles` grant privileges within a project.	false
`serviceKeyRef`	オブジェクト	`PagerDuty` service key. Populated for the `PAGER_DUTY` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.	false
`smsEnabled`	ブール値	Flag indicating if text message notifications should be sent. Populated for `ORG`, `GROUP`, and `USER` notifications types.	false
`teamId`	string	チームの一意の識別子。	false
`teamName`	string	この通知を受け取ったチームのラベル。	false
`typeName`	string	アラート通知のタイプ。	false
`username`	string	Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Populated for the `USER` notifications type.	false
`victorOpsSecretRef`	オブジェクト	Secret containing a `VictorOps` `API` key and Routing key. Populated for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.	false

AtlasProject.spec.alertConfigurations.notifications.apiTokenRef

Secret containing a Slack API token or Bot token. Populated for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.notifications.datadogAPIKeyRef

Secret containing a Datadog API Key. Found in the Datadog dashboard. Populated for the DATADOG notifications type.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.notifications.flowdockApiTokenRef

The Flowdock personal API token. Populated for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.notifications.opsGenieApiKeyRef

OpsGenie API Key. Populated for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.notifications.serviceKeyRef

PagerDuty service key. Populated for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.notifications.victorOpsSecretRef

Secret containing a VictorOps API key and Routing key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.alertConfigurations.threshold

Threshold causes an alert to be triggered.

`Name`	タイプ	説明	必須
`operator`	string	Operator to apply when checking the current metric value against the threshold value. It accepts the following values: `GREATER_THAN`, `LESS_THAN`.	false
`threshold`	string	Threshold value outside which an alert will be triggered.	false
`units`	string	The `units` for the threshold value.	false

AtlasProject.spec.auditing

Auditing represents MongoDB Maintenance Windows.

`Name`	タイプ	説明	必須
`auditAuthorizationSuccess`	ブール値	Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "`authCheck`" auditing event. For more information, see `auditAuthorizationSuccess`.	false
`auditFilter`	string	`JSON`-formatted audit filter used by the project.	false
`enabled`	ブール値	Denotes whether the project associated with the {`GROUP`-`ID`} has database auditing enabled.	false

AtlasProject.spec.backupCompliancePolicyRef

BackupCompliancePolicyRef is a reference to the backup compliance custom resource.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.cloudProviderAccessRoles

CloudProviderAccessRole define an integration to a cloud provider DEPRECATED: This type is deprecated in favor of CloudProviderIntegration

`Name`	タイプ	説明	必須
`providerName`	string	`ProviderName` is the name of the cloud provider. Currently only `AWS` is supported.	true
`iamAssumedRoleArn`	string	`IamAssumedRoleArn` is the `ARN` of the `IAM` role that is assumed by the Atlas cluster.	false

AtlasProject.spec.cloudProviderIntegrations

CloudProviderIntegration define an integration to a cloud provider

`Name`	タイプ	説明	必須
`providerName`	string	`ProviderName` is the name of the cloud provider. Currently only `AWS` is supported.	true
`iamAssumedRoleArn`	string	`IamAssumedRoleArn` is the `ARN` of the `IAM` role that is assumed by the Atlas cluster.	false

AtlasProject.spec.connectionSecretRef

ConnectionSecret is the name of the Kubernetes Secret which contains the information about the way to connect to Atlas (organization ID, API keys). The default Operator connection configuration will be used if not provided.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.customRoles

CustomRole lets you create and change a custom role in your cluster. Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe. Deprecated: Migrate to the AtlasCustomRoles custom resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

`Name`	タイプ	説明	必須
`name`	string	Human-readable label that identifies the role. This `name` must be unique for this custom role in this project.	true
`actions`	[]オブジェクト	List of the individual privilege `actions` that the role grants.	false
`inheritedRoles`	[]オブジェクト	このカスタムロールが継承する組み込みロールのリスト。	false

AtlasProject.spec.customRoles.actions

`Name`	タイプ	説明	必須
`name`	string	特権アクションを識別する、人間が判読可能なラベル。	true
`resources`	[]オブジェクト	List of `resources` on which you grant the action.	true

AtlasProject.spec.customRoles.actions.resources

`Name`	タイプ	説明	必須
`cluster`	ブール値	Flag that indicates whether to grant the action on the `cluster` resource. If true, `MongoDB` Cloud ignores Database and Collection parameters.	false
`collection`	string	Human-readable label that identifies the `collection` on which you grant the action to one `MongoDB` user.	false
`database`	string	Human-readable label that identifies the `database` on which you grant the action to one `MongoDB` user.	false

AtlasProject.spec.customRoles.inheritedRoles

`Name`	タイプ	説明	必須
`database`	string	Human-readable label that identifies the `database` on which someone grants the action to one `MongoDB` user.	true
`name`	string	Human-readable label that identifies the role inherited.	true

AtlasProject.spec.encryptionAtRest

EncryptionAtRest allows to set encryption for AWS, Azure and GCP providers.

`Name`	タイプ	説明	必須
`awsKms`	オブジェクト	`AwsKms` specifies `AWS` `KMS` configuration details and whether Encryption at Rest is enabled for an Atlas project.	false
`azureKeyVault`	オブジェクト	`AzureKeyVault` specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.	false
`googleCloudKms`	オブジェクト	`GoogleCloudKms` specifies `GCP` `KMS` configuration details and whether Encryption at Rest is enabled for an Atlas project.	false

AtlasProject.spec.encryptionAtRest.awsKms

AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

`Name`	タイプ	説明	必須
`enabled`	ブール値	Specifies whether Encryption at Rest is `enabled` for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.	false
`region`	string	The `AWS` `region` in which the `AWS` customer master key exists.	false
`secretRef`	オブジェクト	A reference to as Secret containing the `AccessKeyID`, `SecretAccessKey`, `CustomerMasterKeyID` and `RoleID` fields	false
`valid`	ブール値	Specifies whether the encryption key set for the provider is `valid` and may be used to encrypt and decrypt data.	false

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

A reference to as Secret containing the AccessKeyID, SecretAccessKey, CustomerMasterKeyID and RoleID fields

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.encryptionAtRest.azureKeyVault

AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.

`Name`	タイプ	説明	必須
`azureEnvironment`	string	The Azure environment where the Azure account credentials reside. Valid values are the following: `AZURE`, `AZURE_CHINA`, `AZURE_GERMANY`	false
`clientID`	string	The Client `ID`, also known as the application `ID`, for an Azure application associated with the Azure `AD` tenant.	false
`enabled`	ブール値	Specifies whether Encryption at Rest is `enabled` for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.	false
`resourceGroupName`	string	The name of the Azure Resource group that contains an Azure Key Vault.	false
`secretRef`	オブジェクト	A reference to as Secret containing the `SubscriptionID`, `KeyVaultName`, `KeyIdentifier`, Secret fields	false
`tenantID`	string	The unique identifier for an Azure `AD` tenant within an Azure subscription.	false

AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef

A reference to as Secret containing the SubscriptionID, KeyVaultName, KeyIdentifier, Secret fields

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.encryptionAtRest.googleCloudKms

GoogleCloudKms specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

`Name`	タイプ	説明	必須
`enabled`	ブール値	Specifies whether Encryption at Rest is `enabled` for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.	false
`secretRef`	オブジェクト	A reference to as Secret containing the `ServiceAccountKey`, `KeyVersionResourceID` fields	false

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

A reference to as Secret containing the ServiceAccountKey, KeyVersionResourceID fields

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations

Integration for the project between Atlas and a third party service. Deprecated: Migrate to the AtlasThirdPartyIntegration custom resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

`Name`	タイプ	説明	必須
`accountId`	string	New Relic アカウントを識別する一意の 40 桁の 16 進数文字列。	false
`apiKeyRef`	オブジェクト	Reference to a Kubernetes Secret containing your `API` Key for Datadog, `OpsGenie` or Victor Ops.	false
`apiTokenRef`	オブジェクト	Reference to a Kubernetes Secret containing the Key that allows Atlas to access your Slack account.	false
`channelName`	string	Name of the Slack channel to which Atlas sends alert notifications.	false
`enabled`	ブール値	Prometheus 統合がアクティブ化されているかどうかを示すフラグ。	false
`flowName`	string	`DEPRECATED`: Flowdock flow name. This field has been removed from Atlas, and has no effect.	false
`licenseKeyRef`	オブジェクト	Reference to a Kubernetes Secret containing your Unique 40-hexadecimal digit string that identifies your New Relic license.	false
`microsoftTeamsWebhookUrl`	string	Endpoint web address of the Microsoft Teams webhook to which Atlas sends notifications.	false
`name`	string		false
`orgName`	string	`DEPRECATED`: Flowdock organization name. This field has been removed from Atlas, and has no effect.	false
`passwordRef`	オブジェクト	Reference to a Kubernetes Secret containing the password to allow Atlas to access your Prometheus account.	false
`readTokenRef`	オブジェクト	Reference to a Kubernetes Secret containing the query key associated with your New Relic account.	false
`region`	string	Region code indicating which regional `API` Atlas uses to access `PagerDuty`, Datadog, or `OpsGenie`.	false
`routingKeyRef`	オブジェクト	Reference to a Kubernetes Secret containing the Routing key associated with your Splunk On-Call account. Used for Victor Ops.	false
`scheme`	string		false
`secretRef`	オブジェクト	Reference to a Kubernetes Secret containing the secret for your Webhook.	false
`serviceDiscovery`	string	Prometheus サービスを検出するための希望方法です。	false
`serviceKeyRef`	オブジェクト	Reference to a Kubernetes Secret containing the service key associated with your `PagerDuty` account.	false
`teamName`	string	Human-readable label that identifies your Slack team.	false
`type`	列挙	Third Party Integration `type` such as Slack, New Relic, etc. Each integration `type` requires a distinct set of configuration fields. For example, if you set `type` to `DATADOG`, you must configure only datadog subfields. Enum: `PAGER_DUTY`, `SLACK`, `DATADOG`, `NEW_RELIC`, `OPS_GENIE`, `VICTOR_OPS`, `FLOWDOCK`, `WEBHOOK`, `MICROSOFT_TEAMS`, `PROMETHEUS`	false
`url`	string	Endpoint web address to which Atlas sends notifications. Used for Webhooks.	false
`username`	string	Prometheus 受信 Webhook を識別する、人間が判読可能なラベル。	false
`writeTokenRef`	オブジェクト	Reference to a Kubernetes Secret containing the insert key associated with your New Relic account.	false

AtlasProject.spec.integrations.apiKeyRef

Reference to a Kubernetes Secret containing your API Key for Datadog, OpsGenie or Victor Ops.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.apiTokenRef

Reference to a Kubernetes Secret containing the Key that allows Atlas to access your Slack account.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.licenseKeyRef

Reference to a Kubernetes Secret containing your Unique 40-hexadecimal digit string that identifies your New Relic license.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.passwordRef

Reference to a Kubernetes Secret containing the password to allow Atlas to access your Prometheus account.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.readTokenRef

Reference to a Kubernetes Secret containing the query key associated with your New Relic account.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.routingKeyRef

Reference to a Kubernetes Secret containing the Routing key associated with your Splunk On-Call account. Used for Victor Ops.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.secretRef

Reference to a Kubernetes Secret containing the secret for your Webhook.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.serviceKeyRef

Reference to a Kubernetes Secret containing the service key associated with your PagerDuty account.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.integrations.writeTokenRef

Reference to a Kubernetes Secret containing the insert key associated with your New Relic account.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.maintenanceWindow

MaintenanceWindow allows to specify a preferred time in the week to run maintenance operations. See more information at https://www.mongodb.com/ja-jp/docs/atlas/reference/api/maintenance-windows/

`Name`	タイプ	説明	必須
`autoDefer`	ブール値	Flag indicating whether any scheduled project maintenance should be deferred automatically for one week.	false
`dayOfWeek`	integer	Day of the week when you would like the maintenance window to start as a 1-based integer. Sunday 1, Monday 2, Tuesday 3, Wednesday 4, Thursday 5, Friday 6, Saturday 7. Minimum: 1 Maximum: 7	false
`defer`	ブール値	Flag indicating whether the next scheduled project maintenance should be deferred for one week. Cannot be specified if `startASAP` is true	false
`hourOfDay`	integer	Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12. Minimum: 0 Maximum: 23	false
`startASAP`	ブール値	Flag indicating whether project maintenance has been directed to start immediately. Cannot be specified if defer is true	false

AtlasProject.spec.networkPeers

NetworkPeer configured for the current Project. Deprecated: Migrate to the AtlasNetworkPeering and AtlasNetworkContainer custom resources in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

`Name`	タイプ	説明	必須
`accepterRegionName`	string	`AccepterRegionName` is the provider region name of user's `VPC`.	false
`atlasCidrBlock`	string	Atlas `CIDR`。 `ContainerID` が設定されていない場合は、を設定する必要があります。	false
`awsAccountId`	string	`AccountID` of the user's `VPC`.	false
`azureDirectoryId`	string	`AzureDirectoryID` は、 Azure `AD`ディレクトリの一意の識別子です。	false
`azureSubscriptionId`	string	`AzureSubscriptionID` は、VNet が存在するAzureサブスクライブの一意の識別子です。	false
`containerId`	string	`ID` of the network peer container. If not set, operator will create a new container with `ContainerRegion` and `AtlasCIDRBlock` input.	false
`containerRegion`	string	`ContainerRegion` is the provider region name of Atlas network peer container. If not set, `AccepterRegionName` is used.	false
`gcpProjectId`	string	ユーザー `GCP` プロジェクト `ID`。これは `GCP` にのみ適用されます。	false
`networkName`	string	`GCP` ネットワークピア名。これは `GCP` にのみ適用されます。	false
`providerName`	string	`ProviderName` is the name of the provider. If not set, it will be set to "`AWS`".	false
`resourceGroupName`	string	`ResourceGroupName` は、 Azureリソースグループの名前です。	false
`routeTableCidrBlock`	string	ユーザー `VPC` `CIDR`。	false
`vnetName`	string	VNetName はAzure VNet の名前です。 Azureにのみ適用されます。	false
`vpcId`	string	`AWS` `VPC` `ID`.	false

AtlasProject.spec.privateEndpoints

PrivateEndpoint is a list of Private Endpoints configured for the current Project. Deprecated: Migrate to the AtlasPrivateEndpoint Custom Resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

`Name`	タイプ	説明	必須
`provider`	列挙	Cloud `provider` for which you want to retrieve a private endpoint service. Atlas accepts `AWS`, `GCP`, or `AZURE`. Enum: `AWS`, `GCP`, `AZURE`, `TENANT`	true
`region`	string	Cloud provider `region` for which you want to create the private endpoint service.	true
`endpointGroupName`	string	Unique identifier of the endpoint group. The endpoint group encompasses all the endpoints that you created in Google Cloud.	false
`endpoints`	[]オブジェクト	Collection of individual private `endpoints` that comprise your endpoint group.	false
`gcpProjectId`	string	Unique identifier of the Google Cloud project in which you created your endpoints.	false
`id`	string	Unique identifier of the private endpoint you created in your `AWS` `VPC` or Azure VNet.	false
`ip`	string	Azure VNet で作成したプライベートエンドポイントネットワークインターフェイスのプライベート `IP` アドレス。	false

AtlasProject.spec.privateEndpoints.endpoints

`Name`	タイプ	説明	必須
`endpointName`	string	Forwarding rule that corresponds to the endpoint you created in Google Cloud.	false
`ipAddress`	string	Private `IP` address of the endpoint you created in Google Cloud.	false

AtlasProject.spec.projectIpAccessList

IPAccessList allows the use of the IP Access List for a Project. See more information at https://mongodb.com/ja-jp/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Deprecated: Migrate to the AtlasIPAccessList Custom Resource in accordance with the migration guide at https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

`Name`	タイプ	説明	必須
`awsSecurityGroup`	string	Unique identifier of `AWS` security group in this access list entry.	false
`cidrBlock`	string	Range of `IP` addresses in `CIDR` notation in this access list entry.	false
`comment`	string	このアクセスリストエントリに関連付けられたコメント。	false
`deleteAfterDate`	string	Timestamp in `ISO` 8601 date and time format in `UTC` after which Atlas deletes the temporary access list entry.	false
`ipAddress`	string	Entry using an `IP` address in this access list entry.	false

AtlasProject.spec.settings

Settings allows the configuration of the Project Settings.

`Name`	タイプ	説明	必須
`isCollectDatabaseSpecificsStatisticsEnabled`	ブール値	指定されたプロジェクトのデータベース固有のメトリクスを収集するかどうかを示すフラグ。	false
`isDataExplorerEnabled`	ブール値	指定されたプロジェクトに対して Data Explorer を有効にするかどうかを示すフラグ。	false
`isExtendedStorageSizesEnabled`	ブール値	指定されたプロジェクトに対してストレージサイズ拡張を有効にするかどうかを示すフラグ。	false
`isPerformanceAdvisorEnabled`	ブール値	指定したプロジェクトの Performance Advisor とプロファイラーを有効にするかどうかを示すフラグ。	false
`isRealtimePerformancePanelEnabled`	ブール値	指定したプロジェクトに対してリアルタイムパフォーマンスパネルを有効にするかどうかを示すフラグ。	false
`isSchemaAdvisorEnabled`	ブール値	指定されたプロジェクトに対してスキーマアドバイザーを有効にするかどうかを示すフラグ。	false

AtlasProject.spec.teams

`Name`	タイプ	説明	必須
`roles`	[]enum	Roles the users in the team has within the project. Enum: `GROUP_OWNER`, `GROUP_CLUSTER_MANAGER`, `GROUP_DATA_ACCESS_ADMIN`, `GROUP_DATA_ACCESS_READ_WRITE`, `GROUP_DATA_ACCESS_READ_ONLY`, `GROUP_READ_ONLY`	true
`teamRef`	オブジェクト	Reference to the `AtlasTeam` custom resource which will be assigned to the project.	true

AtlasProject.spec.teams.teamRef

Reference to the AtlasTeam custom resource which will be assigned to the project.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.spec.x509CertRef

X509CertRef is a reference to the Kubernetes Secret which contains PEM-encoded CA certificate. Atlas Kubernetes Operator watches secrets only with the label atlas.mongodb.com/type=credentials to avoid watching unnecessary secrets.

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

AtlasProject.status

AtlasProjectStatus defines the observed state of AtlasProject

`Name`	タイプ	説明	必須
`conditions`	[]オブジェクト	条件は、Atlas カスタムリソースの現在の状態を示すステータスのリストです	true
`alertConfigurations`	[]オブジェクト	`AlertConfigurations` contains a list of alert configuration statuses	false
`authModes`	[]string	`AuthModes` contains a list of configured authentication modes "`SCRAM`" is default authentication method and requires a password for each user "`X509`" signifies that self-managed X.509 authentication is configured	false
`cloudProviderIntegrations`	[]オブジェクト	`CloudProviderIntegrations` contains a list of configured cloud provider access roles. `AWS` support only	false
`customRoles`	[]オブジェクト	`CustomRoles` contains a list of custom roles statuses	false
`expiredIpAccessList`	[]オブジェクト	The list of `IP` Access List entries that are expired due to '`deleteAfterDate`' being less than the current date. Note, that this field is updated by the Atlas Operator only after specification changes	false
`id`	string	The `ID` of the Atlas Project	false
`networkPeers`	[]オブジェクト	The list of network peers that are configured for current project	false
`observedGeneration`	integer	`ObservedGeneration` は、Atlas 演算子が認識しているリソース仕様の生成を示します。 Atlas 演算子は、リソースの調整を開始するとすぐに、このフィールドをメタデータ.生成の値に更新します。形式: int64	false
`privateEndpoints`	[]オブジェクト	The list of private endpoints configured for current project	false
`prometheus`	オブジェクト	Prometheus contains the status for Prometheus integration including the `prometheusDiscoveryURL`	false
`teams`	[]オブジェクト	Teams contains a list of `teams` assignment statuses	false

AtlasProject.status.conditions

条件は、特定の点における Atlas カスタムリソースの状態を表します。

`Name`	タイプ	説明	必須
`status`	string	条件のステータス。 True、False、Unknown のいずれか 1 つ。	true
`type`	string	Atlas カスタムリソース条件のタイプ。	true
`lastTransitionTime`	string	条件があるステータスから別のステータスに最後に移行した時刻。`ISO`8601 形式で表されます。形式: 日時	false
`message`	string	移行に関する詳細を提供する `message`。	false
`reason`	string	条件の最後の移行の `reason`。	false

AtlasProject.status.alertConfigurations

`Name`	タイプ	説明	必須
`acknowledgedUntil`	string	The date through which the alert has been acknowledged. Will not be present if the alert has never been acknowledged.	false
`acknowledgementComment`	string	The comment left by the user who acknowledged the alert. Will not be present if the alert has never been acknowledged.	false
`acknowledgingUsername`	string	The username of the user who acknowledged the alert. Will not be present if the alert has never been acknowledged.	false
`alertConfigId`	string	`ID` of the alert configuration that triggered this alert.	false
`clusterId`	string	The `ID` of the cluster to which this alert applies. Only present for alerts of type `BACKUP`, `REPLICA_SET`, and `CLUSTER`.	false
`clusterName`	string	The name the cluster to which this alert applies. Only present for alerts of type `BACKUP`, `REPLICA_SET`, and `CLUSTER`.	false
`created`	string	Timestamp in `ISO` 8601 date and time format in `UTC` when this alert configuration was created.	false
`currentValue`	オブジェクト	`CurrentValue` represents current value of the metric that triggered the alert. Only present for alerts of type `HOST_METRIC`.	false
`enabled`	ブール値	省略した場合、構成は無効になります。	false
`errorMessage`	string	`ErrorMessage` is massage if the alert configuration is in an incorrect state.	false
`eventTypeName`	string	The type of event that will trigger an alert.	false
`groupId`	string	このアラート構成を所有するプロジェクトの一意の識別子。	false
`hostId`	string	`ID` of the host to which the metric pertains. Only present for alerts of type `HOST`, `HOST_METRIC`, and `REPLICA_SET`.	false
`hostnameAndPort`	string	The hostname and port of each host to which the alert applies. Only present for alerts of type `HOST`, `HOST_METRIC`, and `REPLICA_SET`.	false
`id`	string	Unique identifier.	false
`lastNotified`	string	このアラートの最後の通知が送信されたとき。通知が送信された場合にのみ存在します。	false
`matchers`	[]オブジェクト	`EventTypeName`がホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 `matchers`配列を使用してフィルタリングできます。	false
`metricName`	string	The name of the measurement whose value went outside the threshold. Only present if `eventTypeName` is set to `OUTSIDE_METRIC_THRESHOLD`.	false
`metricThreshold`	オブジェクト	`MetricThreshold` causes an alert to be triggered.	false
`notifications`	[]オブジェクト	Notifications are sending when an alert condition is detected.	false
`replicaSetName`	string	Name of the replica set. Only present for alerts of type `HOST`, `HOST_METRIC`, `BACKUP`, and `REPLICA_SET`.	false
`resolved`	string	When the alert was closed. Only present if the status is `CLOSED`.	false
`severityOverride`	string	Severity of the alert.	false
`sourceTypeName`	string	For alerts of the type `BACKUP`, the type of server being backed up.	false
`status`	string	The current state of the alert. Possible values are: `TRACKING`, `OPEN`, `CLOSED`, `CANCELED`	false
`threshold`	オブジェクト	Threshold causes an alert to be triggered.	false
`updated`	string	Timestamp in `ISO` 8601 date and time format in `UTC` when this alert configuration was last updated.	false

AtlasProject.status.alertConfigurations.currentValue

CurrentValue represents current value of the metric that triggered the alert. Only present for alerts of type HOST_METRIC.

`Name`	タイプ	説明	必須
`number`	string	The value of the metric.	false
`units`	string	The `units` for the value. Depends on the type of metric.	false

AtlasProject.status.alertConfigurations.matchers

`Name`	タイプ	説明	必須
`fieldName`	string	一致するターゲットオブジェクト内のフィールドの名前。	false
`operator`	string	The `operator` to test the field’s value.	false
`value`	string	指定された演算子でテストする値。	false

AtlasProject.status.alertConfigurations.metricThreshold

MetricThreshold causes an alert to be triggered.

`Name`	タイプ	説明	必須
`threshold`	string	Threshold value outside which an alert will be triggered.	true
`metricName`	string	Name of the metric to check.	false
`mode`	string	This must be set to `AVERAGE`. Atlas computes the current metric value as an average.	false
`operator`	string	現在のメトリクス値をしきい値と照合するときに適用する演算子。	false
`units`	string	The `units` for the threshold value.	false

AtlasProject.status.alertConfigurations.notifications

`Name`	タイプ	説明	必須
`apiToken`	string	Slack `API` token or Bot token. Populated for the `SLACK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`channelName`	string	Slack channel name. Populated for the `SLACK` notifications type.	false
`datadogApiKey`	string	Datadog `API` Key. Found in the Datadog dashboard. Populated for the `DATADOG` notifications type.	false
`datadogRegion`	string	Region that indicates which `API` `URL` to use	false
`delayMin`	integer	アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。	false
`emailAddress`	string	Email address to which alert notifications are sent. Populated for the `EMAIL` notifications type.	false
`emailEnabled`	ブール値	Flag indicating if email notifications should be sent. Populated for `ORG`, `GROUP`, and `USER` notifications types.	false
`flowName`	string	Flowdock flow namse in lower-case letters.	false
`flowdockApiToken`	string	The Flowdock personal `API` token. Populated for the `FLOWDOCK` notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`intervalMin`	integer	解決されていない未確認アラートの連続した通知間で待機する時間（分）。	false
`mobileNumber`	string	Mobile number to which alert notifications are sent. Populated for the `SMS` notifications type.	false
`opsGenieApiKey`	string	Opsgenie `API` Key. Populated for the `OPS_GENIE` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.	false
`opsGenieRegion`	string	Region that indicates which `API` `URL` to use.	false
`orgName`	string	Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the `URL` string. Populated for the `FLOWDOCK` notifications type.	false
`roles`	[]string	The following `roles` grant privileges within a project.	false
`serviceKey`	string	`PagerDuty` service key. Populated for the `PAGER_DUTY` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.	false
`smsEnabled`	ブール値	Flag indicating if text message notifications should be sent. Populated for `ORG`, `GROUP`, and `USER` notifications types.	false
`teamId`	string	チームの一意の識別子。	false
`teamName`	string	この通知を受け取ったチームのラベル。	false
`typeName`	string	アラート通知のタイプ。	false
`username`	string	Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Populated for the `USER` notifications type.	false
`victorOpsApiKey`	string	`VictorOps` `API` key. Populated for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.	false
`victorOpsRoutingKey`	string	`VictorOps` routing key. Populated for the `VICTOR_OPS` notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.	false

AtlasProject.status.alertConfigurations.threshold

Threshold causes an alert to be triggered.

`Name`	タイプ	説明	必須
`operator`	string	Operator to apply when checking the current metric value against the threshold value. it accepts the following values: `GREATER_THAN`, `LESS_THAN`	false
`threshold`	string	Threshold value outside which an alert will be triggered.	false
`units`	string	The `units` for the threshold value	false

AtlasProject.status.cloudProviderIntegrations

`Name`	タイプ	説明	必須
`atlasAssumedRoleExternalId`	string	Unique external `ID` that `MongoDB` Atlas uses when it assumes the `IAM` role in your Amazon Web Services account.	true
`providerName`	string	ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。	true
`atlasAWSAccountArn`	string	Amazon Resource Name that identifies the Amazon Web Services user account that `MongoDB` Atlas uses when it assumes the Identity and Access Management role.	false
`authorizedDate`	string	Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the `ISO` 8601 timestamp format in `UTC`.	false
`createdDate`	string	Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the `ISO` 8601 timestamp format in `UTC`.	false
`errorMessage`	string	Application error message returned.	false
`featureUsages`	[]オブジェクト	List that contains application features associated with this Amazon Web Services Identity and Access Management role.	false
`iamAssumedRoleArn`	string	Amazon Resource Name that identifies the Amazon Web Services Identity and Access Management role that `MongoDB` Cloud assumes when it accesses resources in your `AWS` account.	false
`roleId`	string	ロールを識別するユニークな 24 桁の 16 進数の文字列。	false
`status`	string	Provision `status` of the service account. Values are `IN_PROGRESS`, `COMPLETE`, `FAILED`, or `NOT_INITIATED`.	false

AtlasProject.status.cloudProviderIntegrations.featureUsages

`Name`	タイプ	説明	必須
`featureId`	string	Identifying characteristics about the data lake linked to this Amazon Web Services Identity and Access Management role.	false
`featureType`	string	Human-readable label that describes one `MongoDB` Cloud feature linked to this Amazon Web Services Identity and Access Management role.	false

AtlasProject.status.customRoles

`Name`	タイプ	説明	必須
`name`	string	Role `name` which is unique	true
`status`	string	The `status` of the given custom role (`OK` or `FAILED`)	true
`error`	string	The message when the custom role is in the `FAILED` status	false

AtlasProject.status.expiredIpAccessList

`Name`	タイプ	説明	必須
`awsSecurityGroup`	string	Unique identifier of `AWS` security group in this access list entry.	false
`cidrBlock`	string	Range of `IP` addresses in `CIDR` notation in this access list entry.	false
`comment`	string	このアクセスリストエントリに関連付けられたコメント。	false
`deleteAfterDate`	string	Timestamp in `ISO` 8601 date and time format in `UTC` after which Atlas deletes the temporary access list entry.	false
`ipAddress`	string	Entry using an `IP` address in this access list entry.	false

AtlasProject.status.networkPeers

`Name`	タイプ	説明	必須
`id`	string	Unique identifier for `NetworkPeer`.	true
`providerName`	string	Cloud provider for which you want to retrieve a network peer.	true
`region`	string	Region for which you want to create the network peer. It isn't needed for `GCP`	true
`atlasGcpProjectId`	string	`ProjectID` of Atlas container. Applicable only for `GCP`. It's needed to add network peer connection.	false
`atlasNetworkName`	string	Atlas Network Name. Applicable only for `GCP`. It's needed to add network peer connection.	false
`connectionId`	string	Unique identifier of the network peer connection. Applicable only for `AWS`.	false
`containerId`	string	`ContainerID` of Atlas network peer container.	false
`errorMessage`	string	Error state of the network peer. Applicable only for `GCP`.	false
`errorState`	string	Error state of the network peer. Applicable only for Azure.	false
`errorStateName`	string	Error state of the network peer. Applicable only for `AWS`.	false
`gcpProjectId`	string	`ProjectID` of the user's vpc. Applicable only for `GCP`.	false
`status`	string	Status of the network peer. Applicable only for `GCP` and Azure.	false
`statusName`	string	Status of the network peer. Applicable only for `AWS`.	false
`vpc`	string	`VPC` is general purpose field for storing the name of the `VPC`. `VPC` is `vpcID` for `AWS`, user `networkName` for `GCP`, and `vnetName` for Azure.	false

AtlasProject.status.privateEndpoints

`Name`	タイプ	説明	必須
`provider`	string	Cloud `provider` for which you want to retrieve a private endpoint service. Atlas accepts `AWS` or `AZURE`.	true
`region`	string	Cloud provider `region` for which you want to create the private endpoint service.	true
`endpoints`	[]オブジェクト	Collection of individual `GCP` private `endpoints` that comprise your network endpoint group.	false
`id`	string	Unique identifier for `AWS` or `AZURE` Private Link Connection.	false
`interfaceEndpointId`	string	Unique identifier of the `AWS` or Azure Private Link Interface Endpoint.	false
`serviceAttachmentNames`	[]string	Unique alphanumeric and special character strings that identify the service attachments associated with the `GCP` Private Service Connect endpoint service.	false
`serviceName`	string	Name of the `AWS` or Azure Private Link Service that Atlas manages.	false
`serviceResourceId`	string	Unique identifier of the Azure Private Link Service (for `AWS` the same as `ID`).	false

AtlasProject.status.privateEndpoints.endpoints

`Name`	タイプ	説明	必須
`endpointName`	string	作成した Google Cloud コンシューマー転送ルールを識別する、人間に判読可能なラベル。	true
`ipAddress`	string	この Google Cloud コンシューマー転送ルールが解決される、1 つのプライベートインターネットプロトコルバージョン 4（IPv4）アドレス。	true
`status`	string	State of the `MongoDB` Atlas endpoint group when `MongoDB` Cloud received this request.	true

AtlasProject.status.prometheus

Prometheus contains the status for Prometheus integration including the prometheusDiscoveryURL

`Name`	タイプ	説明	必須
`prometheusDiscoveryURL`	string	`URL` from which Prometheus fetches the targets.	false
`scheme`	string	Protocol `scheme` used for Prometheus requests.	false

AtlasProject.status.teams

`Name`	タイプ	説明	必須
`teamRef`	オブジェクト	`ResourceRefNamespaced` is a reference to a Kubernetes Resource that allows to configure the namespace	true
`id`	string		false

AtlasProject.status.teams.teamRef

ResourceRefNamespaced is a reference to a Kubernetes Resource that allows to configure the namespace

`Name`	タイプ	説明	必須
`name`	string	Kubernetesリソースの名前	true
`namespace`	string	Kubernetesリソースの名前空間	false

戻る

カスタムリソース

AtlasDeployment

重要

カスタム リソースはデフォルトでオブジェクトを削除しなくなりました

例

Prometheus の例

注意

チームの例

メンテナンスウィンドウの例

プロジェクト設定の例

アラート構成の例

サードパーティ アラートの構成例

パラメーター

Atlas プロジェクト

AtlasProject.spec

AtlasProject.spec.alertConfigurations

AtlasProject.spec.alertConfigurations.matchers

AtlasProject.spec.alertConfigurations.metricThreshold

AtlasProject.spec.alertConfigurations.notifications

AtlasProject.spec.alertConfigurations.notifications.apiTokenRef

AtlasProject.spec.alertConfigurations.notifications.datadogAPIKeyRef

AtlasProject.spec.alertConfigurations.notifications.flowdockApiTokenRef

AtlasProject.spec.alertConfigurations.notifications.opsGenieApiKeyRef

AtlasProject.spec.alertConfigurations.notifications.serviceKeyRef

AtlasProject.spec.alertConfigurations.notifications.victorOpsSecretRef

AtlasProject.spec.alertConfigurations.threshold

AtlasProject.spec.auditing

AtlasProject.spec.backupCompliancePolicyRef

AtlasProject.spec.cloudProviderAccessRoles

AtlasProject.spec.cloudProviderIntegrations

AtlasProject.spec.connectionSecretRef

AtlasProject.spec.customRoles

AtlasProject.spec.customRoles.actions

AtlasProject.spec.customRoles.actions.resources

AtlasProject.spec.customRoles.inheritedRoles

AtlasProject.spec.encryptionAtRest

AtlasProject.spec.encryptionAtRest.awsKms

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

AtlasProject.spec.encryptionAtRest.azureKeyVault

AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef

AtlasProject.spec.encryptionAtRest.googleCloudKms

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

AtlasProject.spec.integrations

AtlasProject.spec.integrations.apiKeyRef

AtlasProject.spec.integrations.apiTokenRef

AtlasProject.spec.integrations.licenseKeyRef

AtlasProject.spec.integrations.passwordRef

AtlasProject.spec.integrations.readTokenRef

AtlasProject.spec.integrations.routingKeyRef

AtlasProject.spec.integrations.secretRef

AtlasProject.spec.integrations.serviceKeyRef

AtlasProject.spec.integrations.writeTokenRef

AtlasProject.spec.maintenanceWindow

AtlasProject.spec.networkPeers

AtlasProject.spec.privateEndpoints

AtlasProject.spec.privateEndpoints.endpoints

AtlasProject.spec.projectIpAccessList

AtlasProject.spec.settings

AtlasProject.spec.teams

AtlasProject.spec.teams.teamRef

AtlasProject.spec.x509CertRef

AtlasProject.status

AtlasProject.status.conditions

AtlasProject.status.alertConfigurations

AtlasProject.status.alertConfigurations.currentValue

AtlasProject.status.alertConfigurations.matchers

AtlasProject.status.alertConfigurations.metricThreshold

AtlasProject.status.alertConfigurations.notifications

AtlasProject.status.alertConfigurations.threshold

AtlasProject.status.cloudProviderIntegrations

AtlasProject.status.cloudProviderIntegrations.featureUsages

AtlasProject.status.customRoles

AtlasProject.status.expiredIpAccessList

AtlasProject.status.networkPeers

AtlasProject.status.privateEndpoints

AtlasProject.status.privateEndpoints.endpoints

AtlasProject.status.prometheus

AtlasProject.status.teams

AtlasProject.status.teams.teamRef

カスタムリソースはデフォルトでオブジェクトを削除しなくなりました

サードパーティアラートの構成例