AtlasProject カスタム リソース

例

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

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

チームの例

The following example shows an AtlasProject custom resource specification that gives the green-leaf-team the Organization Owner role for this project. The team members are defined in the AtlasTeam custom resource.

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

プロジェクト設定の例

The following example shows an AtlasProject custom resource specification that disables the collection of database statistics in cluster metrics, data explorer, Performance Advisor, Realtime Performance Panel, and Schema Advisor.

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

パラメーター

このセクションでは、 AtlasProjectのカスタム リソース パラメータについて説明します。

spec.name

型: string

必須

Atlas で作成または更新されたプロジェクトの名前。名前の長さは 64 文字を超えてはなりません。名前には、文字、数字、スペース、ダッシュ、アンダースコアのみを含めることができます。プロジェクト作成後は変更できません。

spec.alertConfigurations

タイプ: オブジェクトの配列

任意

List that contains alert configurations for this project.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

この設定を省略したり空のままにしたりすると、Atlas Kubernetes Operator はプロジェクトのアラート構成を変更しません。 プロジェクトを作成する場合、Atlas はデフォルトのプロジェクト アラート構成を適用します。

spec.alertConfigurations.eventTypeName

タイプ: string

必須

このアラート構成で説明されるアラートをトリガーするイベント。

Atlas Kubernetes Operator が受け入れる値の詳細については、MongoDB Atlas Administration API ドキュメントの「 1 つのプロジェクトに 1 つのアラート構成を作成する 」のリクエスト ボディ スキーマを参照してください。

spec.alertConfigurations.enabled

タイプ: ブール値

任意

デフォルト: false

このアラート構成が有効になっているかどうかを示すフラグ。 省略した場合、デフォルトはfalseになります。

spec.alertConfigurations.matchers

タイプ: オブジェクトの配列

条件付き

List of rules that determine whether Atlas checks an object for the alert configuration. You can filter using the matchers array if spec.alertConfigurations.eventTypeName specifies an event for a host, replica set, or sharded cluster.

spec.alertConfigurations.matchers.fieldName

タイプ: string

条件付き

Atlas がチェックするターゲット オブジェクト内のパラメーターを識別する、人間が判読可能なラベル。 Atlas がアラート構成をチェックするには、パラメーターがすべてのルールに一致する必要があります。

Atlas Kubernetes Operator は、次の値を受け入れます。

• CLUSTER_NAME

• HOSTNAME

• HOSTNAME_AND_PORT

• PORT

• REPLICA_SET_NAME

• SHARD_NAME

• TYPE_NAME

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.operator

タイプ: string

条件付き

Comparison operator to apply when checking the current metric value against spec.alertConfigurations.matchers.value.

Atlas Kubernetes Operator は、次の値を受け入れます。

• EQUALS

• CONTAINS

• STARTS_WITH

• ENDS_WITH

• NOT_EQUALS

• NOT_CONTAINS

• REGEX

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.value

タイプ: string

条件付き

Value to match or exceed using the specified spec.alertConfigurations.matchers.operator.

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.metricThreshold

型: オブジェクト

条件付き

超えた場合にアラートをトリガーするメトリクスのしきい値。

Atlas Kubernetes Operator requires this setting when spec.alertConfigurations.eventTypeName is OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.metricThreshold.metricName

タイプ: string

条件付き

Human-readable label that identifies the metric against which Atlas checks the configured spec.alertConfigurations.metricThreshold.threshold.

Atlas Kubernetes Operator が受け入れる値の詳細については、MongoDB Atlas Administration API ドキュメントの「 1 つのプロジェクトに 1 つのアラート構成を作成する 」のリクエスト ボディ スキーマを参照してください。

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.mode

タイプ: string

任意

デフォルト: AVERAGE

Atlas は現在のメトリクス値を平均として計算します。

Atlas Kubernetes Operator はAVERAGEの値のみを受け入れます。

