注意
Atlas Kubernetes Operator は、Atlas for Government のAtlasDataFederationカスタム リソースをサポートしていません。
AtlasDataFederation カスタムリソースは、Atlas のフェデレーティッドデータベースインスタンスを構成します。AtlasDataFederation カスタムリソースを作成すると、Atlas Kubernetes Operator は Atlas 内のフェデレーティッドデータベースインスタンスを作成または更新しようとします。フェデレーティッドデータベースインスタンスを使用してフェデレーティッドクエリを実行できます。
重要
カスタム リソースはデフォルトでオブジェクトを削除しなくなりました
Atlas Kubernetes Operator はカスタムリソース構成ファイルを使用して Atlas 構成を管理しますが、Atlas Kubernetes Operator2.0 以降、 Kubernetesで削除したカスタム リソースは Atlas で削除されなくなりました(デフォルトでは )。代わりに、Atlas Kubernetes Operator は Atlas 内のそれらのリソースの管理を停止します。 例、 Kubernetesで カスタム リソースを削除すると、デフォルトでは、Atlas Kubernetes Operator は Atlas
AtlasProjectから対応するプロジェクトを自動的に削除しなくなります。この動作の変更は、誤ってまたは予期せずに削除されるのを防ぐことを目的としています。 この動作を 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 uses the Atlas Clusters API Resource and Advanced Clusters API Resource to create a new federated database instance or update an existing federated database instance. If you specify values for fields under spec.serverlessSpec, Atlas Kubernetes Operator uses the Atlas Serverless Instance API Resource to create or configure private endpoints for your federated database instance.
Kubernetes クラスターからAtlasDataFederationリソースを削除すると、Atlas Kubernetes Operator は Atlas からフェデレーティッドデータベースインスタンスを削除します。
例
次の例では、プライベートエンドポイントが構成されたAtlasDataFederationカスタム リソース仕様を示しています。
apiVersion: atlas.mongodb.com/v1 kind: AtlasDataFederation metadata: name: my-federated-deployment spec: projectRef: name: my-project namespace: default cloudProviderConfig: aws: roleId: 12345678 testS3Bucket: my-bucket dataProcessRegion: cloudProvider: AWS region: OREGON_USA name: my-fdi storage: databases: - collections: - dataSources: - allowInsecure: false collection: my-collection collectionRegex: database: my-database databaseRegex: defaultFormat: ".avro" path: / provenanceFieldName: string storeName: my-data-store urls: - string: name: my-collection-mdb maxWildcardCollections: 100 name: my-database-mdb views: - name: my-view pipeline: source: my-source-collection stores: - name: my-store provider: S3 additionalStorageClasses: - STANDARD bucket: my-bucket delimiter: / includeTags: false prefix: data- public: false region: US_WEST_1 privateEndpoints: - endpointId: vpce-3bf78b0ddee411ba1 provider: AWS type: DATA_LAKE - endpointId: vpce-3bf78b0ddee411ba2 provider: AWS type: DATA_LAKE
パラメーター
AtlasDataFederation
AtlasDataFederation は、 Atlas Data Federation APIのスキーマです。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | atlas.mongodb.com/v1 | true |
| string |
| true |
| オブジェクト |
| true |
| オブジェクト |
| false |
| オブジェクト |
| false |
AtlasDataFederation.spec
DataFederationSpec は、AtlasDataFederation のターゲット状態を定義します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。 | true |
| オブジェクト | プロジェクトは、配置が属する | true |
| オブジェクト | このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダーの構成。 | false |
| オブジェクト | フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。 | false |
| []オブジェクト | 指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。 | false |
| オブジェクト | 各データ保存の構成情報と | false |
AtlasDataFederation.spec.projectRef
プロジェクトは、配置が属する Atlas Projectリソースへの参照です。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | Kubernetesリソースの名前 | true |
| string | Kubernetesリソースの名前空間 | false |
AtlasDataFederation.spec.cloudProviderConfig
このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダーの構成。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト |
| false |
| オブジェクト | Azureで Data Federation を実行中ための構成。 | false |
| オブジェクト |
| false |
AtlasDataFederation.spec.cloudProviderConfig.aws
AWSで Data Federation を実行中ための構成。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | データレイクが保存にアクセスするために使用できるロールの一意の識別子。 | false |
| string | 提供されたロール | false |
AtlasDataFederation.spec.cloudProviderConfig.azure
Configuration for running Data Federation in Azure.
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | Data Federation がデータストアにアクセスするために使用できるロールの一意の識別子。 | true |
AtlasDataFederation.spec.cloudProviderConfig.gcp
GCPで Data Federation を実行中ための構成。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | Data Federation がデータストアにアクセスするために使用できるロールの一意の識別子。 | true |
AtlasDataFederation.spec.dataProcessRegion
フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | フェデレーティッドデータベースインスタンスのインフラストラクチャをホストするクラウドサービスの名前。使用可能な値のリストは次で参照してください: https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 / 操作/operation-creategroupdatafederation#operation-creategroupdatafederation- body-application-vnd -atlas-2023 -01 -01 -json-dataprocessregion-cloudprovider | false |
| string |
| false |
AtlasDataFederation.spec.privateEndpoints
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | プライベート エンドポイントを識別するユニークな 22 文字の英数字文字列。 | false |
| string | クラウド サービス プロバイダーを識別する、人間が判読可能なラベル。Atlas Data Lake は Amazon Web Services のみをサポートしています。 | false |
| string | このプライベートエンドポイントに関連付けられているリソース | false |
AtlasDataFederation.specストレージ
各データの保存の構成情報とMongoDB Atlasデータベースへのマッピング。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []オブジェクト | このデータレイクのクエリ可能な | false |
| []オブジェクト | データレイクのデータ | false |
AtlasDataFederation.specストレージ.データベース
この Data Lake に関連付けられているデータベース。データベースにはコレクションとビューが含まれています。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []オブジェクト | 保存データストアにマッピングする | false |
| integer | データベース内のワイルドカード コレクションの最大数。これは | false |
| string | Data Lake がデータをマッピングするデータベースを識別する、人間が判読可能なラベル。 | false |
| []オブジェクト | コレクションに適用される集計パイプラインの配列。これは | false |
AtlasDataFederation.specストレージ.データベース.コレクション
コレクションは、保存データストアにマップされます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []オブジェクト | この Data Lake のコレクションにマップされるデータ ストアを含む配列。 | false |
| string |
| false |
AtlasDataFederation.specストレージ.データベース.コレクション.dataSources
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| ブール値 | 指定された URL のスキームを検証するフラグ。true の場合、安全でない | false |
| string | データベース内の | false |
| string | ワイルドカード(*)コレクションの作成に使用する正規表現パターン。 | false |
| string | クラスター内のコレクションを含むデータベースを識別する、人間が判読できるラベル。動的に生成されたデータベースのワイルドカード(*)コレクションを生成するには、このパラメーターを省略する必要があります。 | false |
| string | ワイルドカード(*)データベースの作成に使用する正規表現パターン。 | false |
| 列挙 |
| false |
| string | ファイル | false |
| string | 結果にドキュメントの出所が含まれるフィールドの名前。 | false |
| string |
| false |
| []string | 一般にアクセス可能なデータファイルの URL 。認証を必要とする URL は指定できません。Atlas Data Lake は各 | false |
AtlasDataFederation.specストレージ.データベース.ビュー
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | コレクションの 集計パイプライン に対応するビューを識別する、人間が判読可能なラベル。 | false |
| string | ソースコレクションに適用する集計 | false |
| string | ビューの | false |
AtlasDataFederation.specストレージ.保存
保存 (する)は、データを保存する場所を定義する設定のグループです。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []string |
| false |
| string |
| false |
| string | データストアとして使用される Atlas クラスターの人間が判読できるラベル (プロバイダー: Atlas)。 | false |
| string | データ保存内のパス セグメントを区切る | false |
| ブール値 | 指定されたパス内のファイルの | false |
| string | データ保存を識別する、人間が判読できるラベル。 | false |
| string |
| false |
| string | データ保存に使用される | false |
| ブール値 | バケットがパブリックかどうかを示すフラグ。true に設定されている場合、 | false |
| オブジェクト | Atlas クラスター データストアの読み取り保証 (read concern) (プロバイダー: Atlas)。 | false |
| オブジェクト | Atlas クラスター データストアの読み込み設定 (プロバイダー: Atlas)。 | false |
| string |
| false |
AtlasDataFederation.spec.ストレージ.保存.readConcern
Atlas クラスター データストアの読み取り保証 (read concern) (プロバイダー: Atlas)。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | false |
AtlasDataFederation.spec.ストレージ.stores.readPreference
Atlas クラスター データストアの読み込み設定 (プロバイダー: Atlas)。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| integer | セカンダリからの読み取りにおけるレプリケーションラグの最大値(秒)。 | false |
| string | 読み込み設定(read preference)モード。 | false |
| [][]オブジェクト | 読み取りリクエストを特定のレプリカセットのノードにルーティングするためのタグセットのリスト。 | false |
AtlasDataFederation.spec.storage.stores.readPreference.tagSets
ReadPreferenceTag は、読み取りリクエストのルーティングに使用されるキーと値のペアです。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | false | |
| string | false |
AtlasDataFederation.status
DataFederationStatus は、AtlasDataFederation の監視された状態を定義します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| []オブジェクト | 条件は、Atlas カスタム リソースの現在の状態を示すステータスのリストです | true |
| オブジェクト |
| false |
| string |
| false |
| integer |
| false |
AtlasDataFederation.status.条件
条件 は、 特定の点における Atlas カスタム リソースの状態を表します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | 条件のステータス。 True、False、Unknown のいずれか 1 つ。 | true |
| string | Atlas カスタム リソース条件のタイプ。 | true |
| string | 条件があるステータスから別のステータスに最後に移行した時刻。 | false |
| string | 移行に関する詳細を提供する | false |
| string | 条件の最後の移行の | false |
AtlasDataFederation.status.cloudProviderConfig
CloudProviderConfig には、Atlas から割り当てられたクラウドプロバイダー構成の読み取り専用フィールドが含まれます。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| オブジェクト |
| false |
| オブジェクト | Azure は、Azure クラウドプロバイダー構成の Atlas に割り当てられた読み取り専用フィールドを保持します。 | false |
| オブジェクト |
| false |
AtlasDataFederation.status.cloudProviderConfig.aws
AWS は、AWS クラウドプロバイダーの設定に対して Atlas が割り当てた読み取り専用フィールドを保持します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string |
| false |
| string | IAMAssumedRoleARN は、Atlas がデータストアにアクセスする際に引き受ける | false |
| string | IAMUserARN は、Atlas がデータストアにアクセスするときに使用する | false |
AtlasDataFederation.status.cloudProviderConfig.azure
Azure は、Azure クラウドプロバイダー構成の Atlas に割り当てられた読み取り専用フィールドを保持します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string |
| false |
| string |
| false |
| string |
| false |
AtlasDataFederation.status.cloudProviderConfig.gcp
GCP は、GCP クラウドプロバイダー構成の Atlas に割り当てられた読み取り専用フィールドを保持します。
Name | タイプ | 説明 | 必須 |
|---|---|---|---|
| string | GCPServiceAccount は、Atlas によって作成された | false |