AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Docs Home
/ /
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース

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 でプライベート エンドポイントを実装する方法の詳細については、プライベート エンドポイントの管理 を参照してください。

例

基本的な例

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

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 の例

The following example shows an AtlasPrivateEndpoint independent CRD that defines the same private endpoint defined in the Basic Example. This custom resource definition allows you to create this private endpoint 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: 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

The AtlasPrivateEndpoint custom resource definition (CRD) defines a desired Private Endpoint configuration for an Atlas project. It allows a private connection between your cloud provider and Atlas that doesn't send information through a public network.

プライベートエンドポイント を使用して、仮想ネットワークから 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

portMappingEnabled

ブール値

PortMappingEnabled このエンドポイントとなる接続されたデバイス サービスが PSC ポートマッピングを使用するかどうかを示します。GCP のみ。

false

projectRef

オブジェクト

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

false

supportedRegions

[]string

SupportedRegions AWS Private Link トラフィックがこのエンドポイントに転送されるリージョンのリストです。AWS のみ。

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

portMappingEnabled

ブール値

PortMappingEnabled GCP エンドポイントとなる接続されたデバイス サービスが PSC ポートマッピングを使用するかどうかを示します。GCPのみ。

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

supportedRegions

[]string

SupportedRegions AWS Private Link トラフィックが転送されるリージョンのリストです。AWS のみ。

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

次へ
はじめる
このページを評価

項目一覧