spec.alertConfigurations.metricThreshold.operator

タイプ: string

条件付き

現在のメトリクス値をチェックするときに適用する比較演算子。

Atlas Kubernetes Operator は、次の値を受け入れます。

• GREATER_THAN

• LESS_THAN

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.threshold

型: 整数

条件付き

超えた場合にアラートをトリガーするメトリクスの値。

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.units

タイプ: string

条件付き

量をExpressために使用される要素。 この値は、時間やストレージ容量などの要素になる可能性があります。

Atlas Kubernetes Operator は、次の値を受け入れます。

• BITS

• BYTES

• DAYS

• GIGABITS

• GIGABYTES

• HOURS

• KILOBITS

• KILOBYTES

• MEGABITS

• MEGABYTES

• MILLISECONDS

• MINUTES

• PETABYTES

• RAW

• SECONDS

• TERABYTES

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.notifications

タイプ: 配列

条件付き

このアラート構成で説明されているアラートについて Atlas が送信する通知を説明するリスト。

spec.alertConfigurations.notifications.apiTokenRef.name

型: string

条件付き

SlackのAPIトークンを持つ単一の フィールドを含む opaque secret の名前。password

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

Slack 経由の通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.apiTokenRef.namespace

型: string

条件付き

Slack の API トークンを含む名前空間。 Slack 経由の通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.channelName

タイプ: string

条件付き

Atlas がアラート通知を送信する Slack チャンネルを識別する、人間に判読可能なラベル。

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to SLACK.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

型: string

条件付き

DataDog のAPIキーを持つ単一の passwordフィールドを含むオペレーターのシークレットの名前。DataDog を介した通知が必要な場合は、この設定を指定する必要があります。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.datadogApiKeyRef.namespace

型: string

条件付き

Datadog の API キーを含む名前空間。 Datadog を介した通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.datadogRegion

タイプ: string

任意

デフォルト: US

使用する API URL（Uniform Resource Locator）を示す Datadog リージョン。

Atlas Kubernetes Operator は、次の値を受け入れます。

• US

• EU

spec.alertConfigurations.notifications.delayMins

型: 整数

任意

デフォルト: 0

Atlas がアラート条件を検出してから最初の通知を送信するまでに待機する時間（分）。

spec.alertConfigurations.notifications.emailAddress

タイプ: string

条件付き

Atlas がアラート通知を送信するメールアドレス。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to EMAIL.

Atlas Kubernetes Operator doesn't require this setting to send email notifications when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

• USERS

To send emails to one Atlas user or group of users, set the spec.alertConfigurations.notifications.emailEnabled parameter.

spec.alertConfigurations.notifications.emailEnabled

タイプ: ブール値

条件付き

Atlas がメール通知を送信するかどうかを示すフラグ。

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

spec.alertConfigurations.notifications.intervalMin

型: 整数

任意

連続する通知までの待機時間（分）。 Atlas は、未確認のアラートを確認するまで通知を送信します。 Atlas Kubernetes Operator は、 5以上の値を受け入れます。

PagerDuty、VictorOps、および Opsgenie の通知では、このフィールドは使用されません。 これらの各サービス内で通知間隔を構成および管理します。

spec.alertConfigurations.notifications.microsoftTeamsWebhookUrl

タイプ: string

条件付き

Atlas が Microsoft Teams 経由でこの通知を送信する必要がある Microsoft Teams WebhookUniform Resource Locator（URL）。 後で URL が無効になった場合、Atlas はプロジェクト所有者にメールを送信します。 キーが無効なままの場合、Atlas はキーを削除します。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to MICROSOFT_TEAMS.

spec.alertConfigurations.notifications.mobileNumber

タイプ: string

条件付き

Atlas がアラート通知を送信する携帯電話番号。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to SMS.

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

型: string

条件付き

