AtlasThirdPartyIntegration カスタムリソースは、 Atlasプロジェクトでのサードパーティ統合を構成します。これらのリソースにより、さまざまなモニタリング サービスとの サードパーティ統合 を管理し、Atlas 配置のパフォーマンスを収集および分析できます。
重要
カスタム リソースはデフォルトでオブジェクトを削除しなくなりました
Atlas Kubernetes Operator は、 カスタムリソース構成ファイルを使用して Atlas 構成を管理しますが、Atlas Kubernetes Operator2.0 以降、 Kubernetesで削除したカスタム リソースは Atlas で削除されなくなりました(デフォルトでは )。代わりに、Atlas Kubernetes Operator は Atlas 内のそれらのリソースの管理を停止します。 例、 Kubernetesで カスタム リソースを削除すると、デフォルトでは、Atlas Kubernetes Operator は Atlas
AtlasProjectから対応するプロジェクトを自動的に削除しなくなります。この動作の変更は、誤ってまたは予期せずに削除されるのを防ぐことを目的としています。 この動作を Atlas Kubernetes Operator.2 0より前に使用されていたデフォルトに戻す方法などの詳細については、「新しいデフォルト: Atlas Kubernetes演算子.2 の削除保護」を参照してください。0同様に、Atlas Kubernetes Operator を使用してKubernetesの Atlasプロジェクトからチームを削除しても、Atlas Kubernetes Operator は Atlas からチームを削除しません。
デフォルトのAtlas 構成値が暗黙的に使用されるのを避けるために、必要な構成の詳細を明示的に定義します。 場合によっては、Atlas のデフォルトを継承すると調整ループが発生し、カスタムリソースが
READY状態に達しなくなります。 例、含まれている例に示すように、AtlasDeploymentカスタムリソースで必要なオートスケーリング動作を明示的に定義すると、カスタムリソース内の静的インスタンスサイズが、オートスケーリングが有効になっている Atlas 配置に繰り返し適用されないことが保証されます。autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40
Atlas Kubernetes Operator は、Atlas サードパーティ サービス統合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 の例
次の例では、 基本的な例AtlasThirdPartyIntegration で定義されているのと同じ DataDog 統合を定義する 独立した CRD を示しています。このカスタムリソース定義により、このリソースが定義されている Atlas Kubernetes Operator の同じプロジェクトで、このサードパーティ統合を作成できます。独立した操作を有効にするには、projectRef ではなく externalProjectRef を使用する必要があります。また、このリソースは親プロジェクトからAPI認証情報を継承できないため、connectionSecret を直接指定する必要があります。
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 | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | atlas.mongodb.com/v1 | true |
| string |
| true |
| オブジェクト |
| true |
| オブジェクト |
| false |
| オブジェクト |
| false |
AtlasThirdPartyIntegration.spec
AtlasThirdPartyIntegrationSpec には統合に期待される構成が含まれています
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| 列挙 | 統合のタイプ。列挙: | true |
| オブジェクト | Atlas | false |
| オブジェクト | Datadog には、Datadog の統合用に構成フィールドが含まれています。 | false |
| オブジェクト |
| false |
| オブジェクト |
| false |
| オブジェクト |
| false |
| オブジェクト |
| false |
| オブジェクト |
| false |
| オブジェクト |
| false |
| オブジェクト | Prometheus には、Prometheus 統合の構成フィールドが含まれています。 | false |
| オブジェクト | Slack には、Slack の統合の設定フィールドが含まれています。 | false |
| オブジェクト |
| false |
| オブジェクト | Webhook には、Webhook 統合の構成フィールドが含まれています。 | false |
AtlasThirdPartyIntegration.spec. connectionSecret
Atlas API の秘密キーと公開キーを含むシークレットの名前。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.datadog
Datadog には、Datadog の統合用に構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | APIKeySecretRef には、Datadog | true |
| string | リージョンは Datadog リージョンです | true |
| 列挙 |
| false |
| 列挙 |
| false |
AtlasThirdPartyIntegration.spec.datadog.apiKeySecretRef
APIKeySecretRef には、Datadog APIキーを含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.externalProjectRef
externalProjectRef は親 AtlasプロジェクトIDを保持します。 "projectRef"フィールドと排他関係にあります。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string |
| true |
AtlasThirdPartyIntegration.spec.MicrosoftTeams
MicrosoftTeams には、 Microsoft Teams の統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | URLSecretRef には、 Microsoft Teamss シークレット | true |
AtlasThirdPartyIntegration.spec.MicrosoftTeams.urlSecretRef
URLSecretRef には、 Microsoft Teamss シークレットURLを含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.newRelic
NewRelic には、New Relic の統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト |
| true |
AtlasThirdPartyIntegration.spec.newRelic.credentialsSecretRef
[CredentialsSecretRef] には、アカウント ID、ライセンスキー、読み取りトークンと書込みトークンなどの new relic の認証情報を含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.opsgenie
Opsgenie には、Ops Genie の統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | APIKeySecretRef には、Ops Genie の | true |
| string | リージョンは Ops Genie リージョンです。 | true |
AtlasThirdPartyIntegration.spec.opsgenie.apiKeySecretRef
APIKeySecretRef には、Ops Genie のAPIキーを含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.pagerDuty
PagerDuty には、PagerDuty 統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | リージョンは ページ ダンプ リージョンです。 | true |
| オブジェクト |
| true |
AtlasThirdPartyIntegration.spec.pagerDuty.serviceKeySecretRef
ServiceKeySecretRef は、Pager Duty サービス キーを含むシークレットの名前を保持します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.projectRef
projectRef は、親の Atlas Projectリソースへの参照です。 "external ProjectRef"フィールドと排他関係にあります。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | Kubernetesリソースの名前 | true |
| string | Kubernetesリソースの名前空間 | false |
AtlasThirdPartyIntegration.spec.prometheus
Prometheus には、Prometheus 統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | Prometheus 統合が有効になっている場合、Enabled は true です。 | true |
| オブジェクト |
| true |
| 列挙 |
| true |
AtlasThirdPartyIntegration.spec.prometheus.prometheusCredentialsSecretRef
PrometheusCredentialsSecretRef は、Prometheus を含むシークレットの名前を保持します。ユーザー名とパスワード
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.slack
Slack には、Slack の統合の設定フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | APITokenSecretRef には、 Slack | true |
| string |
| true |
| string |
| true |
AtlasThirdPartyIntegration.spec.slack.apiTokenSecretRef
APITokenSecretRef には、 Slack APIトークンを含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.vectorOps
VictorOps には VictorOps 統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | APIKeySecretRef は、Victor Ops | true |
| string |
| true |
AtlasThirdPartyIntegration.spec.vectorOps.apiKeySecretRef
APIKeySecretRef は、Victor Ops APIキーを含むシークレットの名前です。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.spec.webhook
Webhook には、Webhook 統合の構成フィールドが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト | URLSecretRef には、Webhook | true |
AtlasThirdPartyIntegration.spec.webhook.urlSecretRef
URLSecretRef には、Webhook URLとシークレットを含むシークレットの名前が保持されます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names | true |
AtlasThirdPartyIntegration.status
AtlasThirdPartyIntegrationStatus は統合のステータスを保持します
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []オブジェクト | ステータスの詳細を保持する条件 | false |
| string |
| false |
AtlasThirdPartyIntegration.status.条件
条件 には、このAPIリソースの現在の状態の 1 つの詳細が含まれます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string |
| true |
| string | メッセージは、移行に関する詳細を示す、人間が判読できる | true |
| string | explain には、条件の最後のトランザクションの | true |
| 列挙 | 条件のステータス。True、False、Unknown のいずれか。列挙: true、false、不明 | true |
| string |
| true |
| integer |
| false |