MongoDB.local SF, Jan 15: See the speaker lineup & ship your AI vision faster. Use WEB50 to save 50%
Find out more >
Docs Menu
Docs Home
/ /
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース

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 は、次のいずれかのアクションを実行します。

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

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

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

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

  • spec.projectIpAccessList を使用したIP アクセス リスト許可されます。このIP アクセス リストは、プロジェクト内の Atlas クラスターへのネットワーク アクセスを許可します。

  • spec. teams パラメーターを持つチーム。チームでは、特定のプロジェクトの Atlas ユーザーのグループ全体にアクセス ロールを付与できます。

  • spec.maintenanceWindow による メンテナンスウィンドウ許可されます。メンテナンスウィンドウは、 Atlas がデータベース配置の週次メンテナンスを開始する時間と日付を設定します。

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 プロジェクト

Atlas プロジェクトは、atlasprojects APIのスキーマです

Name
タイプ
説明
必須

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasProject

true

metadata

オブジェクト

metadataフィールドのフィールドについては、 Kubernetes API のドキュメントを参照してください。

true

spec

オブジェクト

AtlasProjectSpec は、Atlas のプロジェクトのターゲット状態を定義します

false

status

オブジェクト

AtlasProjectStatus の観察された状態を定義します AtlasProject

false

AtlasProject.spec

AtlasProjectSpec は、Atlas のプロジェクトのターゲット状態を定義します

Name
タイプ
説明
必須

name

string

名前は、演算子によって Atlas に作成されるプロジェクトの name です（まだ存在しない場合）。name の長さは 64 文字を超えてはなりません。name には、文字、数字、スペース、ダッシュ、アンダースコアのみを含める必要があります。検証:

  • 自己 == oldSelf:プロジェクト作成後に名前を変更することはできません

true

alertConfigurationSyncEnabled

ブール値

AlertConfigurationSyncEnabled は、現在のプロジェクトのアラート構成の同期を有効または無効にするフラグです。true の場合、プロジェクトアラート構成は AlertConfigurations に従って同期されます。そうでない場合、アラート構成は 演算子によって変更されません。これらは API、CLI、UI でマネージドできます。

false

alertConfigurations

[]オブジェクト

AlertConfiguration は、現在のプロジェクトに対して構成されているアラート構成のリストです。この設定を使用する場合は、Atlas Kubernetes Operator がプロジェクトのアラート構成を変更するために、spec.``alertConfigurationSyncEnabled`` も true に設定する必要があります。この設定を省略したり空のままにしたりすると、Atlas Kubernetes Operator はプロジェクトのアラート構成を変更しません。プロジェクトを作成すると、Atlas はデフォルトのプロジェクトアラート構成を適用します。

false

auditing

オブジェクト

監査は MongoDB メンテナンスWindowsを表します。

false

backupCompliancePolicyRef

オブジェクト

BackupCompliancePolicyRef は、バックアップコンプライアンスカスタムリソースへの参照です。

false

cloudProviderAccessRoles

[]オブジェクト

CloudProviderAccessRoles は、現在のプロジェクトに対して構成されたクラウドプロバイダーのアクセス ロールの一覧です。非推奨: この構成は非推奨となり、次が採用されました: CloudProviderIntegrations

false

cloudProviderIntegrations

[]オブジェクト

CloudProviderIntegrations は、現在のプロジェクトに対して構成されているクラウドプロバイダー統合のリストです。

false

connectionSecretRef

オブジェクト

ConnectionSecret は、Atlas への接続方法に関する情報を含むkubernetes secretの名前です（組織ID、API キー）。指定しない場合は、デフォルトの 演算子 接続構成が使用されます。

false

customRoles

[]オブジェクト

CustomRoles クラスターでカスタムロールを作成および変更することができます。カスタムロールを使用して、Atlas の組み込みロールでは記述できないアクションのカスタムセットを指定できます。非推奨:移行リソース（AtlasCustomRoles https://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm8 so-移行-ptr

false

encryptionAtRest

オブジェクト

EncryptionAtRest を使用すると、AWS、 Azure 、GCP プロバイダーの暗号化を設定できます。

false

integrations

[]オブジェクト

統合は、プロジェクトの MongoDB Atlas integrations のリストです。非推奨:移行リソース（AtlasThirdPartyIntegration https://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm8 so-移行-ptr

false

maintenanceWindow

オブジェクト

MaintenanceWindow メンテナンス操作を実行するための希望時間を指定できます。詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api/maintenance-windows/ を参照してください。

false

networkPeers

[]オブジェクト

NetworkPeers は、現在のプロジェクトに対して構成されたネットワークピアのリストです。非推奨:AtlasNetworkPeering AtlasNetworkContainerhttps://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm-Parameter-to-resource/#std-8 の移行ガイドに従って、 と のカスタム リソースに移行しますlabels

false

privateEndpoints

[]オブジェクト

PrivateEndpoints は、現在のプロジェクトに対して構成されているプライベートエンドポイントのリストです。非推奨:移行ガイド（AtlasPrivateEndpoint https://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm8 so-移行-ptr

false

projectIpAccessList

[]オブジェクト

ProjectIPAccessList では、プロジェクトで IP アクセス リストを使用できます。 詳細については、https://mongodb.com/java-j/docs/atlas/参照/api/ip-access-list/add-entries-to-access-list/ を参照してください。非推奨:移行ガイド（AtlasIPAccessList https://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm8 so-移行-ptr

false

regionUsageRestrictions

列挙

RegionUsageRestrictions Atlas for Government を使用する場合は、プロジェクトの AWS リージョンを指定します。このパラメーターは商用 Atlas では使用しないでください。Atlas for Governmentでは、このフィールドを設定しない場合（デフォルトは NONE）、プロジェクトはCOMMERCIAL_FEDRAMP_REGIONS_ONLY に制限されます。列挙: NONE、GOV_REGIONS_ONLY、COMMERCIAL_FEDRAMP_REGIONS_ONLY デフォルト: NONE