Opsgenie のAPIキーを持つ単一の passwordフィールドを含む opaque secret の名前。Opsgenie を介した通知が必要な場合は、この設定を指定する必要があります。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.opsGenieApiKeyRef.namespace

型: string

条件付き

Opsgenie の API キーを含む名前空間。 Opsgenie を介した通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.opsGenieRegion

タイプ: string

任意

デフォルト: US

使用する API Uniform Resource Locator（URL）を示す Opsgenie リージョン。

Atlas Kubernetes Operator は、次の値を受け入れます。

• US

• EU

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to OPS_GENIE.

spec.alertConfigurations.notifications.roles

タイプ: 配列

任意

構成されたアラートを受信する 1 件以上の組織またはプロジェクト ロールを含むリスト。 このパラメーターを含めると、Atlas は、リストで指定したロールを割り当てられたユーザーにのみアラートを送信します。 このパラメーターを省略すると、Atlas は任意のロールを割り当てられたユーザーにアラートを送信します。

Atlas Kubernetes Operator は、次の値を受け入れます。

• GROUP_CLUSTER_MANAGER

• GROUP_DATA_ACCESS_ADMIN

• GROUP_DATA_ACCESS_READ_ONLY

• GROUP_DATA_ACCESS_READ_WRITE

• GROUP_OWNER

• GROUP_READ_WRITE

• ORG_OWNER

• ORG_MEMBER

• ORG_GROUP_CREATOR

• ORG_BILLING_ADMIN

• ORG_READ_ONLY

Atlas Kubernetes Operator applies this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

型: string

条件付き

PagerDuty のAPIキーを持つ単一の フィールドを含む opaque secret の名前。passwordPagerDuty による通知が必要な場合は、この設定を指定する必要があります。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.serviceKeyRef.namespace

型: string

条件付き

PagerDuty の API キーを含む名前空間。 PagerDuty による通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.smsEnabled

タイプ: ブール値

条件付き

Atlas がテキスト メッセージ通知を送信するかどうかを示すフラグ。

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

spec.alertConfigurations.notifications.teamId

タイプ: string

条件付き

1 つの チームを識別する一意な 24 桁の 16stringAtlas 進数の 。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.teamName

タイプ: string

条件付き

この通知を受信する Atlas チームの名前。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.typeName

タイプ: string

条件付き

Human-readable label that displays the alert notification type. This setting is required if you specify a value for the spec.alertConfigurations.notifications setting. Atlas supports the following values:

• DATADOG

• EMAIL

• OPS-GENIE

• ORG

• PAGER_DUTY

• PROMETHEUS

• SLACK

• SMS

• TEAM

• USER

• VICTOR_OPS

• WEBHOOK

spec.alertConfigurations.notifications.username

タイプ: string

条件付き

Atlas が通知を送信するユーザーの Atlas ユーザー名。 アラート構成を所有するプロジェクトに属する Atlas ユーザーのみを指定します。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to USER.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

型: string

条件付き

Splunc オンコールのAPIキーを持つ単一の フィールドを含む opaque secret の名前。passwordSplunk On-Call による通知が必要な場合は、この設定を指定する必要があります。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.victorOpsSecretRef.namespace

型: string

条件付き

Splunk On-呼び出し用の API キーを含む名前空間。 Splunk On-Call による通知が必要な場合は、この設定を指定する必要があります。

spec.alertConfigurations.notifications.victorOpsRoutingKey

タイプ: string

条件付き

Atlas が Splunk On-Call にアラート通知を送信するために必要なルーティング キー。 後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信します。 キーが無効なままの場合、Atlas はキーを削除します。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to VICTOR_OPS.

spec.alertConfigurations.notifications.webhookSecret

タイプ: string

任意

Webhook ベースのアラートの認証シークレット。

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.notifications.webhookUrl

タイプ: string

条件付き

Webhook URL を示す string。

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.severityOverride

タイプ: string

条件付き

Overrides the Atlas-assigned default severity level for a project alert.

