MongoDB.local SF, Jan 15: See the speaker lineup & ship your AI vision faster. Use WEB50 to save 50%
Find out more >
Docs Menu
Docs Home
/ /
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース
Docs Home
/
管理
/
Atlas Kubernetes 演算子
/
カスタム リソース

AtlasDataFederation カスタム リソース

注意

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 は AtlasAtlasProject から対応するプロジェクトを自動的に削除しなくなります。この動作の変更は、誤ってまたは予期せずに削除されるのを防ぐことを目的としています。 この動作を Atlas Kubernetes Operator.2 0より前に使用されていたデフォルトに戻す方法などの詳細については、「新しいデフォルト: Atlas Kubernetes演算子.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 リソースと高度なクラスター API リソースを使用して、新しいフェデレーティッドデータベースインスタンスを作成したり、既存のフェデレーティッドデータベースインスタンスを更新したりします。 spec.serverlessSpecの下のフィールドに値を指定すると、Atlas Kubernetes Operator は Atlas Serverless Instance API リソースを使用して、フェデレーティッドデータベースインスタンスのプライベートエンドポイントを作成または構成します。

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
タイプ
説明
必須

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasDataFederation

true

metadata

オブジェクト

metadataフィールドのフィールドについては、 Kubernetes API のドキュメントを参照してください。

true

spec

オブジェクト

DataFederationSpec は、AtlasDataFederation のターゲット状態を定義します。

false

status

オブジェクト

DataFederationStatus は、AtlasDataFederation の監視された状態を定義します。

false

AtlasDataFederation.spec

DataFederationSpec は、AtlasDataFederation のターゲット状態を定義します。

Name
タイプ
説明
必須

name

string

フェデレーティッドデータベースインスタンスを識別する、人間が判読可能なラベル。

true

projectRef

オブジェクト

プロジェクトは、配置が属する AtlasProjectリソースへの参照です。

true

cloudProviderConfig

オブジェクト

このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダーの構成。

false

dataProcessRegion

オブジェクト

フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

false

privateEndpoints

[]オブジェクト

指定されたプロジェクトに追加するフェデレーティッドデータベースインスタンスとオンラインアーカイブのプライベートエンドポイント。

false

storage

オブジェクト

各データ保存の構成情報と MongoDB Atlas データベースへのマッピング。

false

AtlasDataFederation.spec.projectRef

プロジェクトは、配置が属する Atlas Projectリソースへの参照です。

Name
タイプ
説明
必須

name

string

Kubernetesリソースの名前

true

namespace

string

Kubernetesリソースの名前空間

false

AtlasDataFederation.spec.cloudProviderConfig

このフェデレーティッドデータベースインスタンスがホストされているクラウドプロバイダーの構成。

Name
タイプ
説明
必須

aws

オブジェクト

AWS で Data Federation を実行中ための構成。

false

AtlasDataFederation.spec.cloudProviderConfig.aws

AWSで Data Federation を実行中ための構成。

Name
タイプ
説明
必須

roleId

string

データレイクが保存にアクセスするために使用できるロールの一意の識別子。cloudProviderConfig を指定する場合は必須です。

false

testS3Bucket

string

提供されたロール ID がアクセスを許可されている S3 データバケットの名前。cloudProviderConfig を指定する場合は必須です。

false

AtlasDataFederation.spec.dataProcessRegion

フェデレーティッドデータベースインスタンスがクライアント接続をルーティングするクラウドプロバイダーのリージョンに関する情報。

Name
タイプ
説明
必須

cloudProvider

列挙

フェデレーティッドデータベースインスタンスのインフラストラクチャをホストするクラウドサービスの名前。列挙: AWS

false

region

列挙

データレイクがクライアント接続をルーティングするregionの名前。列挙: SYDNEY_AUS、MUMBAI_IND、FRANKFURT_DEU、DUBLIN_IRL、LONDON_GBR、VIRGINIA_USA、OREGON_USA、SAOPAULO_BRA、SINGAPORE_SGP

false

AtlasDataFederation.spec.privateEndpoints

