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

Atlas Administration APIに接続するために、Atlas Kubernetes Operator は Atlas Kubernetes Operator シークレットから組織IDと認証情報を読み取ります。 APIキーまたはサービスアカウントを使用して認証できます。次の機能を設定することもできます。

To learn more about creating an Atlas account, see Register and Log in to 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 管理API に接続します。 `global` Atlas Kubernetes Operator シークレットを使用すると、1 つの認証情報を使用して組織内のすべてのプロジェクトを利用できます。新しい `AtlasProject` カスタムリソースでは、同じ認証情報を使用してオーバーヘッドを削減します。 Atlas Kubernetes Operator 配置のデフォルト名は `mongodb-atlas-operator` です。したがって、シークレットの名前は `mongodb-atlas-operator-api-key` にする必要があります。
プロジェクト	カスタムリソース内のspec. connectionSecretRef.nameで参照される Atlas Kubernetes`AtlasProject` Operator シークレット。デフォルトでは、Atlas Kubernetes Operator はカスタム `AtlasProject`リソースと同じ名前空間に接続シークレットを保持します。シークレットを別の名前空間に保存するには、spec. connectionSecretRef を指定します。名前空間パラメータ。	Atlas Kubernetes Operator はこのシークレットデータを使用して、プロジェクトを参照する任意の`AtlasDeployment` カスタムリソースと `AtlasDatabaseUser` カスタムリソースの Atlas APIに接続します。 spec.connectionSecretRef.name を指定しない場合、Atlas Kubernetes Operator は `global` Atlas Kubernetes Operator シークレットを使用します。プロジェクトごとの Atlas Kubernetes Operator シークレットにより、より細かいアクセスが可能になります。1 つの Atlas プロジェクトへのアクセスを持つために、1 つの認証情報が必要になる場合があります。

パラメーター

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

Parameter	説明
`orgId`	組織を識別するために使用される一意の 24桁の 16 進数。stringAtlas
`publicAPIKey`	Public part of the API key.
`privateAPIKey`	Private part of the API key.

Parameter	説明
`orgId`	組織を識別するために使用される一意の 24桁の 16 進数。stringAtlas
`clientId`	サービスアカウントのクライアント ID。
`clientSecret`	サービスアカウントのクライアントシークレット。作成後はこの値を取得できません。

サービスアカウントの詳細については、「サービスアカウントを使用した Atlas へのアクセスの構成」を参照してください。

前提条件

次のいずれかの認証方法を選択します。

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 my-project-connection atlas.mongodb.com/type=credentials -n <atlas_project_namespace>

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

注意

kubectl create secret generic mongodb-atlas-operator-service-account \
   --from-literal="orgId=<the_atlas_organization_id>" \
   --from-literal="clientId=<the_service_account_client_id>" \
   --from-literal="clientSecret=<the_service_account_client_secret>" \
   -n <operator_namespace>
kubectl label secret mongodb-atlas-operator-service-account 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="clientId=<the_service_account_client_id>" \
   --from-literal="clientSecret=<the_service_account_client_secret>" \
   -n <atlas_project_namespace>
kubectl label secret my-project-connection atlas.mongodb.com/type=credentials -n <atlas_project_namespace>

Atlas Kubernetes Operator でサービスアカウントを構成する方法の詳細については、「Service Accounts を使用した Atlas へのアクセスの構成」を参照してください。

戻る

メトリクス

シークレットストレージ