false

settings

オブジェクト

設定では、プロジェクト設定を構成できます。

false

teams

[]オブジェクト

チームを使用すると、プロジェクトにアクセスするロールを複数のユーザーに付与できます。

false

withDefaultAlertsSettings

ブール値

Atlas Kubernetes Operator がデフォルトのアラート構成でプロジェクトを作成するかどうかを示すフラグ。この設定を使用する場合は、Atlas Kubernetes Operator がプロジェクトのアラート構成を変更するために、spec.``alertConfigurationSyncEnabled`` も true に設定する必要があります。プロジェクトを作成するときにこのパラメータを false に設定すると、Atlas はデフォルトのアラート構成をプロジェクトに追加しません。この設定は既存のプロジェクトには影響しません。デフォルト: true

false

x509CertRef

オブジェクト

X509CertRef は、PEM でエンコードされた CA 証明書を含むKubernetes Secret への参照です。Atlas Kubernetes Operator は、 atlas.mongodb.com/type=credentials のラベルを持つシークレットのみを監視します不要なシークレットを監視しないようにします。

false

AtlasProject.spec.alertConfigurations

Name
タイプ
説明
必須

enabled

ブール値

省略した場合、構成は無効になります。

false

eventTypeName

string

アラートをトリガーするイベントの種類。

false

matchers

[]オブジェクト

EventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 matchers配列を使用してフィルタリングできます。

false

metricThreshold

オブジェクト

MetricThreshold アラートがトリガーされます。

false

notifications

[]オブジェクト

アラート条件が検出されたときに通知が送信されます。

false

severityOverride

列挙

SeverityOverride は、任意にアラートのデフォルトの重大度レベルを上書きします。列挙: INFO、WARNING、ERROR、CRITICAL

false

threshold

オブジェクト

しきい値があるとアラートがトリガーされます。

false

AtlasProject.spec.alertConfigurations.matchers

Name
タイプ
説明
必須

fieldName

string

一致するターゲット オブジェクト内のフィールドの名前。

false

operator

string

フィールドの値をテストするための operator 。

false

value

string

指定された演算子でテストする値。

false

AtlasProject.spec.alertConfigurations.metricThreshold

MetricThreshold によりアラートがトリガーされます。

Name
タイプ
説明
必須

threshold

string

アラートがトリガーされるしきい値。

true

metricName

string

確認するメトリクスの名前。

false

mode

string

これは AVERAGE に設定する必要があります。Atlas は現在のメトリクス値を平均として計算します。

false

operator

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。

false

units

string

しきい値の units。

false

AtlasProject.spec.alertConfigurations.notifications

Name
タイプ
説明
必須

apiTokenRef

オブジェクト

Slack API トークンまたは Bot トークンを含むシークレット。SLACK 通知タイプに入力されます。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

channelName

string

Slackチャンネル名。SLACK 通知タイプに入力されます。

false

datadogAPIKeyRef

オブジェクト

Datadog API キーを含むシークレット。Datadog ダッシュボードで確認できます。DATADOG 通知タイプに入力されます。

false

datadogRegion

string

どの API URL を使用するかを示すリージョン。

false

delayMin

integer

アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。

false

emailAddress

string

アラート通知が送信されるメールアドレス。EMAIL 通知タイプに入力されます。

false

emailEnabled

ブール値

メール通知を送信するかどうかを示すフラグ。ORG、GROUP、USER の通知タイプに入力されます。

false

flowName

string

小文字の Flowdock フロー名。

false

flowdockApiTokenRef

オブジェクト

Flowdock パーソナル API トークン。FLOWDOCK 通知タイプに入力されます。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

intervalMin

integer

解決されていない未確認アラートの連続した通知間で待機する時間（分）。

false

mobileNumber

string

アラート通知が送信されるモバイル番号。SMS 通知タイプに入力されます。

false

opsGenieApiKeyRef

オブジェクト

OpsGenie API キー。 OPS_GENIE 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

opsGenieRegion

string

どの API URL を使用するかを示すリージョン。

false

orgName

string

小文字の Flowdock組織名。これは、URL string 内のアプリ/ の後に表示される名前です。FLOWDOCK 通知タイプに入力されます。

false

roles

[]string

次の roles はプロジェクト内の権限を付与します。

false

serviceKeyRef

オブジェクト

PagerDuty サービスキー。PAGER_DUTY 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

false

smsEnabled

ブール値

テキスト メッセージ通知を送信するかどうかを示すフラグ。ORG、GROUP、USER の通知タイプに入力されます。

false

teamId

string

チームの一意の識別子。

false

teamName

string

この通知を受け取ったチームのラベル。

false

typeName

string

アラート通知のタイプ。

false

username

string

通知の送信先となる Atlas ユーザーの名前。ここで許可されるのは、アラート構成を所有するプロジェクト内のユーザーのみです。USER 通知タイプに入力されます。

false

victorOpsSecretRef

オブジェクト

VictorOps API キーと Routing キーを含む Secret。VICTOR_OPS 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

false

AtlasProject.spec.alertConfigurations.通知.apiTokenRef

Slack APIトークンまたは Bot トークンを含むシークレット。SLACK 通知タイプに入力されます。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.notifications.datadogAPIKeyRef

Datadog APIキーを含むシークレット。Datadog ダッシュボードで確認できます。DATADOG 通知タイプに入力されます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.通知.flowdockApiTokenRef

Flowdock パーソナルAPIトークン。FlowDOCK 通知タイプの入力。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.notifications.opsgenieApiKeyRef

OpsGenie APIキー。OPS_GENIE 通知タイプの入力。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.通知.serviceKeyRef

PagerDuty サービス キー。PAGER_DUTY 通知タイプの入力。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.通知.victorOpsSecretRef

