/ /

`AtlasThirdPartyIntegration` カスタムリソース

The AtlasThirdPartyIntegration custom resource configures third party integrations in an Atlas project. These resources allow you to manage third-party integrations with various monitoring services to collect and analyze the performance of your Atlas deployment.

重要

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

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

同様に、Atlas Kubernetes Operator を使用してKubernetesの Atlasプロジェクトからチームを削除しても、Atlas Kubernetes Operator は Atlas からチームを削除しません。
デフォルトのAtlas 構成値が暗黙的に使用されるのを避けるために、必要な構成の詳細を明示的に定義します。場合によっては、Atlas のデフォルトを継承すると調整ループが発生し、カスタムリソースがREADY 状態に達しなくなります。例、含まれている例に示すように、 AtlasDeployment カスタムリソースで必要なオートスケーリング動作を明示的に定義すると、カスタムリソース内の静的インスタンスサイズが、オートスケーリングが有効になっている Atlas 配置に繰り返し適用されないことが保証されます。
autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40

Atlas Kubernetes Operator は、Atlas サードパーティサービス統合APIリソースを使用して次のいずれかのアクションを実行します。

新しいサードパーティサービス統合を作成します。
既存のサードパーティサービス統合をアップデートします。

例

基本的な例

次の例では、my-projectプロジェクト内で DataDog 統合を定義する AtlasThirdPartyIntegration カスタムリソースを示しています。

apiVersion: atlas.mongodb.com/v1
kind: AtlasThirdPartyIntegration
metadata:
  name: my-atlas-integ
spec:
  projectRef:
    name: my-project
    namespace: my-operator-namespace
  type: DATADOG
  datadog:
    apiKeySecretRef:
      name: datadog-secret
    region: US
    sendCollectionLatencyMetrics: enabled
    sendDatabaseMetrics: enabled

独立した CRD の例

The following example shows an AtlasThirdPartyIntegration independent CRD that defines the same Datadog integration defined in the Basic Example. This custom resource definition allows you to create this third-party integration in a project you don't manage in the same instance of Atlas Kubernetes Operator with which you define this resource. To enable independent operation, you must use an externalProjectRef instead of a projectRef, and you must supply a connectionSecret directly since this resource can't inherit API credentials from its parent project.

apiVersion: atlas.mongodb.com/v1
kind: AtlasThirdPartyIntegration
metadata:
  name: my-atlas-integ
spec:
  externalProjectRef:
    projectID: 66e2f2b621571b7e69a89b66
  connectionSecret:
    name: atlas-connection-secret
  type: DATADOG
  datadog:
    apiKeySecretRef:
      name: datadog-secret
    region: US
    sendCollectionLatencyMetrics: enabled
    sendDatabaseMetrics: enabled

パラメーター

AtlasThirdPartyIntegration

AtlasThirdPartyIntegration は、 atlas 3 サードパーティ統合APIのスキーマです。

