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
/ /
/ / /

AtlasThirdPartyIntegration カスタム リソース

AtlasThirdPartyIntegration カスタムリソースは、 Atlasプロジェクトでのサードパーティ統合を構成します。これらのリソースにより、さまざまなモニタリング サービスとの サードパーティ統合 を管理し、Atlas 配置のパフォーマンスを収集および分析できます。

重要

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

  • 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演算子.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

次の例では、 基本的な例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 は、 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(Self.``projectRef``)) || (ディレクティブを使用したプロジェクト参照)externalProjectRefprojectRef

  • (has(自分.``externalProjectRef``) &= は(自己.`` connectionSecret``)) ||他のプロジェクトを参照するときに、ローカル接続のシークレットを定義する必要があります:

  • has(Security.type) &+ auto.type.size() != 0: 統合のタイプを定義する必要があります

  • !has(Self.datadog)|||| (自己.type == 'DATADOG' &= は(自己.datadog)): DATADOG 型のみが datadog フィールドを設定できます

  • !has(自分.``MicrosoftTeams``) || (セルフ.type == 'MICROSOFT_TEAMS' & は(自己.``MicrosoftTeams``): MICROSOFT_TEAMS 型のみが microsoftTeams フィールドを設定できます

  • !has(自分.``newRelic``) || (自己.type == 'NEW_RELIC' & は(自己.``newRelic``): NEW_RELIC 型のみが newRelic フィールドを設定できます

  • !has(自分.``opsgenie``) || (自己.type == 'OPS_GENIE' & は(自己.``opsgenie``): OPS_GENIE 型のみが opsGenie フィールドを設定できます

  • !has(Self.prometheus) || (セルフ.type == 'PROMETHEUS' &= は(自己.prometheus)): Prometheus フィールドを設定できるのは PROMETHEUS 型のみ

  • !has(自分.``pagerDuty``)||||================================== (自己.type == 'PAGER_DUTY' & は(自己.``pagerDuty``): PAGER_DUTY 型のみが pagerDuty フィールドを設定できます。

  • !has(自己 .slack) || (自己.type == 'SLACK' &= は(自己.slack)):SLACK 型のみがスローダウン フィールドを設定できます

  • !has(secondorOps``) || (自己.type == 'VICTOR_OPS' &8 は(自己.``vectorOps``): VICTOR_OPS 型のみが victorOps フィールドを設定できます

  • !has(Self.Webhook)|||| (自己.type == 'WEBHOOK' &= は(自己.Webhook)): Webhook フィールドを設定できるのは WEBHOOK 型のみ

false

status

オブジェクト

AtlasThirdPartyIntegrationStatus 統合の status を保持します

false

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

Name
タイプ
説明
必須

type

列挙

統合のタイプ。列挙: DATADOGMICROSOFT_TEAMSNEW_RELICOPS_GENIEPAGER_DUTYPROMETHEUSSLACKVICTOR_OPSWEBHOOK

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

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

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

Name
タイプ
説明
必須

apiKeySecretRef

オブジェクト

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

true

region

string

リージョンは Datadog リージョンです

true

sendCollectionLatencyMetrics

列挙

SendCollectionLatencyMetrics コレクションレイテンシメトリクスの送信を切り替えます。列挙: 有効、無効 デフォルト: 無効

false

sendDatabaseMetrics

列挙

SendDatabaseMetrics データベースやコレクション名を含むデータベースメトリクスの送信を切り替えます。列挙: 有効、無効 デフォルト: 無効

false

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

id

string

ID は、AtlasプロジェクトID です。

true

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

Name
タイプ
説明
必須

urlSecretRef

オブジェクト

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

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

credentialsSecretRef

オブジェクト

CredentialsSecretRef は、アカウント ID、ライセンス キー、読み取りトークンと書込みトークンなど、新しいノードの認証情報を含むシークレットの名前を保持します。

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

apiKeySecretRef

オブジェクト

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

true

region

string

リージョンは Ops Genie リージョンです。

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

region

string

リージョンは ページ ダンプ リージョンです。

true

serviceKeySecretRef

オブジェクト

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

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

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

Name
タイプ
説明
必須

enabled

string

Prometheus 統合が有効になっている場合、Enabled は true です。

true

prometheusCredentialsSecretRef

オブジェクト

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

true

serviceDiscovery

列挙

ServiceDiscovery Prometheus で使用する列挙:ファイル、HTTP

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

apiTokenSecretRef

オブジェクト

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

true

channelName

string

ChannelName Prometheus で使用する

true

teamName

string

TeamName Prometheus 統合が有効になっているかどうかのフラグ。

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

apiKeySecretRef

オブジェクト

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

true

routingKey

string

RoutingKeyVictorOps ルーティング キーを保持します。

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

urlSecretRef

オブジェクト

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

true

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

Name
タイプ
説明
必須

name

string

参照されているリソースの名前の詳細情報: https://kubernetes.io/docs/concers/overview/work-with-objects/names/#names

true

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

Name
タイプ
説明
必須

conditions

[]オブジェクト

ステータスの詳細を保持する条件

false

id

string

ID Atlas 内の サードパーティ統合リソースの

false

条件 には、この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

戻る

AtlasStreamWorkspace

項目一覧