VictorOps APIキーとルーティングキーを含むシークレット。VICTOR_OPS 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.alertConfigurations.threshold

しきい値があるとアラートがトリガーされます。

Name
タイプ
説明
必須

operator

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。次の値を受け入れます: GREATER_THAN、LESS_THAN。

false

threshold

string

アラートがトリガーされるしきい値。

false

units

string

しきい値の units。

false

AtlasProject.spec.監査する

監査することはMongoDBメンテナンスWindowsを表します。

Name
タイプ
説明
必須

auditAuthorizationSuccess

ブール値

監査システムが "atype" : "authCheck" 監査イベントを使用して監査するフィルターの成功した認証試行をキャプチャするかどうかを示します。詳しくは、 auditAuthorizationSuccess を参照してください。

false

auditFilter

string

JSONプロジェクトで使用される 形式の監査するフィルター。

false

enabled

ブール値

{GROUP-ID} に関連付けられているプロジェクトでデータベース監査する機能が有効になっているかどうかを示します。

false

AtlasProject.spec.backupCompliancePolicyRef

BackupCompliancePolicyRef は、バックアップコンプライアンスカスタムリソースへの参照です。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.cloudProviderAccessRoles

CloudProviderAccessRole は、クラウドプロバイダーへの統合を定義します 非推奨: CloudProviderIntegration が優先されるため、このタイプは非推奨です。

Name
タイプ
説明
必須

providerName

string

ProviderName は、 クラウドプロバイダーの名前です。現在、AWS のみがサポートされています。

true

iamAssumedRoleArn

string

IamAssumedRoleArn は、Atlas クラスターによって想定される IAM ロールの ARN です。

false

AtlasProject.spec.cloudProviderIntegrations

CloudProviderIntegration は、クラウドプロバイダーへの統合を定義します

Name
タイプ
説明
必須

providerName

string

ProviderName は、 クラウドプロバイダーの名前です。現在、AWS のみがサポートされています。

true

iamAssumedRoleArn

string

IamAssumedRoleArn は、Atlas クラスターによって想定される IAM ロールの ARN です。

false

AtlasProject.spec. connectionSecretRef

ConnectionSecret は、Atlas への接続方法に関する情報（組織ID、APIキー）を含むkubernetes secret の名前です。指定しない場合は、デフォルトの 演算子 接続構成が使用されます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.customRoles

CustomRole を使用すると、クラスター内でカスタムロールを作成および変更できます。カスタムロールを使用して、Atlas の組み込みロールでは記述できないアクションのカスタムセットを指定できます。非ガイド: リソース 8sort-migration-ptr

Name
タイプ
説明
必須

name

string

ロールを識別する、人間が判読できるラベル。この name は、このプロジェクト内のこのカスタムロールに対して一意である必要があります。

true

actions

[]オブジェクト

ロールが付与する個々の権限actionsのリスト。

false

inheritedRoles

[]オブジェクト

このカスタムロールが継承する組み込みロールのリスト。

false

AtlasProject.spec.customRoles.アクション

Name
タイプ
説明
必須

name

string

特権アクションを識別する、人間が判読可能なラベル。

true

resources

[]オブジェクト

アクションを付与する resources のリスト。

true

AtlasProject.spec.customRoles.アクション.リソース

Name
タイプ
説明
必須

cluster

ブール値

clusterリソースでアクションを許可するかどうかを示すフラグ。true の場合、MongoDB クラウドはデータベースとコレクション パラメータを無視します。

false

collection

string

1 人の MongoDB ユーザーにアクションを付与する collection を識別する、人間が判読できるラベル。

false

database

string

1 人の MongoDB ユーザーにアクションを付与する database を識別する、人間が判読できるラベル。

false

AtlasProject.spec.customRoles.inheritedRoles

Name
タイプ
説明
必須

database

string

誰かが 1 人のMongoDBユーザーにアクションを付与するdatabaseを識別する、人間が判読できるラベル。

true

name

string

継承されたロールを識別する、人間が判読できるラベル。

true

AtlasProject.spec.encryptionAtRest

EncryptionAtRest を使用すると、 AWS、 Azure 、 GCPプロバイダーの暗号化を設定できます。

Name
タイプ
説明
必須

awsKms

オブジェクト

AwsKms は、AWS KMS 構成の詳細と、Atlasプロジェクトで保管時の暗号化が有効になっているかどうかを指定します。

false

azureKeyVault

オブジェクト

AzureKeyVault では、 Azure Key Vault の構成の詳細と、 Atlasプロジェクトで保管時の暗号化が有効になっているかどうかを指定します。

false

googleCloudKms

オブジェクト

GoogleCloudKms は、GCP KMS 構成の詳細と、Atlasプロジェクトで保管時の暗号化が有効になっているかどうかを指定します。

false

AtlasProject.spec.encryptionAtRest.awsKms

AwsKms は、 AWS KMS 構成の詳細と、 Atlasプロジェクトで 保管時の暗号化が有効になっているかどうかを指定します。

Name
タイプ
説明
必須

enabled

ブール値

Atlasプロジェクトで保管時の暗号化が enabled であるかどうかを指定します。保管時の暗号化を無効にするには、false の値を持つこのパラメーターのみを渡します。保管時の暗号化を無効にすると、Atlas は構成の詳細も除きます。

false

region

string

AWSカスタマーマスター キーが存在する AWS region 。

false

secretRef

オブジェクト

AccessKeyID、SecretAccessKey、CustomerMasterKeyID、RoleID フィールドを含む シークレット としての参照

false

valid

ブール値

プロバイダーの暗号化のキーセットが valid で、データの暗号化と復号化に使用できるかどうかを指定します。

false

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

アクセスキー ID、シークレット アクセス キー、カスタマー マスター キー、ロール ID フィールドを含む シークレット への参照

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.encryptionAtRest.azureKeyVault

