/ /

`AtlasPrivateEndpoint` カスタムリソース

重要

レガシーサブリソースは、対応する CRD のリリース時点で非推奨となります。構成が現在、このリソース定義のサブリソース形式に依存している場合は、は CRD に移行します。

AtlasPrivateEndpointカスタムリソースは、 Atlasプロジェクトのプライベートエンドポイントを構成します。これにより、パブリックネットワーク経由で情報を送信せずに、クラウドプロバイダーを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 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リソースを使用して次のいずれかのアクションを実行します。

新しいプライベートエンドポイントサービスを作成します。
既存のプライベートエンドポイントサービスを更新します。

Atlas Kubernetes Operator でプライベートエンドポイントを実装する方法の詳細については、プライベートエンドポイントの管理を参照してください。

例

基本的な例

AtlasPrivateEndpoint次の例では、 my-projectプロジェクト内で Amazon Web Servicesプライベートエンドポイントを定義するカスタムリソースを示しています。

apiVersion: atlas.mongodb.com/v1
kind: AtlasPrivateEndpoint
metadata:
 name: my-atlas-pe1
spec:
  projectRef:
    name: my-project
    namespace: my-operator-namespace
  provider: AWS
  region: US_EAST_1
  awsConfiguration:
    - id: vpcpe-xyz

独立した CRD の例

次の例では、基本的な例AtlasPrivateEndpoint で定義されているのと同じプライベートエンドポイントを定義する独立した CRD を示しています。このカスタムリソース定義を使用すると、このリソースを定義する Atlas Kubernetes Operator の同じインスタンスで、管理していないプロジェクトにこのプライベートエンドポイントを作成できます。独立した操作を有効にするには、projectRef ではなく externalProjectRef を使用する必要があります。また、このリソースは親プロジェクトからAPI認証情報を継承できないため、connectionSecret を直接指定する必要があります。

apiVersion: atlas.mongodb.com/v1
kind: AtlasPrivateEndpoint
metadata:
 name: my-atlas-pe1
spec:
  externalProjectRef:
    projectID: 66e2f2b621571b7e69a89b66
  connectionSecret:
    name: atlas-connection-secret
  provider: AWS
  region: US_EAST_1
  awsConfiguration:
    - id: vpcpe-xyz

パラメーター

AtlasPrivateEndpoint

AtlasPrivateEndpoint カスタムリソース定義（CRD）は、Atlasプロジェクトに必要なプライベートエンドポイント構成を定義します。パブリックネットワークを介して情報を送信しない、クラウドプロバイダーと Atlas 間のプライベート接続が許可されます。

プライベートエンドポイントを使用して、仮想ネットワークから Atlas クラスターへの一方向接続を作成できます。

