`AtlasProject` カスタムリソース

項目一覧

Prometheus の例
チームの例
メンテナンスウィンドウの例
プロジェクト設定の例
アラート構成の例
サードパーティアラートの構成例
パラメーター

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

重要

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

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

spec.connectionSecretRef.nameパラメータを使用して接続シークレットを設定できますカスタムAtlasProject リソースのこのパラメータは、デフォルトのglobal 接続シークレットを上書きします。

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

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

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

パラメータを持つ IP アクセスリスト spec.projectIpAccessList。この IP アクセスリストは、プロジェクト内の Atlas クラスターへのネットワークアクセスを許可します。
パラメーターを持つ spec.teamsチーム。チームでは、特定のプロジェクトの Atlas ユーザーのグループ全体にアクセスロールを付与できます。
spec.maintenanceWindowパラメータを持つメンテナンスウィンドウ。メンテナンスウィンドウは、Atlas がデータベース配置の週次メンテナンスを開始する時間と日付を設定します。
パラメーターを使用した spec.networkPeersネットワークピアリング。ネットワークピアリングを使用すると、 Amazon Web Services 、 Azure 、またはGoogle Cloud Platform VPCに安全に接続できます。
パラメーターを指定した spec.encryptionAtRestカスタマーマネージドキーを使用した保管時の暗号化。カスタマーマネージドキーを使用した保管時の暗号化では、クラウドプロバイダーのKMSと MongoDB暗号化されたストレージエンジンを併用することで、セキュリティをさらに強化できます。
spec.privateEndpointsパラメーターを持つプライベートエンドポイント。
X. { spec.x509CertRef.nameパラメータを使用した509認証。
次の機能を有効および無効にする設定を含む、 spec.settingsパラメーターのプロジェクト設定。
- クラスターメトリクスでのデータベース統計のコレクション
- Data Explorer
- Performance Advisor
- リアルタイムパフォーマンスパネル
- スキーマアドバイザー
- プロジェクトは、 spec.alertConfigurationSyncEnabled } パラメーターとspec.alertConfigurationsパラメーターを持つ構成をアラートします。
  これらの設定がどのように影響するかについては、「考慮事項」を参照してください。

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

パラメーター

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

spec.name

型: string

必須

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

spec.alertConfigurations

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

任意

このプロジェクトのアラート構成が格納されているリスト。

この設定を使用する場合は、Atlas Kubernetes Operator がプロジェクトアラート構成を変更するために、 spec.alertConfigurationSyncEnabledをtrueに設定する必要もあります。

この設定を省略したり空のままにしたりすると、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

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

条件付き

Atlas がアラート構成のオブジェクトをチェックするかどうかを決定するルールのリスト。 spec.alertConfigurations.eventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定する場合は、マッチャー配列を使用してフィルタリングできます。

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 では、 spec.alertConfigurations.matchers配列にオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.matchers.operator

タイプ: string

条件付き

現在のメトリクス値をspec.alertConfigurations.matchers.valueと照合するときに適用する比較演算子。

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

EQUALS
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
NOT_CONTAINS
REGEX

Atlas Kubernetes Operator では、 spec.alertConfigurations.matchers配列にオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.matchers.value

タイプ: string

条件付き

指定されたspec.alertConfigurations.matchers.operatorを使用して、一致するかそれを超える値。

Atlas Kubernetes Operator では、 spec.alertConfigurations.matchers配列にオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.metricThreshold

型: オブジェクト

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.eventTypeNameがOUTSIDE_METRIC_THRESHOLDの場合にこの設定が必要です。

spec.alertConfigurations.metricThreshold.metricName

タイプ: string

条件付き

Atlas が設定されたspec.alertConfigurations.metricThreshold.thresholdをチェックするメトリクスを識別する、人間に判読可能なラベル。

Atlas Kubernetes Operator では、 spec.alertConfigurations.metricThresholdオブジェクトを含める場合にこの設定が必要です。

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 では、 spec.alertConfigurations.metricThresholdオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.metricThreshold.threshold

型: 整数

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.metricThresholdオブジェクトを含める場合にこの設定が必要です。

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 では、 spec.alertConfigurations.metricThresholdオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.notifications

タイプ: 配列

条件付き

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

spec.alertConfigurations.notifications.apiTokenRef.name

型: string

条件付き

不可視シークレットの名前password これには、Slack 用の API トークンを持つ単一のフィールドが含まれます。

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 では、 spec.alertConfigurations.notifications.typeNameをSLACKに設定する場合にこの設定が必要になります。

