Atlas へのアクセスを設定する

Atlas APIに接続するために、Atlas Kubernetes Operator は Atlas Kubernetes Operator シークレットから組織IDと APIキーを読み取ります。次の機能を設定することもできます。

Atlas アカウントの作成の詳細については、「新しい Atlas アカウントの登録」を参照してください。

Atlas Kubernetes Operator Secrets

構成に応じて、Atlas Kubernetes Operator は、次の Atlas Kubernetes Operator シークレットのいずれかから読み取りを行います。

スコープ	ロケーション	説明
グローバル	Atlas Kubernetes `<operator-deployment-name>-api-key`Operator をインストールしたのと同じ名前空間に作成された Atlas Kubernetes Operator シークレット。	Atlas Kubernetes Operator は、 `AtlasProject`カスタムリソースで`spec.connectionSecretRef.name`が指定されていない限り、このシークレットデータを使用して Atlas Administration API に接続します。 `global` Atlas Kubernetes Operator シークレットを使用すると、組織内のすべてのプロジェクトに対して 1 つの APIキーを使用できます。新しい `AtlasProject` カスタムリソースは、オーバーヘッドを削減するために同じ API キーを使用します。 Atlas Kubernetes Operator 配置のデフォルト名は `mongodb-atlas-operator` です。したがって、シークレットの名前は `mongodb-atlas-operator-api-key` にする必要があります。
プロジェクト	Atlas Kubernetes Operator `spec.connectionSecretRef.name`シークレットは、`AtlasProject` カスタムリソース内ので参照されます。デフォルトでは、Atlas Kubernetes Operator はカスタムリソース `AtlasProject`と同じ名前空間に接続シークレットを保持します。シークレットを別の名前空間に保存するには、 `spec.connectionSecretRef.namespace`パラメータを指定します。	Atlas Kubernetes Operator はこのシークレットデータを使用して、プロジェクトを参照する任意の`AtlasDeployment` カスタムリソースと `AtlasDatabaseUser` カスタムリソースの Atlas APIに接続します。 `spec.connectionSecretRef.name`を指定しない場合、Atlas Kubernetes Operator は`global` Atlas Kubernetes Operator シークレットを使用します。プロジェクトごとの Atlas Kubernetes Operator シークレットにより、より細かいアクセスが可能になります。単一の Atlasプロジェクトにアクセスするには、単一のAPIキーが必要な場合があります。

パラメーター

global と project のいずれのシークレットにも次の情報が必要です。

Parameter	説明
`orgId`	組織を識別するために使用される一意の 24桁の 16 進数。stringAtlas
`publicAPIKey`	API キーの公開部分。
`privateAPIKey`	API キーのプライベート部分。

前提条件

Atlas Kubernetes Operator から Atlas へのアクセスを構成するには、次の公開 API キー、プライベート API キー、および組織 ID 情報が必要です。

Atlas Kubernetes Operator で新しい Atlasプロジェクトを作成する場合は、組織へのプログラムによるアクセスの付与。組織で Atlas Administration APIのIP アクセスリストが必要な場合は、 APIアクセスリストも設定する必要があります。
重要
API キーには、 Organization Project Creator以上の組織ロールを割り当てる必要があります。
既存の Atlasプロジェクトを操作する場合は、プロジェクトからプロジェクトアクセスを追加します。組織で Atlas Administration APIのIP アクセスリストが必要な場合は、 APIアクセスリストも設定する必要があります。
重要
Project Ownerプロジェクトロールに API キーを割り当てる必要があります。

手順

Atlas への Atlas Kubernetes Operator アクセスを構成するには、次のいずれかの手順を実行します。

global Atlas Kubernetes Operator シークレットについては、次のコマンドを実行します。

注意

global Atlas Kubernetes Operator シークレットの名前は、事前定義された形式に準拠している必要があります。Atlas Kubernetes Operator 配置のデフォルト名は mongodb-atlas-operator です。したがって、シークレットの名前は mongodb-atlas-operator-api-key にする必要があります。

kubectl create secret generic mongodb-atlas-operator-api-key \
   --from-literal="orgId=<the_atlas_organization_id>" \
   --from-literal="publicApiKey=<the_atlas_api_public_key>" \
   --from-literal="privateApiKey=<the_atlas_api_private_key>" \
   -n <operator_namespace>
kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system

project Atlas Kubernetes Operator シークレットについては、次のコマンドを実行します。

kubectl create secret generic my-project-connection \
   --from-literal="orgId=<the_atlas_organization_id>" \
   --from-literal="publicApiKey=<the_atlas_api_public_key>" \
   --from-literal="privateApiKey=<the_atlas_api_private_key>" \
   -n <atlas_project_namespace>
kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system

戻る

メトリクス

シークレットストレージ

Atlas Kubernetes Operator Secrets

パラメーター

前提条件

重要

重要

手順

注意