AzureKeyVault では、 Azure Key Vault の構成の詳細と、 Atlasプロジェクトで保管時の暗号化が有効になっているかどうかを指定します。

Name
タイプ
説明
必須

azureEnvironment

string

Azureアカウント認証情報が存在するAzure環境。有効な値は次のとおりです: AZURE、AZURE_CHINA、AZURE_GERMANY

false

clientID

string

Azure AD テナントに関連付けられたAzureアプリケーションのクライアント ID（アプリケーションIDとも呼ばれます）。

false

enabled

ブール値

Atlasプロジェクトで保管時の暗号化が enabled であるかどうかを指定します。保管時の暗号化を無効にするには、false の値を持つこのパラメーターのみを渡します。保管時の暗号化を無効にすると、Atlas は構成の詳細も除きます。

false

resourceGroupName

string

Azure Key Vault を含む Azure リソース グループの名前。

false

secretRef

オブジェクト

SubscriptionID、KeyVaultName、KeyIdentifier、シークレット フィールドを含むシークレットとしての参照

false

tenantID

string

Azureサブスクリプション内のADAzureテナントの一意の識別子。

false

AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef

サブスクリプション ID、KeyVaultName、KeyIdentifier、シークレット フィールドを含むシークレットとしての への参照

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.encryptionAtRest.googleCloudKms

GoogleCloudKms は、 GCP KMS 構成の詳細と、 Atlasプロジェクトで保管時の暗号化が有効になっているかどうかを指定します。

Name
タイプ
説明
必須

enabled

ブール値

Atlasプロジェクトで保管時の暗号化が enabled であるかどうかを指定します。保管時の暗号化を無効にするには、false の値を持つこのパラメーターのみを渡します。保管時の暗号化を無効にすると、Atlas は構成の詳細も除きます。

false

secretRef

オブジェクト

ServiceAccountKey、KeyVersionResourceID フィールドを含む シークレット としての参照

false

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

ServiceAccountKey、KeyVersionResourceID フィールドを含む シークレット への参照

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.統合

Atlas とサードパーティ サービス間のプロジェクトの統合。非推奨: https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migration-Parameter-to-resource/#std-labels-ask8 の移行ガイドに従って、AtlasThirdPartyIntegration カスタムリソースに移行しますsort-migration-ptr

Name
タイプ
説明
必須

accountId

string

New Relic アカウントを識別する一意の 40 桁の 16 進数文字列。

false

apiKeyRef

オブジェクト

Datadog、OpsGenie、または Victor Ops の API キーを含むkubernetes secretへの参照。

false

apiTokenRef

オブジェクト

Atlas がSlackアカウントにアクセスできるようにするキーを含むkubernetes secret への参照。

false

channelName

string

Atlas がアラート通知を送信する Slack チャンネルの名前。

false

enabled

ブール値

Prometheus 統合がアクティブ化されているかどうかを示すフラグ。

false

flowName

string

DEPRECATED: Flowdock フロー名。このフィールドは Atlas から削除されたため、影響はありません。

false

licenseKeyRef

オブジェクト

New Relic ライセンスを識別する、一意の 40 桁の 16 進数 string を含むkubernetes secret への参照。

false

microsoftTeamsWebhookUrl

string

Atlas が通知を送信する Microsoft Teams Webhook のエンドポイントとなる接続されたデバイスの Web アドレス。

false

name

string

false

orgName

string

DEPRECATED: Flowdock組織名。このフィールドは Atlas から削除されたため、影響はありません。

false

passwordRef

オブジェクト

Atlas が Prometheus アカウントにアクセスできるようにするためのパスワードを含むKubernetes Secret への参照。

false

readTokenRef

オブジェクト

New Relic アカウントに関連付けられたクエリ キーを含むKubernetes Secret への参照。

false

region

string

Atlas が PagerDuty、Datadog、または OpsGenie にアクセスするために使用するリージョン API を示すリージョン コード。

false

routingKeyRef

オブジェクト

Splunk On-Call アカウントに関連付けられたルーティングキーを含む kubernetes secret への参照。Victor Ops に使用されます。

false

scheme

string

false

secretRef

オブジェクト

Webhook のシークレットを含むkubernetes secretへの参照。

false

serviceDiscovery

string

Prometheus サービスを検出するための希望方法です。

false

serviceKeyRef

オブジェクト

PagerDuty アカウントに関連付けられたサービスキーを含むKubernetes Secret への参照。

false

teamName

string

Slackチームを識別する、人間が判読できるラベル。

false

type

列挙

サードパーティ統合 type（ Slack、New Relic など）各統合 type には個別の構成フィールド セットが必要です。例、type を DATADOG に設定する場合は、datadog サブフィールドのみを構成する必要があります。列挙: PAGER_DUTY、SLACK、DATADOG、NEW_RELIC、OPS_GENIE、VICTOR_OPS、FLOWDOCK、WEBHOOK、MICROSOFT_TEAMS、PROMETHEUS

false

url

string

Atlas が通知を送信するエンドポイントとなる接続されたデバイスのウェブアドレス。Webhook に使用されます。

false

username

string

Prometheus 受信 Webhook を識別する、人間が判読可能なラベル。

false

writeTokenRef

オブジェクト

New Relic アカウントに関連付けられた挿入キーを含むKubernetes Secret への参照。

false

AtlasProject.spec.integrs.apiKeyRef

Datadog、Opsgenie、または Victor Ops のAPIキーを含むkubernetes secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.apiTokenRef

Atlas がSlackアカウントにアクセスできるようにするキーを含むkubernetes secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.licensKeyRef

New Relic ライセンスを識別する、一意の 40 桁の 16 進数 string を含むkubernetes secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.passwordRef

Atlas が Prometheus アカウントにアクセスできるようにするためのパスワードを含むKubernetes Secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.readTokenRef

New Relic アカウントに関連付けられたクエリ キーを含むKubernetes Secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs. routeKeyRef