Atlas Kubernetes Operator は、次の値を受け入れます。

• CRITICAL

• ERROR

• WARNING

• INFO

spec.alertConfigurations.threshold

型: オブジェクト

条件付き

超えたときにアラートをトリガーする制限。

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.eventTypeName to a value other than OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.threshold.operator

タイプ: string

条件付き

Atlas が現在のメトリクス値をチェックするときに適用する比較演算子。

Atlas Kubernetes Operator は、次の値を受け入れます。

• GREATER_THAN

• LESS_THAN

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurations.threshold.threshold

型: 整数

条件付き

超えた場合にアラートをトリガーするメトリクスの値。

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurations.threshold.units

タイプ: string

条件付き

量を表す要素。 時間、ストレージ容量などの要素を指定できます。

Atlas Kubernetes Operator は、次の値を受け入れます。

• BITS

• BYTES

• DAYS

• GIGABITS

• GIGABYTES

• HOURS

• KILOBITS

• KILOBYTES

• MEGABITS

• MEGABYTES

• MILLISECONDS

• MINUTES

• PETABYTES

• RAW

• SECONDS

• TERABYTES

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurationSyncEnabled

タイプ: ブール値

任意

デフォルト: false

Flag that indicates whether Atlas Kubernetes Operator applies the project alert settings defined in spec.alertConfigurations. If you omit or set to this parameter to false, Atlas Kubernetes Operator doesn't synchronize the project's alert configurations with the ones that you define in the AtlasProject custom resource.

For information on how this setting interacts with spec.withDefaultAlertsSettings, see the Considerations.

spec.auditing.auditAuthorizationSuccess

タイプ: ブール値

任意

デフォルト: false

Flag that indicates whether to direct the auditing system to capture successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. To set this parameter to true, you must set spec.auditing.enabled to true. To learn more, see auditAuthorizationSuccess.

警告: auditAuthorizationSuccessを有効にすると、クラスターのパフォーマンスに重大な影響を与える可能性があります。 このオプションを有効にする場合は注意が必要です。

spec.auditing.auditFilter

型: string

任意

JSON-formatted auditing filter. You might need to escape the JSON string to remove characters that could prevent parsing, such as single or double-quotes. To specify a value for this setting, you must set spec.auditing.enabled to true.

監査フィルターの例を表示するには、「 監査フィルターの例」を参照してください。 MongoDB 監査フィルターの構成の詳細については、「カスタム監査フィルターを構成する 」を参照してください。

spec.auditing.enabled

タイプ: ブール値

条件付き

デフォルト: false

Flag that indicates whether to enable auditing for the project. To specify a value for spec.auditing.auditFilter, or to set spec.auditing.auditAuthorizationSuccess to true, you must specify this setting. To learn more, see Enable Audit Logs.

spec.backupCompliancePolicyRef

型: オブジェクト

条件付き

カスタム リソース を参照する opaque secret AtlasBackupCompliancePolicyの名前と名前空間を含むオブジェクト。バックアップ コンプライアンス ポリシーを有効にする場合は、このパラメーターを指定する必要があります。

spec.backupCompliancePolicyRef.name

型: string

条件付き

カスタムAtlasBackupCompliancePolicy リソース を参照する opaque secret の名前。バックアップ コンプライアンス ポリシーを有効にする場合は、このパラメーターを指定する必要があります。

spec.backupCompliancePolicyRef.namespace

型: オブジェクト

条件付き

カスタム リソース を参照するAtlasBackupCompliancePolicy opaque secret の名前空間。バックアップ コンプライアンス ポリシーを有効にする場合は、このパラメーターを指定する必要があります。

spec.connectionSecretRef.name

型: string

任意

Atlas Kubernetes Operator がpassword Atlas への接続に使用する組織IDとAPIキーを持つ単一の フィールドを含む opaque シークレットの名前。指定しない場合、Atlas Kubernetes Operator はデフォルトのglobal シークレットを使用します。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

