/ /

`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カスタムリソースパラメータについて説明します。

metadata.name

型: string

必須

Name that the AtlasThirdPartyIntegration Custom Resource uses to add this third-party integration to a project.

metadata.namespace

型: string

任意

AtlasThirdPartyIntegration カスタムリソースを含める名前空間。指定されていない場合、Atlas Kubernetes Operator は kubectl によって設定された現在の名前空間を使用します。

spec.connectionSecret

型: string

条件付き

Atlas Kubernetes Operator が Atlas に接続するために使用する組織IDとAPIキーを含む opaque secret の名前。指定されていない場合、Atlas Kubernetes Operator は次のいずれかにフォールバックします。

親 atlasProject の spec.connectionSecretRef.name パラメータ
デフォルトの global シークレット（親 atlasProject に対して spec.connectionSecretRef.name が未定義の場合）

このパラメータは独立した CRD に必須です。

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

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

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

spec.externalProjectRef

型: string

条件付き

サードパーティ統合が属するプロジェクトのID 。既存の Atlas プロジェクトのプロジェクトIDを指定する必要があります。このパラメータは、次のいずれかによって管理されるプロジェクトに属するサードパーティ統合に必要です。

Atlas Kubernetes Operator の別のインスタンス
Atlas Kubernetes Operator 以外のツール

Atlas Kubernetes Operator の同じインスタンスによって管理されるプロジェクトに属する配置では、 spec.externalProjectRef.id を使用しない場合は spec.projectRef.name を使用します。

サードパーティ統合は 1 つのプロジェクトにのみ属することができます。複数のプロジェクトに対して同じサードパーティ統合を定義するには、プロジェクトごとにカスタムリソース定義を作成します。

spec.projectRef.name

型: string

条件付き

サードパーティ統合が属するプロジェクトの名前。既存の AtlasProject カスタムリソースを指定する必要があります。このパラメーターは、同じインスタンスAtlas Kubernetes Operator によって管理されるプロジェクトに属するサードパーティ統合にのみ適用されます。

次のいずれかによって管理されるプロジェクトに属するサードパーティ統合の場合。

Atlas Kubernetes Operator の別のインスタンス
Atlas Kubernetes Operator 以外のツール

spec.externalProjectRef.id を使用します。

spec.type

型: string

必須

Atlas と統合するサードパーティサービスの名前。この値は、次のいずれかである必要があります。

DATADOG
MICROSOFT_TEAMS
NEW_RELIC
OPS_GENIE
PAGER_DUTY
PROMETHEUS
SLACK
VICTOR_OPS
WEBHOOK

各統合 type には個別の構成フィールドセットが必要です。例、type を DATADOG に設定する場合、構成する必要があるのは spec.datadogドキュメントとそのサブフィールドのみです。

同じプロジェクト内で複数のサードパーティ統合を定義するには、それぞれに対して個別の CRD を作成する必要があります。特定のプロジェクト内では各統合タイプの 1 つのインスタンスのみを定義できます。これは、この CRD と AtlasProject CRD の spec.integrations パラメータの両方に適用されます。

spec.datadog

型: ドキュメント

条件付き

DataDog サードパーティサービス統合の構成パラメーターを宣言するドキュメント。