Splunk On-Call アカウントに関連付けられたルーティングキーを含む kubernetes secret への参照。Victor Ops に使用されます。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.secretRef

Webhook のシークレットを含むkubernetes secretへの参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.serviceKeyRef

PagerDuty アカウントに関連付けられたサービス キーを含むKubernetes Secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.integrs.writeTokenRef

New Relic アカウントに関連付けられた挿入キーを含むKubernetes Secret への参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.maintenanceWindow

メンテナンスウィンドウ を使用すると、メンテナンス操作を実行するための希望時間を指定できます。詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api/maintenance-windows/ を参照してください。

Name
タイプ
説明
必須

autoDefer

ブール値

スケジュールされたプロジェクトのメンテナンスを 1 週間自動的に延期するかどうかを示すフラグ。

false

dayOfWeek

integer

メンテナンスウィンドウを 1 ベースの整数として開始する曜日。日曜日 1、月曜日 2、火曜日 3、水曜日 4、木曜日 5、データベース 6、土曜日 7最小: 1 最大: 7

false

defer

ブール値

次に予定されているプロジェクトのメンテナンスを 1 週間延期するかどうかを示すフラグ。startASAP が true の場合は指定できません

false

hourOfDay

integer

メンテナンスウィンドウを開始する時刻。このパラメータは 24 時間制を使用します。真夜中は 0、正午は 12 です。最小: 0 最大: 23

false

startASAP

ブール値

プロジェクトのメンテナンスがすぐに開始されるように指示されたかどうかを示すフラグ。デフォルトが true の場合は指定できません

false

AtlasProject.spec.networkPears

現在のプロジェクトに構成されたネットワークピア。非ガイド: https://www.mongodb.com/ja-jp/docs/atlas/operator/current/confirm8 so-移行-ptr

Name
タイプ
説明
必須

accepterRegionName

string

AccepterRegionName は、ユーザーの VPC のプロバイダー リージョン名です。

false

atlasCidrBlock

string

Atlas CIDR。ContainerID が設定されていない場合は、 を設定する必要があります。

false

awsAccountId

string

AccountID ユーザーの VPC の

false

azureDirectoryId

string

AzureDirectoryID は、 Azure ADディレクトリの一意の識別子です。

false

azureSubscriptionId

string

AzureSubscriptionID は、VNet が存在するAzureサブスクリプションの一意の識別子です。

false

containerId

string

ID ネットワーク ピアリングコンテナの設定されていない場合、 演算子は ContainerRegion と AtlasCIDRBlock 入力を持つ新しいコンテナを作成します。

false

containerRegion

string

ContainerRegion は、Atlas ネットワーク ピアリングコンテナのプロバイダー リージョン名です。設定されていない場合は、AccepterRegionName が使用されます。

false

gcpProjectId

string

ユーザー GCP プロジェクト ID。これは GCP にのみ適用されます。

false

networkName

string

GCP ネットワークピア名。これは GCP にのみ適用されます。

false

providerName

string

ProviderName は、プロバイダーの名前です。設定されていない場合は、"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 は、現在のプロジェクトに対して構成されたプライベートエンドポイントのリストです。非推奨: https://www.mongodb.com/ja-jp/docs/atlas/operator/current/migration-Parameter-to-resource/#std-labels-ask8 の移行ガイドに従って、AtlasPrivateEndpoint カスタム リソースに移行しますsort-migration-ptr

Name
タイプ
説明
必須

provider

列挙

プライベートエンドポイント サービスを検索するクラウド provider。Atlas は AWS、GCP、または AZURE を受け入れます。列挙: AWS、GCP、AZURE、TENANT

true

region

string

プライベートエンドポイント サービスを作成するクラウドプロバイダー region。

true

endpointGroupName

string

エンドポイントとなる接続されたデバイスグループの一意の識別子です。エンドポイントとなる接続されたデバイス グループには、Google Cloud で作成したすべてのエンドポイントとなる接続されたデバイスが含まれます。

false

endpoints

[]オブジェクト

エンドポイント グループを構成する個々のプライベート エンドポイントとなる接続されたデバイス のコレクション。endpoints

false

gcpProjectId

string

エンドポイントとなる接続されたデバイスを作成した Google Cloudプロジェクトの一意の識別子。

false

id

string

AWS VPC またはAzure VNet で作成したプライベートエンドポイントの一意の識別子。

false

ip

string

Azure VNet で作成したプライベートエンドポイント ネットワーク インターフェイスのプライベート IP アドレス。

false

AtlasProject.spec.privateEndpoints.エンドポイントとなる接続されたデバイス

Name
タイプ
説明
必須

endpointName

string

Google Cloud で作成したエンドポイントとなる接続されたデバイスに対応する転送ルール。

false

ipAddress

string

Google Cloud で作成したエンドポイントとなる接続されたデバイスのプライベート IP アドレス。

false

AtlasProject.spec.projectIpAccessList

IPAccessList を使用すると、プロジェクトのIPアクセス リストを使用できます。詳細については、 https://mongodb.com/java-j/docs/atlas/ 参照/api/ip-access-list/add-entries-to-access-list/ を参照してください。非推奨: ガイド 8sort-migration-ptr

Name
タイプ
説明
必須

awsSecurityGroup

string

このアクセス リスト エントリ内の AWS セキュリティ グループの一意の識別子。

false

cidrBlock

string

このアクセス リスト エントリの CIDR 表記の IP アドレスの範囲。

false

comment

string

このアクセス リスト エントリに関連付けられたコメント。

false

deleteAfterDate

string

ISO 8601 の日付と時刻形式（UTC のタイムスタンプ）。このあと Atlas は一時的なアクセスリストのエントリを削除します。

false

ipAddress

string

このアクセス リスト エントリで IP アドレスを使用するエントリ。

false

AtlasProject.spec.settings

設定では、プロジェクト設定を構成できます。