spec.alertConfigurations.notifications.datadogApiKeyRef.name

型: string

条件付き

不可視シークレットの名前password Datadog の API キーを持つ単一のフィールドを含む。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 では、 spec.alertConfigurations.notifications.typeNameをEMAILに設定する場合、この設定が必要です。

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameを次の値のいずれかに設定している場合、メール通知を送信するためにこの設定は必要ありません。

GROUP
ORG
TEAM
USERS

1 人のAtlas userまたはユーザーのグループにメールを送信するには、 spec.alertConfigurations.notifications.emailEnabledパラメータを設定します。

spec.alertConfigurations.notifications.emailEnabled

タイプ: ブール値

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameを次の値のいずれかに設定する場合にこの設定が必要になります。

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 では、 spec.alertConfigurations.notifications.typeNameをMICROSOFT_TEAMSに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.mobileNumber

タイプ: string

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameをSMSに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

型: string

条件付き

不可視シークレットの名前password これには、Opsgenie 用の API キーを持つ単一のフィールドが含まれます。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 は、 spec.alertConfigurations.notifications.typeNameを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 は、 spec.alertConfigurations.notifications.typeNameを次の値のいずれかに設定すると、この設定を適用します。

GROUP
ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

型: string

条件付き

不可視シークレットの名前password は、PagerDuty の API キーを持つ単一のフィールドを含みます。PagerDuty による通知が必要な場合は、この設定を指定する必要があります。

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

タイプ: string

任意

この通知に与えられた重大度の度。

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

CRITICAL
ERROR
WARNING

spec.alertConfigurations.notifications.smsEnabled

タイプ: ブール値

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameを次の値のいずれかに設定する場合にこの設定が必要になります。

GROUP
ORG
TEAM

spec.alertConfigurations.notifications.teamId

タイプ: string

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameをTEAMに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.teamName

タイプ: string

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameをTEAMに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.typeName

タイプ: string

条件付き

アラート通知のタイプを表示する、人間が判読可能なラベル。この設定は、 spec.alertConfigurations.notifications設定に値を指定する場合に必要です。 Atlas は次の値をサポートしています。

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 では、 spec.alertConfigurations.notifications.typeNameをUSERに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.victorOpsSecretRef.name

型: string

条件付き

不可視シークレットの名前password は、Splunk On-呼び出し用の API キーを持つ単一のフィールドを含みます。Splunk 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 では、 spec.alertConfigurations.notifications.typeNameをVICTOR_OPSに設定する場合、この設定が必要です。

spec.alertConfigurations.notifications.webhookSecret

タイプ: string

任意

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

Atlas Kubernetes Operator は、 spec.alertConfigurations.notifications.typeNameをWEBHOOKに設定するとこの設定を適用します。

spec.alertConfigurations.notifications.webhookUrl

タイプ: string

条件付き

Webhook URL を示す string。

Atlas Kubernetes Operator では、 spec.alertConfigurations.notifications.typeNameをWEBHOOKに設定する場合、この設定が必要です。

spec.alertConfigurations.threshold

型: オブジェクト

条件付き

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

Atlas Kubernetes Operator は、 spec.alertConfigurations.eventTypeNameをOUTSIDE_METRIC_THRESHOLD以外の値に設定するとこの設定を適用します。

spec.alertConfigurations.threshold.operator

タイプ: string

条件付き

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

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

GREATER_THAN
LESS_THAN

Atlas Kubernetes Operator では、 spec.alertConfigurations.thresholdオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurations.threshold.threshold

型: 整数

条件付き

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

Atlas Kubernetes Operator では、 spec.alertConfigurations.thresholdオブジェクトを含める場合にこの設定が必要です。

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 では、 spec.alertConfigurations.thresholdオブジェクトを含める場合にこの設定が必要です。

spec.alertConfigurationSyncEnabled

タイプ: ブール値

任意

デフォルト: false

Atlas Kubernetes Operator がspec.alertConfigurationsで定義されたプロジェクトアラート設定を適用するかどうかを示すフラグ。このパラメータを省略するか、 falseに設定すると、Atlas Kubernetes Operator はプロジェクトのアラート構成をAtlasProjectカスタムリソースで定義した構成と同期しません。

この設定とspec.withDefaultAlertsSettingsとの相互作用については、考慮事項を参照してください。

spec.auditing.auditAuthorizationSuccess

タイプ: ブール値

任意

デフォルト: false