デフォルトでは 、Atlas Kubernetes Operator は カスタム AtlasProjectリソースと同じ名前空間に接続シークレットを保持します。シークレットを別の名前空間に保存するには、 spec.connectionSecretRef.namespaceパラメータを指定します。

spec.connectionSecretRef.namespace

型: string

任意

Atlas Kubernetes Operator が Atlas に接続するために使用する組織IDとAPIキーのシークレットを含む名前空間。指定しない場合、Atlas Kubernetes Operator は AtlasProjectカスタム リソースと同じ名前空間に接続シークレットを保持します。

spec.cloudProviderAccessRoles

タイプ: 配列

Deprecated. Use spec.cloudProviderIntegrations instead.

統合クラウドプロバイダーのアクセス設定を含むリスト。

spec.cloudProviderAccessRoles.iamAssumedRoleArn

型: string

Deprecated. Use spec.cloudProviderIntegrations.iamAssumedRoleArn instead.

が引き受ける IAM アクセス ロールを識別する一意のAmazon Web Services ARNAtlas 。統合クラウドプロバイダー アクセスを設定する場合は、この設定を指定する必要があります。

spec.cloudProviderAccessRoles.providerName

型: string

Deprecated. Use spec.cloudProviderIntegrations.providerName instead.

Atlas が引き受けるアクセス ロールのクラウドプロバイダー。 Atlas Kubernetes Operator は、統合クラウドプロバイダー アクセスのためのAWSをサポートしています。 統合クラウドプロバイダー アクセスを設定する場合は、この設定を指定する必要があります。

spec.cloudProviderIntegrations

タイプ: 配列

任意

統合されたクラウドプロバイダー統合設定を含むリスト。

spec.cloudProviderIntegrations.iamAssumedRoleArn

型: string

条件付き

が引き受ける IAM アクセス ロールを識別する一意のAmazon Web Services ARNAtlas 。統合クラウドプロバイダー統合を設定する場合は、この設定を指定する必要があります。

spec.cloudProviderIntegrations.providerName

型: string

条件付き

Atlas が引き受けるアクセス ロールのクラウドプロバイダー。 Atlas Kubernetes Operator は、統合クラウドプロバイダー統合のためのAWSをサポートしています。 統合クラウドプロバイダー統合を設定する場合は、この設定を指定する必要があります。

spec.customRoles

型: オブジェクト

任意

非推奨

重要

Atlas Kubernetes Operator 2.6 の場合、このパラメータは非推奨です。移行ガイド に従って、 AtlasPrivateEndpoint カスタム リソース に移行します。

カスタムロール仕様を含むオブジェクト。

spec.encryptionAtRest

タイプ: 配列

任意

プロジェクトのカスタマー マネージド キーを使用した保管時の暗号化の構成を含むリスト。

spec.encryptionAtRest.awsKms

型: オブジェクト

任意

プロジェクトの カスタマー マネージドAmazon Web ServicesKMS キーを使用した保管時の暗号化に使用するための設定を含むリスト。

spec.encryptionAtRest.enabled

タイプ: ブール値

任意

このプロジェクトが AWS KMS を使用して保管中のデータを暗号化しているかどうかを示すフラグ。Amazon Web Services KMS を使用して保管時の暗号化を有効にするには、このパラメーターを true に設定します。Amazon Web ServicesKMS を使用して保管時の暗号化を無効にするには、このパラメーターを false に設定します。Amazon Web Services KMSで保管時の暗号化を無効にすると、Atlas Kubernetes Operator は構成詳細を削除します。

spec.encryptionAtRest.awsKms.region

型: string

任意

Label that indicates the AWS region where the customer master key exists.

spec.encryptionAtRest.awsKms.secretRef.name

型: string

任意

Amazon Web Services の認証情報を含む不透明な シークレット の名前。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.awsKms.secretRef.namespace

型: string

任意