Name
タイプ
説明
必須

isCollectDatabaseSpecificsStatisticsEnabled

ブール値

指定されたプロジェクトのデータベース固有のメトリクスを収集するかどうかを示すフラグ。

false

isDataExplorerEnabled

ブール値

指定されたプロジェクトに対して Data Explorer を有効にするかどうかを示すフラグ。

false

isExtendedStorageSizesEnabled

ブール値

指定されたプロジェクトに対してストレージ サイズ拡張を有効にするかどうかを示すフラグ。

false

isPerformanceAdvisorEnabled

ブール値

指定したプロジェクトの Performance Advisor とプロファイラーを有効にするかどうかを示すフラグ。

false

isRealtimePerformancePanelEnabled

ブール値

指定したプロジェクトに対してリアルタイム パフォーマンス パネルを有効にするかどうかを示すフラグ。

false

isSchemaAdvisorEnabled

ブール値

指定されたプロジェクトに対してスキーマ アドバイザーを有効にするかどうかを示すフラグ。

false

AtlasProject.spec.チーム

Name
タイプ
説明
必須

roles

[]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

オブジェクト

プロジェクトに割り当てられる AtlasTeam カスタムリソースへの参照。

true

AtlasProject.spec.チーム.チームRef

プロジェクトに割り当てられる AtlasTeam カスタムリソースへの参照。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.spec.x509CertRef

X509CertRef は、PEM でエンコードされた CA 証明書を含むKubernetes Secret への参照です。Atlas Kubernetes Operator は、 atlas.mongodb.com/type=credentials のラベルを持つシークレットのみを監視します不要なシークレットを監視しないようにします。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasProject.status

AtlasProjectStatus は、Atlas プロジェクトの監視された状態を定義します

Name
タイプ
説明
必須

conditions

[]オブジェクト

条件は、Atlas カスタム リソースの現在の状態を示すステータスのリストです

true

alertConfigurations

[]オブジェクト

AlertConfigurations アラート構成ステータスのリストが含まれています

false

authModes

[]string

AuthModes には設定された認証モードのリストが含まれています "SCRAM" はデフォルトの認証方法であり、各ユーザーのパスワードが必要です "X509" は自己管理型X.509認証が構成されていることを示します

false

cloudProviderIntegrations

[]オブジェクト

CloudProviderIntegrations には、設定されたクラウドプロバイダーのアクセス ロールのリストが含まれています。AWS のみをサポート

false

customRoles

[]オブジェクト

CustomRoles には、カスタムロールのステータスのリストが含まれています

false

expiredIpAccessList

[]オブジェクト

'deleteAfterDate' が現在の日付より小さいため期限切れとなった IP アクセス リスト エントリの一覧。このフィールドは Atlas 演算子 によって更新されるのは仕様が変更された後にのみ更新されることに注意してください。

false

id

string

Atlas プロジェクトの ID

false

networkPeers

[]オブジェクト

現在のプロジェクトに設定されているピアリングのリスト

false

observedGeneration

integer

ObservedGeneration は、Atlas 演算子が認識しているリソース仕様の生成を示します。Atlas 演算子は、このフィールドを「メタデータ.generate 」の値に更新します。が、リソースの調整を開始するとすぐに 表示されます。形式: int64

false

privateEndpoints

[]オブジェクト

現在のプロジェクトに構成されているプライベートエンドポイントの一覧

false

prometheus

オブジェクト

Prometheus には Prometheus 統合のステータスが含まれ、 prometheusDiscoveryURL

false

teams

[]オブジェクト

チームには teams の割り当てステータスのリストが含まれます

false

AtlasProject.status.条件

条件 は、 特定の点における 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

アラートが確認された日付。アラートが確認されていない場合は、存在しません。

false

acknowledgementComment

string

アラートを確認したユーザーが残すコメント。アラートが確認されていない場合は、存在しません。

false

acknowledgingUsername

string

アラートを確認したユーザーのユーザー名。アラートが確認されていない場合は、存在しません。

false

alertConfigId

string

ID このアラートをトリガーしたアラート構成。

false

clusterId

string

このアラートが適用されるクラスターの ID。BACKUP、REPLICA_SET、CLUSTER タイプのアラートにのみ存在します。

false

clusterName

string

このアラートが適用されるクラスターの名前。BACKUP、REPLICA_SET、CLUSTER タイプのアラートにのみ存在します。

false

created

string

このアラート構成が作成されたとき、UTC の ISO 8601 の日付と時刻形式のタイムスタンプ。

false

currentValue

オブジェクト

CurrentValue は、アラートをトリガーしたメトリクスの現在の値を表します。タイプ HOST_METRIC のアラートにのみ存在します。

false

enabled

ブール値

省略した場合、構成は無効になります。

false

errorMessage

string

ErrorMessage アラート構成が正しくない状態にある場合は、 メッセージが表示されます。

false

eventTypeName

string

アラートをトリガーするイベントの種類。

false

groupId

string

このアラート構成を所有するプロジェクトの一意の識別子。

false

hostId

string

ID メトリクスが含まれるホストの 。HOST、HOST_METRIC、REPLICA_SET タイプのアラートにのみ存在します。

false

hostnameAndPort

string

アラートが適用される各ホストするのホスト名とポート。HOST、HOST_METRIC、REPLICA_SET タイプのアラートにのみ存在します。

false

id

string

Unique identifier.

false

lastNotified

string

このアラートの最後の通知が送信されたとき。 通知が送信された場合にのみ存在します。

false

matchers

[]オブジェクト

EventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 matchers配列を使用してフィルタリングできます。

false

metricName

string

値がしきい値を超えた測定値の名前。eventTypeName が OUTSIDE_METRIC_THRESHOLD に設定されている場合にのみ存在します。

false

metricThreshold

オブジェクト

MetricThreshold アラートがトリガーされます。

false

notifications

[]オブジェクト