Name
タイプ
説明
必須

endpointId

string

プライベート エンドポイントを識別するユニークな 22 文字の英数字文字列。

false

provider

string

クラウド サービス プロバイダーを識別する、人間が判読可能なラベル。Atlas Data Lake は Amazon Web Services のみをサポートしています。

false

type

string

このプライベートエンドポイントに関連付けられているリソースtype を識別する、人間が判読できるラベル。

false

AtlasDataFederation.specストレージ

各データの保存の構成情報とMongoDB Atlasデータベースへのマッピング。

Name
タイプ
説明
必須

databases

[]オブジェクト

このデータレイクのクエリ可能な databases と コレクションを含む配列。

false

stores

[]オブジェクト

データレイクのデータ stores を含む配列。

false

AtlasDataFederation.specストレージ.データベース

この Data Lake に関連付けられているデータベース。データベースにはコレクションとビューが含まれています。

Name
タイプ
説明
必須

collections

[]オブジェクト

保存データストアにマッピングする collections とデータソースの配列。

false

maxWildcardCollections

integer

データベース内のワイルドカード コレクションの最大数。これは S3 データソースにのみ適用されます。最小値は 1、最大値は 1000 です。デフォルト値は 100 です。

false

name

string

Data Lake がデータをマッピングするデータベースを識別する、人間が判読可能なラベル。

false

views

[]オブジェクト

コレクションに適用される集計パイプラインの配列。これは S3 データソースにのみ適用されます。

false

AtlasDataFederation.specストレージ.データベース.コレクション

コレクションは、保存データストアにマップされます。

Name
タイプ
説明
必須

dataSources

[]オブジェクト

この Data Lake のコレクションにマップされるデータ ストアを含む配列。

false

name

string

MongoDB Atlas がデータストア内のデータをマッピングするコレクションを識別する、人間が判読できるラベル。

false

AtlasDataFederation.specストレージ.データベース.コレクション.dataSources

Name
タイプ
説明
必須

allowInsecure

ブール値

指定された URL のスキームを検証するフラグ。true の場合、安全でない HTTP スキームが許可され、サーバーの証明書チェーンとホスト名は検証されず、サーバーによって提示されたホスト名を持つ任意の証明書が受け入れられます。false の場合、安全な HTTPS スキームのみを許可します。

false

collection

string

データベース内の collection を識別する、人間が判読できるラベル。ワイルドカード（*）コレクションを作成する場合は、このパラメーターを省略する必要があります。

false

collectionRegex

string

ワイルドカード（*）コレクションの作成に使用する正規表現パターン。

false

database

string

クラスター内のコレクションを含むデータベースを識別する、人間が判読できるラベル。動的に生成されたデータベースのワイルドカード（*）コレクションを生成するには、このパラメーターを省略する必要があります。

false

databaseRegex

string

ワイルドカード（*）データベースの作成に使用する正規表現パターン。

false

defaultFormat

列挙

storeName を検索中にファイル拡張子のないファイルを検出した場合に MongoDB クラウドが使用するファイル形式。列挙: .avro、.avro.bz2、.avro.gz、.bson、.bson.bz2、.bson.gz、.bsonx、.csv、.csv.bz2、.csv.gz、.json、.json.bz2、.json.gz、.orc、.parquet、.tsv、.tsv.bz2、.tsv.gz

false

path

string

ファイル path は、MongoDB クラウドが storeName 内のファイルをコレクションにマッピングする前に、それらのファイルを検索して解析する方法を制御します。プレフィックス パスからすべてのファイルとフォルダーを取得するには、 / を指定します。

false

provenanceFieldName

string

結果にドキュメントの出所が含まれるフィールドの名前。MongoDBAtlas では、サポートされているプロバイダーごとに異なるフィールドが結果に返されます。

false

storeName

string

MongoDB クラウドがコレクションにマッピングするデータストアを識別する、人間が判読できるラベル。

false

urls

[]string