`Name`	タイプ	説明	必須
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasPrivateEndpoint`	true
`metadata`	オブジェクト	`metadata`フィールドのフィールドについては、 Kubernetes `API` のドキュメントを参照してください。	true
`spec`	オブジェクト	`AtlasPrivateEndpointSpec` は、プロジェクトのプライベートエンドポイント検証の希望構成の仕様です。 (has(自分:``externalProjectRef``)&+ .has(自分.``projectRef``))\|\| （!has(自分自身.``externalProjectRef``)& は（自分自身.``projectRef``):`externalProjectRef` または `projectRef` を通じてプロジェクト参照を1 つだけ定義する必要があります (has(自分:``externalProjectRef``)&+ has(自己.`` connectionSecret``))\|\|です:は、外部プロジェクトを参照するときにローカル接続シークレットを定義する必要があります	false
`status`	オブジェクト	`AtlasPrivateEndpointStatus` は、`AtlasPrivateEndpoint` クラスターの最新の監視された `status` です。読み取り専用。	false

AtlasPrivateEndpoint.spec

AtlasPrivateEndpointSpec は、プロジェクトのプライベートエンドポイントの希望構成の仕様です

`Name`	タイプ	説明	必須
`provider`	列挙	プライベートエンドポイントサービスを作成するクラウドサービス `provider` の名前。列挙: `AWS`、`GCP`、`AZURE`	true
`region`	string	プライベートエンドポイントサービスを作成する、選択したクラウドプロバイダーのリージョン。	true
`awsConfiguration`	[]オブジェクト	AWSConfiguration は、プライベートエンドポイントの特定の `AWS` 設定です。	false
`azureConfiguration`	[]オブジェクト	`AzureConfiguration` は、プライベートエンドポイントの特定のAzure設定です。	false
`connectionSecret`	オブジェクト	Atlas `API` の秘密キーと公開キーを含むシークレットの名前。	false
`externalProjectRef`	オブジェクト	`externalProjectRef` は親 Atlasプロジェクト`ID` を保持します。"`projectRef`"フィールドと排他関係にあります。	false
`gcpConfiguration`	[]オブジェクト	GCPConfiguration は、プライベートエンドポイントの特定の Google Cloud 設定です。	false
`projectRef`	オブジェクト	`projectRef` は親の `AtlasProject`リソースへの参照です。"`externalProjectRef`"フィールドと排他関係にあります。	false

AtlasPrivateEndpoint.spec.awsConfiguration

AWSPrivateEndpointConfiguration は、カスタマーネットワークで実行されたAWS構成を保持します。

`Name`	タイプ	説明	必須
`id`	string	`ID` これは、このプライベートエンドポイントサービスに誰かが追加されたプライベートエンドポイントのネットワークインターフェイスを識別します。	true

AtlasPrivateEndpoint.spec.azureConfiguration

AzurePrivateEndpointConfiguration は、カスタマーネットワークで実行されたAzure構成を保持します。

`Name`	タイプ	説明	必須
`id`	string	`ID` これは、このプライベートエンドポイントサービスに誰かが追加されたプライベートエンドポイントのネットワークインターフェイスを識別します。	true
`ipAddress`	string	`IP` このプライベートエンドポイントサービスに誰かが追加されたAzure VNet 内のプライベートエンドポイントのアドレス。	true

AtlasPrivateEndpoint.spec. connectionSecret

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

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

AtlasPrivateEndpoint.spec.externalProjectRef

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

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

AtlasPrivateEndpoint.spec.gcpConfiguration

GCP プライベートエンドポイント構成は、カスタマーネットワークで実行されたGCP構成を保持します。

`Name`	タイプ	説明	必須
`endpoints`	[]オブジェクト	エンドポイントとなる接続されたデバイスは、このエンドポイントグループを構成する個々のプライベート `endpoints` のリストです。	true
`groupName`	string	`GroupName` は、エンドポイントとなる接続されたデバイスのセットを識別するラベルです。	true
`projectId`	string	`ProjectID` エンドポイントとなる接続されたデバイスを作成した Google Cloudプロジェクトを識別します。	true

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

GCP プライベートエンドポイントは、カスタマーネットワークで構成されたGCP転送ルールを保持します。

`Name`	タイプ	説明	必須
`ipAddress`	string	`IP` この Google Cloud コンシューマー転送ルールが解決されるアドレス。	true
`name`	string	作成した Google Cloud コンシューマー転送ルールを識別する名前。	true

AtlasPrivateEndpoint.spec.projectRef

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

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

AtlasPrivateEndpoint.status

AtlasPrivateEndpointStatus は、AtlasPrivateEndpoint クラスターの最新の監視ステータスです。読み取り専用。

`Name`	タイプ	説明	必須
`conditions`	[]オブジェクト	条件は、Atlas カスタムリソースの現在の状態を示すステータスのリストです	true
`endpoints`	[]オブジェクト	エンドポイントとなる接続されたデバイスは、サービスに接続された `endpoints` のステータスです	false
`error`	string	エラーは、プライベートエンドポイントの構成中に発生した障害の説明です	false
`observedGeneration`	integer	`ObservedGeneration` は、Atlas 演算子が認識しているリソース仕様の生成を示します。Atlas 演算子は、このフィールドを「メタデータ.generate 」の値に更新します。が、リソースの調整を開始するとすぐに表示されます。形式: int64	false
`resourceId`	string	`ResourceID` は、Atlas Azure Private Link を識別するルート相対パスです	false
`serviceAttachmentNames`	[]string	`ServiceAttachmentNames` は、Atlas がプライベート接続を介して 1 つのサービスにアクセスするために使用できるエンドポイントとなる接続されたデバイスを識別する URL のリストです。	false
`serviceId`	string	`ServiceID` は、Atlas 内のプライベートエンドポイントサービスの一意の識別子です。	false
`serviceName`	string	`ServiceName` は、Atlas によってマネージドされている Amazon Web Services (`AWS`) `PrivateLink` エンドポイントとなる接続されたデバイスまたは Azure Private Link Service の一意の識別子です。	false
`serviceStatus`	string	`ServiceStatus` は、プライベートエンドポイントサービスの状態です	false

AtlasPrivateEndpoint.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

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

EndpointInterfaceStatus は、構成されたサービスにアタッチされたインターフェースの最新の監視ステータスです。読み取り専用。

`Name`	タイプ	説明	必須
`ID`	string	`ID` は、インターフェースを構成するために仕様に設定された外部識別子です	false
`InterfaceStatus`	string	`InterfaceStatus` は、プライベートエンドポイントインターフェースの状態です	false
`connectionName`	string	`ConnectionName` は、Atlas が生成する Azure プライベートエンドポイント接続を識別するラベルです	false
`error`	string	エラーは、プライベートエンドポイントの構成中に発生した障害の説明です	false
`gcpForwardingRules`	[]オブジェクト	GCPForwardingRules は、カスタマー`GCP` プライベートエンドポイント（転送ルール）のステータスです	false

AtlasPrivateEndpoint.status.endpoints.gcpForwardingRules

GCPForwardingRule は、インターフェースに対して構成されたGCP転送ルールの最新の確認ステータスです。読み取り専用。

`Name`	タイプ	説明	必須
`name`	string	作成した Google Cloud コンシューマー転送ルールを識別する、人間に判読可能なラベル。	false
`status`	string	`MongoDB` Atlas エンドポイントとなる接続されたデバイスグループの状態	false

戻る

AtlasOrgSettings

AtlasSearchIndexConfig

重要

重要

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

例

基本的な例

独立した CRD の例

パラメーター

AtlasPrivateEndpoint

AtlasPrivateEndpoint.spec

AtlasPrivateEndpoint.spec.awsConfiguration

AtlasPrivateEndpoint.spec.azureConfiguration

AtlasPrivateEndpoint.spec. connectionSecret

AtlasPrivateEndpoint.spec.externalProjectRef

AtlasPrivateEndpoint.spec.gcpConfiguration

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

AtlasPrivateEndpoint.spec.projectRef

AtlasPrivateEndpoint.status

AtlasPrivateEndpoint.status.条件

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

AtlasPrivateEndpoint.status.endpoints.gcpForwardingRules

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