`Name`	タイプ	説明	必須
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasThirdPartyIntegration`	true
`metadata`	オブジェクト	`metadata`フィールドのフィールドについては、 Kubernetes `API` のドキュメントを参照してください。	true
`spec`	オブジェクト	`AtlasThirdPartyIntegrationSpec` には、統合検証に期待される構成が含まれています。 (has(自分:``externalProjectRef``)&+ .has(自分.``projectRef``))\|\| （!has(自分自身.``externalProjectRef``)& は（自分自身.``projectRef``):`externalProjectRef` または `projectRef` を通じてプロジェクト参照を1 つだけ定義する必要があります (has(自分:``externalProjectRef``)&+ has(自己.`` connectionSecret``))\|\|です:は、外部プロジェクトを参照するときにローカル接続シークレットを定義する必要があります has(自己.type)&amp .type.size()!= 0: 統合のタイプを定義する必要があります !has(自分自身.datadog)\|\| （自分自身.type == '`DATADOG`' &= は（自己.datadog））:Datadog フィールドを設定できるのは `DATADOG` タイプのみ !has(自分.``MicrosoftTeams``)\|\| （自己.type == '`MICROSOFT_TEAMS`' &amp は（自己.``MicrosoftTeams``））:`MICROSOFT_TEAMS` タイプのみが `microsoftTeams` フィールドを設定できます !has(自分.``newRelic``)\|\| （自己.type == '`NEW_RELIC`' &amp は（自己.``newRelic``):`NEW_RELIC` タイプのみが `newRelic` フィールドを設定できますです:\|\| （自己.type == '`OPS_GENIE`' & は（自己.``opsgenie``)）:`OPS_GENIE` タイプのみが `opsGenie` フィールドを設定できます !has(セルフ.prometheus)\|\| （Security.type == '`PROMETHEUS`' &= は（として名が設定されている場合））:Prometheus フィールドを設定できるのは `PROMETHEUS` タイプのみ !has(自分.``pagerDuty``)\|\| （自己.type == '`PAGER_DUTY`' & は（自己.``pagerDuty``)）:`PAGER_DUTY` タイプのみが `pagerDuty` フィールドを設定できます !has(Self.slack)\|\| （セルフ.type == '`SLACK`' &+ has(Self.slack)）:`SLACK` 型のみが slack フィールドを設定する可能性があります !has(自己 .``vectorOps``)\|\| （自己.type == '`VICTOR_OPS`' & は（自己.``vectorOps``）:`VICTOR_OPS` タイプのみが `victorOps` フィールドを設定できます !has(セルフ.Webhook)\|\| （セルフ.type == '`WEBHOOK`' &= は（自己.Webhook））:Webhook フィールドを設定できるのは `WEBHOOK` タイプのみ	false
`status`	オブジェクト	`AtlasThirdPartyIntegrationStatus` 統合の `status` を保持します	false

AtlasThirdPartyIntegration.spec

AtlasThirdPartyIntegrationSpec には統合に期待される構成が含まれています

`Name`	タイプ	説明	必須
`type`	列挙	統合のタイプ。列挙: `DATADOG`、`MICROSOFT_TEAMS`、`NEW_RELIC`、`OPS_GENIE`、`PAGER_DUTY`、`PROMETHEUS`、`SLACK`、`VICTOR_OPS`、`WEBHOOK`	true
`connectionSecret`	オブジェクト	Atlas `API` の秘密キーと公開キーを含むシークレットの名前。	false
`datadog`	オブジェクト	Datadog には、Datadog の統合用に構成フィールドが含まれています。	false
`externalProjectRef`	オブジェクト	`externalProjectRef` は親 Atlasプロジェクト`ID` を保持します。"`projectRef`"フィールドと排他関係にあります。	false
`microsoftTeams`	オブジェクト	`MicrosoftTeams` には、 Microsoft Teams の統合の構成フィールドが含まれています。	false
`newRelic`	オブジェクト	`NewRelic` には New Relic の統合の構成フィールドが含まれています。	false
`opsGenie`	オブジェクト	`OpsGenie` には、Ops Genie の統合の構成フィールドが含まれています。	false
`pagerDuty`	オブジェクト	`PagerDuty` には、`PagerDuty` の統合の構成フィールドが含まれています。	false
`projectRef`	オブジェクト	`projectRef` は親の `AtlasProject`リソースへの参照です。"`externalProjectRef`"フィールドと排他関係にあります。	false
`prometheus`	オブジェクト	Prometheus には、Prometheus 統合の構成フィールドが含まれています。	false
`slack`	オブジェクト	Slack には、Slack の統合の設定フィールドが含まれています。	false
`victorOps`	オブジェクト	`VictorOps` には、`VictorOps` の統合の構成フィールドが含まれています。	false
`webhook`	オブジェクト	Webhook には、Webhook 統合の構成フィールドが含まれています。	false

AtlasThirdPartyIntegration.spec. connectionSecret

Atlas API の秘密キーと公開キーを含むシークレットの名前。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.datadog

Datadog には、Datadog の統合用に構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`apiKeySecretRef`	オブジェクト	APIKeySecretRef には、Datadog `API` キーを含むシークレットの名前が保持されます。	true
`region`	string	リージョンは Datadog リージョンです	true
`sendCollectionLatencyMetrics`	列挙	`SendCollectionLatencyMetrics` コレクションのレイテンシメトリクスの送信を切り替えます。列挙: 有効、無効デフォルト: 無効	false
`sendDatabaseMetrics`	列挙	`SendDatabaseMetrics` データベースやコレクション名を含むデータベースメトリクスの送信を切り替えます。列挙: 有効、無効デフォルト: 無効	false
`sendQueryStatsMetrics`	列挙	`SendQueryStatsMetrics` レイテンシ、実行頻度、返されたドキュメント、タイムスタンプに関するクエリハッシュとメトリクスを含むクエリシェイプメトリクスの送信を切り替えます。列挙: enabled、disabled デフォルト: disabled	false
`sendUserProvidedResourceTags`	列挙	`SendUserProvidedResourceTags` DataDog メトリクスとともにユーザーが提供したグループとクラスターのリソースタグの送信を切り替えます。列挙: enabled、disabled デフォルト: disabled	false

AtlasThirdPartyIntegration.spec.datadog.apiKeySecretRef

APIKeySecretRef には、Datadog APIキーを含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.externalProjectRef

externalProjectRef は親 AtlasプロジェクトIDを保持します。"projectRef"フィールドと排他関係にあります。

`Name`	タイプ	説明	必須
`id`	string	`ID` は、Atlasプロジェクト`ID` です。	true

AtlasThirdPartyIntegration.spec.MicrosoftTeams

MicrosoftTeams には、 Microsoft Teams の統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`urlSecretRef`	オブジェクト	URLSecretRef には、 Microsoft Teams シークレット `URL` を含むシークレットの名前が保持されます。	true

AtlasThirdPartyIntegration.spec.MicrosoftTeams.urlSecretRef

URLSecretRef には、Microsoft Teams シークレットURLを含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.newRelic

NewRelic には、New Relic の統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`credentialsSecretRef`	オブジェクト	`CredentialsSecretRef` は、アカウント id、ライセンスキー、読み取りトークンと書き込みトークンなど、New Relic の認証情報を含むシークレットの名前を保持します。	true

AtlasThirdPartyIntegration.spec.newRelic.credentialsSecretRef

[CredentialsSecretRef] には、アカウント ID、ライセンスキー、読み取りトークンと書き込み (write) トークンなどの new relic の認証情報を含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.opsgenie

Opsgenie には、Ops Genie の統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`apiKeySecretRef`	オブジェクト	APIKeySecretRef には、Ops Genie の `API` キーを含むシークレットの名前が保持されます。	true
`region`	string	リージョンは Ops Genie リージョンです。	true

AtlasThirdPartyIntegration.spec.opsgenie.apiKeySecretRef

APIKeySecretRef には、Ops Genie のAPIキーを含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.pagerDuty

PagerDuty には、PagerDuty 統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`region`	string	リージョンはページダンプリージョンです。	true
`serviceKeySecretRef`	オブジェクト	`ServiceKeySecretRef` は、Pager Duty サービスキーを含むシークレットの名前を保持します。	true

AtlasThirdPartyIntegration.spec.pagerDuty.serviceKeySecretRef

ServiceKeySecretRef は、Pager Duty サービスキーを含むシークレットの名前を保持します。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.projectRef

projectRef は、親の Atlas Projectリソースへの参照です。"external ProjectRef"フィールドと排他関係にあります。

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

AtlasThirdPartyIntegration.spec.prometheus

Prometheus には、Prometheus 統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`enabled`	string	Prometheus 統合が有効になっている場合、Enabled は true です。	true
`prometheusCredentialsSecretRef`	オブジェクト	`PrometheusCredentialsSecretRef` Prometheus を含むシークレットの名前を保持します。ユーザー名とパスワード	true
`serviceDiscovery`	列挙	`ServiceDiscovery` Prometheus で使用する列挙:ファイル、HTTP	true

AtlasThirdPartyIntegration.spec.prometheus.prometheusCredentialsSecretRef

PrometheusCredentialsSecretRef は、Prometheus を含むシークレットの名前を保持します。ユーザー名とパスワード

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.slack

Slack には、Slack の統合の設定フィールドが含まれています。

`Name`	タイプ	説明	必須
`apiTokenSecretRef`	オブジェクト	APITokenSecretRef には、 Slack `API` トークンを含むシークレットの名前が保持されます。	true
`channelName`	string	`ChannelName` Prometheus で使用する	true
`teamName`	string	`TeamName` Prometheus 統合が有効になっているかどうかのフラグ。	true

AtlasThirdPartyIntegration.spec.slack.apiTokenSecretRef

APITokenSecretRef には、 Slack APIトークンを含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.vectorOps

VictorOps には VictorOps 統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`apiKeySecretRef`	オブジェクト	APIKeySecretRef は、Victor Ops `API` キーを含むシークレットの名前です。	true
`routingKey`	string	`RoutingKey` は `VictorOps` ルーティングキーを保持します。	true

AtlasThirdPartyIntegration.spec.vectorOps.apiKeySecretRef

APIKeySecretRef は、Victor Ops APIキーを含むシークレットの名前です。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.spec.webhook

Webhook には、Webhook 統合の構成フィールドが含まれています。

`Name`	タイプ	説明	必須
`urlSecretRef`	オブジェクト	URLSecretRef には、Webhook `URL` とシークレットを含むシークレットの名前が保持されます。	true

AtlasThirdPartyIntegration.spec.webhook.urlSecretRef

URLSecretRef には、Webhook URLとシークレットを含むシークレットの名前が保持されます。

`Name`	タイプ	説明	必須
`name`	string	参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasThirdPartyIntegration.status

AtlasThirdPartyIntegrationStatus は統合のステータスを保持します

`Name`	タイプ	説明	必須
`conditions`	[]オブジェクト	ステータスの詳細を保持する条件	false
`id`	string	`ID` Atlas 内のサードパーティ統合リソースの	false

AtlasThirdPartyIntegration.status.条件

条件には、このAPIリソースの現在の状態の 1 つの詳細が含まれます。

`Name`	タイプ	説明	必須
`lastTransitionTime`	string	`lastTransitionTime` は、条件があるステータスから別のステータスに最後に移行した時刻です。これは、基礎の条件が変更されたときです。それが不明な場合は、`API`フィールドが変更された時間を使用できます。形式: 日時	true
`message`	string	メッセージは、移行に関する詳細を示す、人間が判読できる`message`です。これは空の文字列にすることができます。	true
`reason`	string	explain には、条件の最後のトランザクションの `reason` を示すプログラムによる識別子が含まれています。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された `API` と見なされるかどうかを定義できます。値は `CamelCase` string である必要があります。このフィールドは空であってはなりません。	true
`status`	列挙	条件のステータス。True、False、Unknown のいずれか。列挙: true、false、不明	true
`type`	string	`CamelCase` または foo 内の条件のタイプ（例:.com/`CamelCase`）。	true
`observedGeneration`	integer	`observedGeneration` は、を表します。条件が基づいて設定されたメタデータ. 生成。インスタンスの場合は。メタデータ.生成は現在 12 ですが、.status.条件[x].``observedGenation`` は 9 であり、インスタンスの現在の状態に関して条件は古くなります。形式: int64 最小: 0	false

はじめる

AtlasThirdPartyIntegration カスタム リソース

例