一般にアクセス可能なデータファイルの URL 。認証を必要とする URL は指定できません。Atlas Data Lake は各 URL のパーティションを作成します。空または省略した場合、データレイクは storeName パラメータで指定された保存の URL を使用します。

false

AtlasDataFederation.specストレージ.データベース.ビュー

Name
タイプ
説明
必須

name

string

コレクションの 集計パイプライン に対応するビューを識別する、人間が判読可能なラベル。

false

pipeline

string

ソースコレクションに適用する集計 pipeline ステージ。

false

source

string

ビューの sourceコレクションを識別する、人間が判読できるラベル。

false

AtlasDataFederation.specストレージ.保存

保存 (する)は、データを保存する場所を定義する設定のグループです。

Name
タイプ
説明
必須

additionalStorageClasses

[]string

AWS S3ストレージクラスのコレクション。Atlas Data Lake では、これらのストレージクラスのファイルがクエリ結果に含まれます。

false

bucket

string

AWS S3バケットを識別する、人間が判読できるラベル。このラベルは、構成された AWS ID とアクセスマネジメント（IAM）認証情報を使用してデータレイクがアクセスできる S3 bucket の名前と完全に一致する必要があります。

false

delimiter

string

データ保存内のパス セグメントを区切る delimiter 。MongoDB Atlas は delimiter を使用して、階層的なディレクトリ構造の S3 バケットを効率的に走査します。S3オブジェクトキーでサポートされている任意の文字を区切り文字として指定できます。

false

includeTags

ブール値

指定されたパス内のファイルの S3 タグを追加のパーティション属性として使用するかどうかを示すフラグ。true に設定すると、データレイクは S3 タグを追加のパーティション属性として追加し、各タグを各ドキュメントに関連付けるための新しい最上位の BSON 要素を追加します。

false

name

string

データ保存を識別する、人間が判読できるラベル。storeNameフィールドは、マッピング構成の一部としてこの値を参照します。MongoDB Atlas をデータストアとして使用するには、データレイクにサーバーレスインスタンスまたは M10 以上のクラスターが必要です。

false

prefix

string

S3バケット内のファイルを検索するときに MongoDB クラウドが適用するプレフィックス。保存は、取り込むファイルの完全パスを作成するために、prefix の値をパスの先頭に追加します。省略した場合、MongoDB クラウドはS3バケットのルートからすべてのファイルを検索します。

false

provider

string

データ保存に使用される provider 。

false

public

ブール値

バケットがパブリックかどうかを示すフラグ。true に設定されている場合、MongoDB クラウドは S3バケットにアクセスするために、設定された AWS ID とアクセス管理（IAM）ロールを使用しません。false に設定されている場合、設定された AWS IAM ロールには S3バケットにアクセスするための権限が含まれている必要があります。

false

region

string

MongoDB クラウドが AWS ホストする MongoDB クラスター ノードを配置する物理的なロケーション。選択した region は、データベースにアクセスするクライアントのネットワークレイテンシに影響する可能性があります。MongoDB Atlas が専有クラスターを配置するときに、そのプロバイダーとリージョンに VPC または VPC 接続が存在するかどうかを確認します。変換できない場合、MongoDB Atlas は配置の一部としてそれらを作成します。新しい VPC ピアリング接続を 1 つの CIDR ブロックとリージョンに制限するには、最初に接続を作成します。接続が開始された後にクラスターを配置します。

false

AtlasDataFederation.status

DataFederationStatus は、AtlasDataFederation の監視された状態を定義します。

Name
タイプ
説明
必須

conditions

[]オブジェクト

条件は、Atlas カスタム リソースの現在の状態を示すステータスのリストです

true

mongoDBVersion

string

MongoDBVersion は、クラスターが実行する MongoDB のバージョンです（ ）。形式。

false

observedGeneration

integer

ObservedGeneration は、Atlas 演算子が認識しているリソース仕様の生成を示します。Atlas 演算子は、このフィールドを「メタデータ.generate 」の値に更新します。が、リソースの調整を開始するとすぐに 表示されます。形式: int64

false

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

戻る

AtlasTeam

次へ

AtlasFederatedAuth

項目一覧