アラート条件が検出されたときに通知が送信されます。

false

replicaSetName

string

レプリカセットの名前。HOST、HOST_METRIC、BACKUP、REPLICA_SET タイプのアラートにのみ存在します。

false

resolved

string

アラートが閉じられたとき。ステータスが CLOSED の場合にのみ存在します。

false

severityOverride

string

アラートの 重大度 。

false

sourceTypeName

string

バックアップされるサーバーのタイプ BACKUP のアラートの場合。

false

status

string

アラートの現在の状態。可能な値は次のとおりです: TRACKING、OPEN、CLOSED、CANCELED

false

threshold

オブジェクト

しきい値があるとアラートがトリガーされます。

false

updated

string

このアラート構成が最後に更新されたときの ISO 8601 の日付と時刻形式のタイムスタンプ（UTC）。

false

AtlasProject.status.alertConfigurations.currentValues

現在の値は、アラートをトリガーしたメトリクスの現在の値を表します。HOST_METRICS タイプのアラートにのみ存在します。

Name
タイプ
説明
必須

number

string

メトリクスの値。

false

units

string

値の units。メトリクスの型によって異なります。

false

AtlasProject.status.alertConfigurations.matchers

Name
タイプ
説明
必須

fieldName

string

一致するターゲット オブジェクト内のフィールドの名前。

false

operator

string

フィールドの値をテストするための operator 。

false

value

string

指定された演算子でテストする値。

false

AtlasProject.status.alertConfigurations.metricThreshold

MetricThreshold によりアラートがトリガーされます。

Name
タイプ
説明
必須

threshold

string

アラートがトリガーされるしきい値。

true

metricName

string

確認するメトリクスの名前。

false

mode

string

これは AVERAGE に設定する必要があります。Atlas は現在のメトリクス値を平均として計算します。

false

operator

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。

false

units

string

しきい値の units。

false

AtlasProject.status.alertConfigurations.notifications

Name
タイプ
説明
必須

apiToken

string

Slack API トークンまたは Bot トークン。SLACK 通知タイプに入力されます。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

channelName

string

Slackチャンネル名。SLACK 通知タイプに入力されます。

false

datadogApiKey

string

Datadog API キー。Datadog ダッシュボードで確認できます。DATADOG 通知タイプに入力されます。

false

datadogRegion

string

使用する API URL を示すリージョン

false

delayMin

integer

アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。

false

emailAddress

string

アラート通知が送信されるメールアドレス。EMAIL 通知タイプに入力されます。

false

emailEnabled

ブール値

メール通知を送信するかどうかを示すフラグ。ORG、GROUP、USER の通知タイプに入力されます。

false

flowName

string

小文字の Flowdock フロー名。

false

flowdockApiToken

string

Flowdock パーソナル API トークン。FLOWDOCK 通知タイプに入力されます。後でトークンが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

intervalMin

integer

解決されていない未確認アラートの連続した通知間で待機する時間（分）。

false

mobileNumber

string

アラート通知が送信されるモバイル番号。SMS 通知タイプに入力されます。

false

opsGenieApiKey

string

Opsgenie API キー。OPS_GENIE 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にトークンを除きます。

false

opsGenieRegion

string

どの API URL を使用するかを示すリージョン。

false

orgName

string

小文字の Flowdock組織名。これは、URL string 内のアプリ/ の後に表示される名前です。FLOWDOCK 通知タイプに入力されます。

false

roles

[]string

次の roles はプロジェクト内の権限を付与します。

false

serviceKey

string

PagerDuty サービスキー。PAGER_DUTY 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

false

smsEnabled

ブール値

テキスト メッセージ通知を送信するかどうかを示すフラグ。ORG、GROUP、USER の通知タイプに入力されます。

false

teamId

string

チームの一意の識別子。

false

teamName

string

この通知を受け取ったチームのラベル。

false

typeName

string

アラート通知のタイプ。

false

username

string

通知の送信先となる Atlas ユーザーの名前。ここで許可されるのは、アラート構成を所有するプロジェクト内のユーザーのみです。USER 通知タイプに入力されます。

false

victorOpsApiKey

string

VictorOps API キー。VICTOR_OPS 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

false

victorOpsRoutingKey

string

VictorOps ルーティング キー。VICTOR_OPS 通知タイプに入力されます。後でキーが無効になった場合、Atlas はプロジェクト所有者にメールを送信し、最終的にキーを除きます。

false

AtlasProject.status.alertConfigurations.threshold

しきい値があるとアラートがトリガーされます。

Name
タイプ
説明
必須

operator

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。次の値を受け入れます: GREATER_THAN、LESS_THAN

false

threshold

string

アラートがトリガーされるしきい値。

false

units

string

しきい値の units

false

AtlasProject.status.cloudProviderIntegrations

Name
タイプ
説明
必須

atlasAssumedRoleExternalId

string

Atlas がAmazon Web Servicesアカウントで IAM ロールを引き受けるときに使用する一意の外部 ID MongoDB。

true

providerName

string

ロールのクラウドプロバイダーを識別する、人間が判読できるラベル。

true

atlasAWSAccountArn

string

Atlas がアイデンティティおよびアクセスマネジメントロールを引き受けるときに使用する MongoDB Amazon Web Services ユーザーアカウントを識別する Amazon リソース名。

false

authorizedDate

string

指定されたクラウドサービス プロバイダーに対してこのロールを許可した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

false

createdDate

string

指定されたクラウドサービス プロバイダーに対してこのロールを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

false

errorMessage

string

返されたアプリケーション エラー メッセージ。

false

featureUsages

[]オブジェクト

このAmazon Web Services アイデンティティおよびアクセスマネジメントロールに関連付けられているアプリケーション機能を含むリスト。

false

iamAssumedRoleArn

string

Amazonリソース名。これは、AWS アカウントのリソースにアクセスするときに MongoDB クラウドが引き受けるAmazon Web Services アイデンティティおよびアクセスマネジメントロールを識別します。