"atype" : "authCheck"監査イベントを使用して、監査フィルターの成功した認証試行をキャプチャするように監査システムに指示するかどうかを示すフラグ。このパラメータをtrueに設定するには、 spec.auditing.enabledをtrueに設定する必要があります。詳細については、「 auditAuthorizationSuccess 」を参照してください。

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

spec.auditing.auditFilter

型: string

任意

JSON 形式の監査フィルター。一重引用符や二重引用符など、解析を妨げる可能性のある文字を削除するには、JSON string をエスケープする必要がある場合があります。この設定の値を指定するには、 spec.auditing.enabledをtrueに設定する必要があります。

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

spec.auditing.enabled

タイプ: ブール値

条件付き

デフォルト: false

プロジェクトの監査を有効にするかどうかを示すフラグ。 spec.auditing.auditFilterの値を指定するか、 spec.auditing.auditAuthorizationSuccessをtrueに設定するには、この設定を指定する必要があります。詳細については、「監査ログの有効化」を参照してください。

spec.backupCompliancePolicyRef

型: オブジェクト

条件付き

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

spec.backupCompliancePolicyRef.name

型: string

条件付き

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

spec.backupCompliancePolicyRef.namespace

型: オブジェクト

条件付き

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

spec.connectionSecretRef.name

型: string

任意

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

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

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

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

spec.connectionSecretRef.namespace

型: string

任意

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

spec.cloudProviderAccessRoles

タイプ: 配列

非推奨。代わりにspec.cloudProviderIntegrationsを使用してください。

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

spec.cloudProviderAccessRoles.iamAssumedRoleArn

型: string

非推奨。代わりにspec.cloudProviderIntegrations.iamAssumedRoleArnを使用してください。

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

spec.cloudProviderAccessRoles.providerName

型: string

非推奨。代わりにspec.cloudProviderIntegrations.providerNameを使用してください。

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

型: オブジェクト

任意

カスタムロール仕様を含むオブジェクト。詳細については、「カスタムデータベースロールの構成」を参照してください。

spec.customRoles.roleName

型: string

任意

カスタムロールを識別する、人間が判読可能なラベル。

重要

指定されたロール名には、文字、数字、アンダースコア、ダッシュのみを含めることができます。また、次のいずれかの条件を満たすロール名は指定できません。

プロジェクト内の既存のカスタムロールで既に使用されている名前
組み込みロールの名前です
とは atlasAdmin
で始まる xgen-

spec.customRoles.actions

タイプ: 配列

任意

ロールが付与する個々の特権アクションを表すオブジェクトのリスト。

spec.customRoles.actions.action

型: string

任意

特権アクションを識別する、人間が判読可能なラベル。 Atlas Administration API で利用できるアクションの完全なリストについては、 /reference/custom-role-actions を参照してください。

spec.customRoles.actions.resources

タイプ: 配列

任意

アクションが付与されるデータベースとコレクションを示す、またはクラスターリソースにアクションが付与されていることを示すオブジェクトのリスト。

spec.customRoles.actions.resources.cluster

タイプ: ブール値

任意

アクションがクラスターリソースに対して付与されていることを示すフラグ。

注意

このパラメーターは、 spec.customRoles.actions.resources.collectionパラメーターおよびspec.customRoles.actions.resources.dbパラメーターと相互に排他的です。

spec.customRoles.actions.resources.collection

型: string

任意

アクションが付与されるコレクションを識別する、人間が判読可能なラベル。この値が空の string の場合、 spec.customRoles.actions.resources.dbパラメータで指定されたデータベース内のすべてのコレクションに対してアクションが付与されます。

注意

このパラメーターはspec.customRoles.actions.resources.clusterパラメーターと相互に排他的です。

spec.customRoles.actions.resources.db

型: string

任意

アクションが付与されるデータベースを識別する、人間が判読可能なラベル。

注意

このパラメーターはspec.customRoles.actions.resources.clusterパラメーターと相互に排他的です。

spec.customRoles.inheritedRoles

タイプ: 配列

任意

継承されたロールと、そのロールが付与されているデータベースを示すキーと値のペアを表すオブジェクトのリスト。

spec.customRoles.inheritedRoles.db

型: string

任意

継承されたロールが付与されるデータベースを識別する、人間が判読可能なラベル。

注意

この値は、読み取りとreadWriteを除くすべてのロールでadminである必要があります。

spec.customRoles.inheritedRoles.role

型: string

任意