Amazon Web Servicesの認証情報を含む名前空間。指定しない場合、このパラメータはデフォルトでは AtlasProject カスタム リソースの名前空間になります。

spec.encryptionAtRest.azureKeyVault

型: オブジェクト

任意

プロジェクトの カスタマー マネージド キーを使用した保管時の暗号化に Azure Key Vault を使用するための構成を含むリスト。

spec.encryptionAtRest.azureKeyVault.azureEnvironment

型: string

任意

Azure アカウントの認証情報が存在する Azure 配置ロケーション。有効な値は AZURE、AZURE_CHINA と AZURE_GERMANY です。

spec.encryptionAtRest.azureKeyVault.clientID

型: string

任意

Azure アプリケーションを識別する一意の 36 桁の 16 進数文字列。

spec.encryptionAtRest.azureKeyVault.enabled

タイプ: ブール値

任意

このプロジェクトがAzureキーヴォールトを使用してAzureキーを使用しているかどうかを示すフラグ。Atlas Kubernetes Operator は構成の詳細を削除します。

spec.encryptionAtRest.azureKeyVault.resourceGroupName

型: string

任意

あなたの Azure Key Vault が含まれている Azure リソース グループを識別するラベル。Azure は、リソース グループの [詳細] ページにリソース グループ名を表示します。

spec.encryptionAtRest.azureKeyVault.secretRef.name

型: string

任意

Azure 認証情報を含むオペーク シークレット の名前。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.azureKeyVault.secretRef.namespace

型: string

任意

Azure認証情報を含む名前空間。指定しない場合、このパラメータはデフォルトでは AtlasProject カスタム リソースの名前空間になります。

spec.encryptionAtRest.azureKeyVault.tenantID

型: string

任意

Azureサブスクリプション内のAzure 36Active Directory テナントを識別する一意の 桁の 16 進数文字列。Azure は、テナント プロパティ ページにテナントIDを表示します。

spec.encryptionAtRest.googleCloudKms

型: オブジェクト

任意

プロジェクトの カスタマーGoogle Cloud PlatformKMS マネージド キーを使用した保管時の暗号化に使用するための構成を含むリスト。