false

roleId

string

ロールを識別するユニークな 24 桁の 16 進数の文字列。

false

status

string

サービス アカウントの status をプロビジョニングします。値は、IN_PROGRESS、COMPLETE、FAILED、または NOT_INITIATED です。

false

AtlasProject.status.cloudProviderIntegration.featureUsers

Name
タイプ
説明
必須

featureId

string

このAmazon Web Services アイデンティティおよびアクセスマネジメントロールにリンクされたデータレイクに関する特性を特定します。

false

featureType

string

このAmazon Web Services ID とアクセスマネジメントロールにリンクされた 1 つの MongoDB クラウド機能を説明する、人間が判読できるラベル。

false

AtlasProject.status.customRoles

Name
タイプ
説明
必須

name

string

一意のロール name

true

status

string

指定されたカスタムロールの status（OK または FAILED）

true

error

string

カスタムロールがFAILEDステータスのときのメッセージ

false

AtlasProject.status.expiredIpAccessList

IPAccessList を使用すると、プロジェクトのIPアクセス リストを使用できます。詳細については、 https://mongodb.com/java-j/docs/atlas/ 参照/api/ip-access-list/add-entries-to-access-list/ を参照してください。非推奨: ガイド 8sort-migration-ptr

Name
タイプ
説明
必須

awsSecurityGroup

string

このアクセス リスト エントリ内の AWS セキュリティ グループの一意の識別子。

false

cidrBlock

string

このアクセス リスト エントリの CIDR 表記の IP アドレスの範囲。

false

comment

string

このアクセス リスト エントリに関連付けられたコメント。

false

deleteAfterDate

string

ISO 8601 の日付と時刻形式（UTC のタイムスタンプ）。このあと Atlas は一時的なアクセスリストのエントリを削除します。

false

ipAddress

string

このアクセス リスト エントリで IP アドレスを使用するエントリ。

false

AtlasProject.status.networkPears

Name
タイプ
説明
必須

id

string

NetworkPeer の一意の識別子。

true

providerName

string

ピアリングを検索するクラウドプロバイダー。

true

region

string

ピアリングを作成するリージョン。次の場合は不要です: GCP

true

atlasGcpProjectId

string

ProjectID の Atlasコンテナ。GCP にのみ適用されます。ネットワークピアリング接続を追加するには、必要です。

false

atlasNetworkName

string

Atlas ネットワーク名。GCP にのみ適用されます。ネットワークピアリング接続を追加するには、必要です。

false

connectionId

string

ネットワークピアリング接続の一意の識別子です。AWS にのみ適用されます。

false

containerId

string

ContainerID の Atlas ネットワーク ピアリングコンテナ。

false

errorMessage

string

ネットワーク ピアリングのエラー状態。GCP にのみ適用されます。

false

errorState

string

ネットワーク ピアリングのエラー状態。Azureにのみ適用されます。

false

errorStateName

string

ネットワーク ピアリングのエラー状態。AWS にのみ適用されます。

false

gcpProjectId

string

ProjectID ユーザーの vPC のGCP にのみ適用されます。

false

status

string

ネットワークピアリングのステータス。GCP とAzureにのみ適用されます。

false

statusName

string

ネットワークピアリングのステータス。AWS にのみ適用されます。

false

vpc

string

VPC は、VPC の名前を保存するための一般的な目的のフィールドです。VPC は、AWS では vpcID、GCP ではユーザー networkName、 Azureでは vnetName です。

false

AtlasProject.status.privateEndpoints

Name
タイプ
説明
必須

provider

string

プライベートエンドポイント サービスを検索するクラウド provider。Atlas は AWS または AZURE を受け入れます。

true

region

string

プライベートエンドポイント サービスを作成するクラウドプロバイダー region。

true

endpoints

[]オブジェクト

ネットワークエンドポイント グループを構成する個々の GCP プライベート endpoints のコレクション。

false

id

string

AWS または AZURE プライベート リンク接続の一意の識別子。

false

interfaceEndpointId

string

AWS またはAzure Private Link インターフェイスエンドポイントの一意の識別子。

false

serviceAttachmentNames

[]string

GCP Private Service Connect エンドポイントとなる接続されたデバイスに関連付けられたサービス アタッチメントを識別する一意の英数字および特殊文字の文字列。

false

serviceName

string

Atlas がマネージドする AWS または Azure Private Link Service の名前。

false

serviceResourceId

string

Azure Private Link Service の一意の識別子です（AWS は ID と同じ）。

false

AtlasProject.status.privateEndpoints.エンドポイントとなる接続されたデバイス

Name
タイプ
説明
必須

endpointName

string

作成した Google Cloud コンシューマー転送ルールを識別する、人間に判読可能なラベル。

true

ipAddress

string

この Google Cloud コンシューマー転送ルールが解決される、1 つのプライベート インターネット プロトコル バージョン 4（IPv4）アドレス。

true

status

string

MongoDB クラウドがこのリクエストを受信したときの MongoDB Atlas エンドポイントとなる接続されたデバイスグループの状態。

true

AtlasProject.status.prometheus

Prometheus には、 prometheusDiscoveryURL を含む Prometheus 統合のステータスが含まれます

Name
タイプ
説明
必須

prometheusDiscoveryURL

string

URL Prometheus がターゲットを取得する場所。

false

scheme

string

Prometheus リクエストに使用されるプロトコル scheme。

false

AtlasProject.status.チーム

Name
タイプ
説明
必須

teamRef

オブジェクト

ResourceRefNamespaced は、名前空間を構成できるKubernetesリソースへの参照です

true

id

string

false

AtlasProject.status.チーム. teamRef

ResourceRefNamespaced は Kubernetes のリソースへの参照であり、名前空間を構成できます

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

戻る

カスタム リソース

次へ

AtlasDeployment

項目一覧