継承されたロールを識別する、人間が判読可能なラベル。別のカスタムロールまたは組み込みロールを指定できます。

spec.encryptionAtRest

タイプ: 配列

任意

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

spec.encryptionAtRest.awsKms

型: オブジェクト

任意

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

spec.encryptionAtRest.enabled

タイプ: ブール値

任意

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

spec.encryptionAtRest.awsKms.region

型: string

任意

CMK が存在するAmazon Web Servicesリージョンを示すラベル。

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

任意

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

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

任意

Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription. Azureは、テナントプロパティページにテナント ID を表示します。

spec.encryptionAtRest.googleCloudKms

型: オブジェクト

任意

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

spec.encryptionAtRest.googleCloudKms.enabled`

型: string

任意

このプロジェクトがGoogle Cloud Platform 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

タイプ: 配列

任意

サードパーティ統合設定を含むリスト。指定する必要があるパラメーターは、設定するサードパーティサービスによって異なります。

サービス	設定
すべて	`spec.integrations.type`
Datadog	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
Microsoft Teams	`spec.integrations.microsoftTeamsWebhookURL`
Opsgenie	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
PagerDuty	`spec.integrations.serviceKeyRef.name` `spec.integrations.serviceKeyRef.namespace`
Prometheus	`spec.integrations.enabled` `spec.integrations.passwordRef.name` `spec.integrations.passwordRef.namespace` `spec.integrations.scheme` `spec.integrations.serviceDiscovery` `spec.integrations.username`
Slack	`spec.integrations.apiTokenRef.name` `spec.integrations.apiTokenRef.namespace`
VictorOps	`spec.integrations.apiKeyRef.name` `spec.integrations.routingKeyRef.name` `spec.integrations.routingKeyRef.namespace`
Webhook 設定	`spec.integrations.secretRef.name` `spec.integrations.secretRef.namespace` `spec.integrations.url`

spec.integrations.accountId

型: string

条件付き

New Relic アカウントを識別する一意のstring 。 New Relic と統合する場合は、この設定を指定する必要があります。

spec.integrations.apiKeyRef.name

型: string

条件付き

不可視シークレットの名前password Datadog、Opsgenie、または VictorOps の API キーを持つ単一のフィールドを含む。Datadog、Opsgenie、または VictorOps と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.apiKeyRef.namespace

型: string

条件付き

Datadog、Opsgenie、または VictorOps の API キーを含む名前空間。 Datadog、Opsgenie、または VictorOps と統合する場合は、この設定を指定する必要があります。

spec.integrations.apiTokenRef.name

型: string

条件付き

不可視シークレットの名前password Slack 用の API トークンを持つ単一のフィールドを含む。Slack と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.apiTokenRef.namespace

型: string

条件付き

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

spec.integrations.enabled

タイプ: ブール値

条件付き

クラスターで Prometheus が有効になっているかどうかを示すフラグ。 Prometheus と統合するには、この設定をtrueとして指定する必要があります。

spec.integrations.licenseKeyRef.name

型: string

条件付き

不可視シークレットの名前password これには、New Relic のライセンスキーを持つ単一のフィールドが含まれます。New Relic と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.licenseKeyRef.namespace

型: string

条件付き

New Relic のライセンスキーを含む名前空間。 New Relic と統合する場合は、この設定を指定する必要があります。

spec.integrations.microsoftTeamsWebhookURL

型: string

条件付き

stringMicrosoftTeams 受信 WebhookURL を指定する。Microsoft Teams と統合するには、この設定を指定する必要があります。

spec.integrations.passwordRef.name

型: string

条件付き

不可視シークレットの名前password Prometheus パスワードを持つ単一のフィールドを含む。Prometheus と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.passwordRef.namespace

型: string

条件付き

Prometheus パスワードを含む名前空間。 Prometheus と統合する場合は、この設定を指定する必要があります。

spec.integrations.readTokenRef.name

型: string

条件付き

不可視シークレットの名前 : New Relic のインサイトクエリキーを持つ単一のフィールドを含みます。passwordNew Relic と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.readTokenRef.namespace

型: string

条件付き

New Relic のインサイトクエリキーを含む名前空間。 New Relic と統合する場合は、この設定を指定する必要があります。

spec.integrations.region

型: string

条件付き

デフォルト: US

Datadog または Opsgenie で使用する API URL を示す string 値。 Datadog または Opsgenie と統合するには、この設定を指定する必要があります。

Opsgenie の値にはUSまたはEUが含まれます。

Atlas は、Atlas Administration API で次の Datadog リージョンをサポートしています。

Atlas Administration API リージョン	対応する Datadog リージョン
`US`	`US1`
`US3`	`US3`
`US5`	`US5`
`EU`	`EU1`

Datadog はデフォルトでUS1 （Atlas Administration API ではUS ）を使用します。

Datadog のリージョンの詳細については、Datadog サイトを参照してください。

spec.integrations.routingKeyRef.name

型: string

条件付き

不可視シークレットの名前password VictorOps のルーティングキーを持つ単一のフィールドを含む。VictorOps と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.routingKeyRef.namespace

型: string

条件付き

VictorOps のルーティングキーを含む名前空間。 VictorOps と統合する場合は、この設定を指定する必要があります。

spec.integrations.secretRef.name

型: string

条件付き

不可視シークレットの名前 Webhook シークレットを持つ単一のフィールドを含む。passwordWebhook 設定と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.secretRef.namespace

型: string

条件付き

Webhook シークレットを含む名前空間。 Webhook 設定と統合する場合は、この設定を指定する必要があります。

spec.integrations.scheme

型: string

条件付き

リクエスト用に構成された Prometheus プロトコルスキームを示す string。値にはhttpまたはhttpsが含まれます。 Prometheus と統合する場合は、この設定を指定する必要があります。

spec.integrations.serviceDiscovery

型: string

条件付き

使用する Prometheus サービス検出方法を示す、人間が判読可能なラベル。値にはfileまたはhttpが含まれます。 Prometheus と統合する場合は、この設定を指定する必要があります。

spec.integrations.serviceKeyRef.name

型: string

条件付き

不可視シークレットの名前password は、PagerDuty のサービスキーを持つ単一のフィールドを含みます。PagerDuty と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.serviceKeyRef.namespace

型: string

条件付き

PagerDuty のサービスキーを含む名前空間。 PagerDuty と統合する場合は、この設定を指定する必要があります。

spec.integrations.type

型: string

条件付き

Atlas と統合するサードパーティサービスを示す string 値。値には、次のものが含まれます。

DATADOG
MICROSOFT_TEAMS
NEW_RELIC
OPS_GENIE
PAGER_DUTY
PROMETHEUS
SLACK
VICTOR_OPS
WEBHOOK

サードパーティのサービスと統合するには、この設定を指定する必要があります。

spec.integrations.url

型: string

条件付き

stringWebhook を指定するURL 。Webhook 設定と統合する場合は、この設定を指定する必要があります。

spec.integrations.username

型: string

条件付き

Prometheus ユーザーを識別する、人間が判読可能なラベル。 Prometheus と統合する場合は、この設定を指定する必要があります。

spec.integrations.writeTokenRef.name

型: string

条件付き

不可視シークレットの名前password は、New Relic の書込みトークンを持つ単一のフィールドを含みます。New Relic と統合する場合は、この設定を指定する必要があります。

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

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

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

spec.integrations.writeTokenRef.namespace

型: string

条件付き

New Relic の書込み (write) トークンを含む名前空間。 New Relic と統合する場合は、この設定を指定する必要があります。

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

タイプ: ブール値

条件付き

Atlas が定期メンテナンスを延期するかどうかを示すフラグ。メンテナンスを正常に延期する前に、メンテナンスをスケジュールする必要があります。 spec.maintenanceWindow.deferとspec.maintenanceWindow.startASAPの両方を同時にtrueに設定することはできません。

重要

spec.maintenanceWindow.deferがtrueに設定されている間は、 AtlasProjectカスタムリソースに変更を適用するたびに、Atlas Kubernetes Operator は予定されたメンテナンスを延期します。 spec.maintenanceWindow.deferをtrueに設定している場合、変更を適用した後、 spec.maintenanceWindow.deferをfalseに変更する必要があります。

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

タイプ: ブール値

条件付き

Atlas がメンテナンスをすぐに開始するかどうかを示すフラグ。 spec.maintenanceWindow.deferとspec.maintenanceWindow.startASAPの両方を同時にtrueに設定することはできません。

重要

spec.maintenanceWindow.startASAPがtrueに設定されている間は、 AtlasProjectカスタムリソースに変更を適用するたびに Atlas Kubernetes Operator によるメンテナンスが開始されます。 spec.maintenanceWindow.startASAPをtrueに設定している場合、変更を適用した後、 spec.maintenanceWindow.startASAPをfalseに変更する必要があります。

spec.networkPeers

タイプ: 配列

任意

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

spec.regionUsageRestrictions

型: string

任意

Atlasfor GovernmentAmazon Web Services のみのプロジェクトのリージョンを指定します。次のいずれかの値を指定できます。

NONE: regionUsageRestrictionsをNONEに設定すると、値はデフォルトでCOMMERCIAL_FEDRAMP_REGIONS_ONLYになります。これはregionUsageRestrictionsを省略した場合のデフォルトです。
GOV_REGIONS_ONLY: プロジェクトは、より厳格な米国政府のセキュリティ要件を満たすAmazon Web Services GovCloud リージョンに制限されることを示します。詳細については、Amazon Web Services GovCloud のドキュメントを参照してください。
COMMERCIAL_FEDRAMP_REGIONS_ONLY: プロジェクトがAmazon Web Services FedRamp に制限されていることを示します標準リージョンをモードにします。

spec.projectIpAccessList

タイプ: 配列

必須

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

Parameter	タイプ	必要性	説明
awsSecurityGroup	string	条件付き	アクセスリストに追加するAmazon Web Servicesセキュリティグループの一意の識別子。アクセスリストエントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。セキュリティグループをアクセスリストに追加する前に、プロジェクトのAmazon Web Services VPCピアリングを設定する必要があります。
cidrBlock	string	条件付き	アクセスリストに追加するCIDR表記の IP アドレスの範囲。アクセスリストエントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。
comment	string	任意	アクセスリストエントリに関連付けられたコメント。
deleteAfterDate	date	任意	ISO8601 のタイムスタンプの日付と時刻形式が UTC で指定され、その後 Atlas はアクセスリストからエントリを削除します。指定する日付は、 APIリクエストを行ってから 1 週間以内である必要があります。重要: Amazon Web Servicesのセキュリティグループを一時的なアクセスリストエントリとして設定することはできません。 ISO8601 を含めることができますタイムゾーン指定子を使用して、指定されたタイムゾーン内のローカル時間に有効期限が発生するようにします。
ipAddress	string	条件付き	アクセスリストに追加する単一の IP アドレス。 awsSecurityGroupおよびcidrBlockと相互に排他的です。アクセスリストエントリには、1 つのawsSecurityGroup 、1 つのcidrBlock 、または 1 つのipAddressのみを含めることができます。

spec.settings

型: オブジェクト

任意

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

spec.settings.isCollectDatabaseSpecificsStatisticsEnabled

タイプ: ブール値

任意

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

spec.settings.isDataExplorerEnabled

タイプ: ブール値

任意

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

spec.settings.isExtendedStorageSizesEnabled

タイプ: ブール値

任意

指定されたプロジェクトに対してストレージサイズ拡張を有効にするかどうかを示すフラグ。拡張ストレージを有効にする方法の詳細については、「プロジェクト設定の管理」を参照してください。

spec.settings.isPerformanceAdvisorEnabled

タイプ: ブール値

任意

プロジェクトでPerformance Advisorが有効になっているかどうかを示すフラグ。

spec.settings.isRealtimePerformancePanelEnabled

タイプ: ブール値

任意

プロジェクトでリアルタイムパフォーマンスパネルが有効になっているかどうかを示すフラグ。

spec.settings.isSchemaAdvisorEnabled

タイプ: ブール値

任意

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

spec.privateEndpoints

タイプ: 配列

任意

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

spec.teams

型: オブジェクト

任意

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

spec.teams.teamRef.name

型: string

条件付き

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

spec.teams.teamRef.namespace

型: string

条件付き

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

spec.teams.teamRef.roles

型: string

条件付き

このプロジェクトでチームが使用するAtlas user ロール。このプロジェクトにチームを割り当てる場合は、この設定を指定する必要があります。

spec.withDefaultAlertsSettings

タイプ: ブール値

任意

デフォルト: true

Atlas Kubernetes Operator がデフォルトのアラート構成でプロジェクトを作成するかどうかを示すフラグ。省略された場合、デフォルトはtrueとなります。

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

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

この設定とspec.alertConfigurationSyncEnabledとの相互作用については、考慮事項を参照してください。

spec.x509CertRef.name

型: string

任意

シークレットの名前kubernetes.io/tls X.509 証明書の場合

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

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

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

戻る

カスタムリソース

AtlasDeployment

重要

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

例

Prometheus の例

注意

チームの例

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

プロジェクト設定の例

アラート構成の例

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

パラメーター

重要

注意

注意

注意

注意

重要

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

重要

重要

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

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