spec.encryptionAtRest.googleCloudKms.enabled`

型: string

任意

このプロジェクトが Google Cloud KMS を使用して保管中のデータを暗号化しているかどうかを示すフラグ。Google Cloud Platform KMS で保管時の暗号化を有効にするには、このパラメータを true に設定します。Google Cloud Platform の KMS を使用して保管時の暗号化を無効にするには、このパラメーターを false に設定します。Google Cloud Platform KMS を使用して保管時の暗号化を無効にすると、Atlas Kubernetes Operator は構成の詳細を削除します。

spec.encryptionAtRest.googleCloudKms.secretRef.name

型: string

任意

Google Cloud Platform の認証情報を含むオペレーターのシークレットの名前。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.googleCloudKms.secretRef.namespace

型: string

任意

Google Cloud Platformの認証情報を含む名前空間。 指定されていない場合、このパラメータはデフォルトでAtlasProjectカスタム リソースの名前空間になります。

spec.integrations

タイプ: 配列

任意

非推奨

重要

Atlas Kubernetes Operator 2.9 の場合、このパラメータは非推奨です。移行ガイドに従って、AtlasThirdPartyIntegration カスタムリソースに移行します。

サードパーティ統合設定を含むリスト。

spec.maintenanceWindow

型: オブジェクト

任意

メンテナンスウィンドウの設定を含むリスト。 次の本体パラメータを指定できます。

名前	タイプ	必要性	説明
dayOfWeek	数値	必須	メンテナンスウィンドを開始する曜日（1 から始まる整数）。 Day of Week 整数 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday 7
hourOfDay	数値	必須	メンテナンスウィンドウを開始する時刻。 このパラメーターは 24 時間制を使用します。ここでは、真夜中は0 、正午は12です。
autoDeferOnceEnabled	ブール値	任意	すべてのメンテナンスWindowsがトリガーされるかどうかを示すフラグ。

重要

メンテナンスウィンドウに関する考慮事項

至急の整備アクティビティ

セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。 Atlas は必要に応じてこれらのメンテナンス アクティビティを開始します。

継続的なメンテナンス操作

クラスターのメンテナンスがスケジュールされると、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。

メンテナンスにはレプリカセットの選択が必要

Atlas は、 MongoDB マニュアルに記載されているメンテナンス手順と同じ方法でメンテナンスを実行します。 この手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。

メンテナンスは可能な限り時刻に近い時間に開始

メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。

spec.maintenanceWindow.autoDefer

タイプ: ブール値

条件付き

AtlasがすべてのメンテナンスWindowsを有効にしてから 1 週間延期するかどうかを示すフラグ。

spec.maintenanceWindow.defer

タイプ: ブール値

条件付き

Flag that indicates whether Atlas should defer scheduled maintenance. You must schedule maintenance before you can successfully defer maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

重要

While spec.maintenanceWindow.defer is set to true, Atlas Kubernetes Operator defers scheduled maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.defer to true, you should change spec.maintenanceWindow.defer to false after you apply changes.

spec.maintenanceWindow.dayOfWeek

タイプ: 数値

条件付き

メンテナンスウィンドが開始される曜日を表す 1 から始まる整数。 次の表を使用して、各日に対応する整数を見つけます。

Day of Week	整数
Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

プロジェクトのメンテナンスウィンドウを設定する場合は、この設定を指定する必要があります。

spec.maintenanceWindow.hourOfDay

タイプ: 数値

条件付き

メンテナンス ウィンドウが開始される時刻を 24 時間制で表す 0 から始まる整数。 真夜中には0を使用し、正午には12を使用します。 プロジェクトのメンテナンスウィンドウを設定する場合は、この設定を指定する必要があります。

spec.maintenanceWindow.startASAP

タイプ: ブール値

条件付き

Flag that indicates whether Atlas should immediately start maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

重要

While spec.maintenanceWindow.startASAP is set to true, Atlas Kubernetes Operator starts maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.startASAP to true, you should change spec.maintenanceWindow.startASAP to false after you apply changes.

spec.networkPeers

タイプ: 配列

任意

非推奨

重要

Atlas Kubernetes Operator 2.8 の場合、このパラメータは非推奨です。移行ガイド に従って、 AtlasNetworkPeering および AtlasNetworkContainer のカスタム リソースに移行します。

プロジェクトのネットワークピアリング構成が格納されたリスト。

spec.regionUsageRestrictions

型: string

任意

Atlas for Government のみのプロジェクトのリージョンを指定します。次のいずれかの値を指定できます。

• NONE:プロジェクトにはリージョン使用の制限はありません。これはデフォルト値です。

• GOV_REGIONS_ONLY: 指定した政府クラウドリージョンにプロジェクトを制限します。

• COMMERCIAL_FEDRAMP_REGIONS_ONLY:プロジェクトがAmazon Web Services FedRamp Moderate 標準リージョンに制限されていることを示します。

spec.projectIpAccessList

タイプ: 配列

必須

非推奨

重要

Atlas Kubernetes Operator 2.7 の場合、このパラメータは非推奨です。移行ガイド に従って、 AtlasIPAccessList カスタム リソース に移行します。

プロジェクト内の Atlas クラスターへのネットワークアクセスを許可する IP アクセス リスト。 次の本体パラメータを指定できます。

Parameter	タイプ	必要性	説明
awsSecurityGroup	string	条件付き	アクセス リストに追加するAmazon Web Servicesセキュリティ グループの一意の識別子。 アクセス リスト エントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。 You must configure VPC peering for your project before you can add an AWS security group to an access list.
cidrBlock	string	条件付き	アクセス リストに追加するCIDR表記の IP アドレスの範囲。 アクセス リスト エントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。
comment	string	任意	アクセス リスト エントリに関連付けられたコメント。
deleteAfterDate	date	任意	Timestamp in ISO 8601 date and time format in UTC after which Atlas removes the entry from the access list. The specified date must be in the future and within one week of the time you make the API request. 重要: Amazon Web Servicesのセキュリティ グループを一時的なアクセスリスト エントリとして設定することはできません。 ISO 8601 タイムゾーン指定子を含めて、指定されたタイムゾーンのローカルタイムに有効期限が発生するようにします。
ipAddress	string	条件付き	アクセス リストに追加する単一の IP アドレス。 awsSecurityGroupおよびcidrBlockと相互に排他的です。 アクセス リスト エントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。

spec.settings

型: オブジェクト

任意

プロジェクト設定を含むリスト。

spec.settings.isCollectDatabaseSpecificsStatisticsEnabled

タイプ: ブール値

任意

プロジェクトでクラスター メトリクス内のデータベース統計のコレクションが有効になっているかどうかを示すフラグ。

spec.settings.isDataExplorerEnabled

タイプ: ブール値

任意

プロジェクトでデータ エクスプローラーが有効になっているかどうかを示すフラグ。

spec.settings.isExtendedStorageSizesEnabled

タイプ: ブール値

任意

Flag that indicates whether to enable extended storage sizes for the specified project. To learn more about enabling extended storage, see Manage Project Settings.

spec.settings.isPerformanceAdvisorEnabled

タイプ: ブール値

任意

Flag that indicates whether your project has Performance Advisor enabled.

spec.settings.isRealtimePerformancePanelEnabled

タイプ: ブール値

任意

Flag that indicates whether your project has Realtime Performance Panel enabled.

spec.settings.isSchemaAdvisorEnabled

タイプ: ブール値

任意

プロジェクトでSchema アドバイザーが有効になっているかどうかを示すフラグ。

spec.privateEndpoints

タイプ: 配列

任意

非推奨

重要

Atlas Kubernetes Operator 2.6 の場合、このパラメータは非推奨です。移行ガイド に従って、 AtlasPrivateEndpoint カスタム リソース に移行します。

プロジェクトのプライベートエンドポイント構成が格納されたリスト。

spec.teams

型: オブジェクト

任意

チームの仕様を含むオブジェクト。 詳しくは、「チームの構成 」を参照してください。

spec.teams.teamRef.name

型: string

条件付き

フィールドのAtlasTeam metadata.nameカスタム リソースからの、人間が判読可能なラベル。このプロジェクトにチームを割り当てる 場合は、この設定を指定する必要があります。

spec.teams.teamRef.namespace

型: string

条件付き

default以外の場合は、 AtlasTeamのカスタム リソースで指定される名前空間。

spec.teams.teamRef.roles

型: string

条件付き

Atlas User Roles that a team uses for this project. If you want to assign a team to this project, you must specify this setting.

spec.withDefaultAlertsSettings

タイプ: ブール値

任意

デフォルト: true

Flag that indicates whether Atlas Kubernetes Operator creates a project with the default alert configurations. If omitted, defaults to true.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

プロジェクトを作成するときにこのパラメータをfalseに設定すると、Atlas はデフォルトのアラート構成をプロジェクトに追加しません。

この設定は既存のプロジェクトには影響しません。

For information on how this setting interacts with spec.alertConfigurationSyncEnabled, see the Considerations.

spec.x509CertRef.name

型: string

任意

kubernetes.io/tlsX.509 証明書の シークレットの名前。

Atlas Kubernetes Operator atlas.mongodb.com/type=credentialsは、不要な シークレット の監視を回避するために、ラベル のシークレットのみを監視します。

次の例ではシークレットにラベルを付けます。

kubectl label secret the-user-password atlas.mongodb.com/type=credentials