Databricks Asset Bundles のリソース

Databricks Asset Bundles を使用すると、バンドル構成の resources マッピングで、バンドルで使用される Databricks リソースに関する情報を指定できます。リソース・マッピングとリソース・キー・リファレンスを参照してください。

この記事では、バンドルでサポートされているリソースの種類の概要を説明し、サポートされている各種類の詳細と例を示します。その他の例については、バンドル設定の例を参照してください。

ヒント

既存のリソースの YAML を生成するには、 databricks bundle generate コマンドを使用します。バンドル設定ファイルの生成を参照してください。

サポートされているリソース

次の表に、バンドルでサポートされているリソースの種類を示します。一部のリソースは、バンドルで定義してバンドルをデプロイすることで作成できますが、一部のリソースは、バンドルに含める既存のリソースの参照のみをサポートします。

リソースは、対応する Databricks REST API オブジェクトの作成操作要求ペイロードを使用して定義され、オブジェクトのサポートされるフィールド (YAML として表される) は、リソースのサポートされているプロパティです。各リソースの対応するペイロードのドキュメントへのリンクを表に示します。

ヒント

databricks bundle validate コマンドは、バンドル構成ファイルに不明なリソース・プロパティーが見つかった場合に警告を戻します。

リソース	サポートを作成する	対応する REST API オブジェクト
アプリ	✓	App オブジェクト
クラスター	✓	クラスターオブジェクト
ダッシュボード		ダッシュボードオブジェクト
experiment	✓	エクスペリメントオブジェクト
ジョブ	✓	ジョブオブジェクト
モデル(レガシー)	✓	モデル(レガシー)オブジェクト
model_serving_endpoint	✓	モデルサービング endpoint object
パイプライン	✓	パイプラインオブジェクト
quality_monitor	✓	品質モニターオブジェクト
registered_model (Unity Catalog)	✓	登録済みのモデルオブジェクト
スキーマ (Unity Catalog)	✓	スキーマオブジェクト
ボリューム (Unity Catalog)	✓	ボリュームオブジェクト

アプリ

アプリリソースは、 Databricks アプリを定義します。 Databricks Appsに関する情報については、「Databricks Appsとは」を参照してください。

ヒント

Streamlit Databricks アプリでバンドルを初期化するには、次のコマンドを使用します。

databricks bundle init https://github.com/databricks/bundle-examples --template-dir contrib/templates/streamlit-app

アプリを追加するには、アプリを定義するオブジェクトフィールドと、次の項目を指定します。

source_code_path - Databricks アプリのソースコードの ./app ローカルパス。このフィールドは必須です。
config - アプリの設定コマンドと環境変数。これを使用して、さまざまなアプリのデプロイターゲットを指定できます。

例

次の例では、バンドルによって作成されたジョブを管理する my_app という名前のアプリを作成します。

YAML
resources:
  jobs:
    # Define a job in the bundle
    hello_world:
      name: hello_world
      tasks:
        - task_key: task
          spark_python_task:
            python_file: ../src/main.py
          environment_key: default

      environments:
        - environment_key: default
          spec:
            client: '1'

  # Define an app that manages the job in the bundle
  apps:
    job_manager:
      name: 'job_manager_app'
      description: 'An app which manages a job created by this bundle'

      # The location of the source code for the app
      source_code_path: ../src/app

      # The configuration for running the app
      config:
        command:
          - flask
          - --app
          - app
          - run
          - --debug
        env:
          - name: JOB_ID
            value: ${resources.jobs.hello_world.id}

      # The resources in the bundle which this app has access to. This binds the resource in the app with the DABs resource.
      resources:
        - name: 'app-job'
          job:
            id: ${resources.jobs.hello_world.id}
            permission: 'CAN_MANAGE_RUN'

Databricks アプリの例の完全なバンドルについては、 bundle-examples GitHub リポジトリを参照してください。

クラスター

クラスターリソースは、 All-Purposeクラスターを定義します。

例

次の例では、 my_cluster という名前のクラスターを作成し、それを my_jobでノートブックを実行するために使用するクラスターとして設定します。

YAML
bundle:
  name: clusters

resources:
  clusters:
    my_cluster:
      num_workers: 2
      node_type_id: 'i3.xlarge'
      autoscale:
        min_workers: 2
        max_workers: 7
      spark_version: '13.3.x-scala2.12'
      spark_conf:
        'spark.executor.memory': '2g'

  jobs:
    my_job:
      tasks:
        - task_key: test_task
          notebook_task:
            notebook_path: './src/my_notebook.py'

ダッシュボード

ダッシュボードリソースを使用すると、 AI/BI ダッシュボードをバンドルで管理できます。 AI/BIダッシュボードに関する情報については、「ダッシュボード」を参照してください。

例

次の例では、サンプルの NYC タクシー乗車分析 ダッシュボードを含め、Databricks ワークスペースにデプロイします。

YAML
resources:
  dashboards:
    nyc_taxi_trip_analysis:
      display_name: 'NYC Taxi Trip Analysis'
      file_path: ../src/nyc_taxi_trip_analysis.lvdash.json
      warehouse_id: ${var.warehouse_id}

UI を使用してダッシュボードを変更する場合、UI を使用して明示的に更新しない限り、UI を介して行った変更は、ローカルバンドル内のダッシュボード JSON ファイルに適用されません bundle generate。 --watchオプションを使用すると、ダッシュボードに対する変更を継続的にポーリングして取得できます。バンドル設定ファイルの生成を参照してください。

さらに、リモートワークスペース内のものとは異なるダッシュボード JSON ファイルを含むバンドルをデプロイしようとすると、エラーが発生します。デプロイを強制し、リモートワークスペースのダッシュボードをローカルダッシュボードで上書きするには、 --force オプションを使用します。バンドルのデプロイを参照してください。

エクスペリメント

エクスペリメントリソースを使用すると、バンドル内のエクスペリメントMLflowを定義できます。MLflow エクスペリメントに関する情報については、「MLflow エクスペリメントを使用してトレーニング実行を整理する」を参照してください。

例

次の例では、すべてのユーザーが表示できるエクスペリメントを定義しています。

YAML
resources:
  experiments:
    experiment:
      name: my_ml_experiment
      permissions:
        - level: CAN_READ
          group_name: users
      description: MLflow experiment used to track runs

ジョブ

ジョブリソースを使用すると、バンドル内でジョブとそれに対応するタスクを定義できます。ジョブに関する情報については、Databricksでのオーケストレーションの概要を参照してください。Databricks Asset Bundles テンプレートを使用してジョブを作成するチュートリアルについては、「 Databricks Asset Bundles を使用して Databricks でジョブを開発する」を参照してください。

例

次の例では、リソースキー hello-job を持つジョブと 1 つのノートブックタスクを定義します。

YAML
resources:
  jobs:
    hello-job:
      name: hello-job
      tasks:
        - task_key: hello-task
          notebook_task:
            notebook_path: ./hello.py

ジョブタスクの定義とジョブ設定のオーバーライドに関する情報については、「Databricks Asset Bundle でのジョブへのタスクの追加」、「Databricks Asset Bundles でのジョブタスク設定のオーバーライド」、および「Databricks Asset Bundle でのクラスター設定のオーバーライド」を参照してください。

モデル(レガシー)

モデルリソースを使用すると、レガシーモデルをバンドルで定義できます。 Databricks では、代わりに Unity Catalog に登録されたモデルを使用することをお勧めします。

モデル_サービス_エンドポイント

model_serving_endpoint リソースを使用すると、モデルサービングエンドポイントを定義できます。モデルサービングエンドポイントの管理を参照してください。

例

次の例では、 Unity Catalog モデルサービングエンドポイントを定義しています。

YAML
resources:
  model_serving_endpoints:
    uc_model_serving_endpoint:
      name: 'uc-model-endpoint'
      config:
        served_entities:
          - entity_name: 'myCatalog.mySchema.my-ads-model'
            entity_version: '10'
            workload_size: 'Small'
            scale_to_zero_enabled: 'true'
        traffic_config:
          routes:
            - served_model_name: 'my-ads-model-10'
              traffic_percentage: '100'
      tags:
        - key: 'team'
          value: 'data science'

quality_monitor (Unity Catalog)

quality_monitor リソースを使用すると、 Unity Catalog テーブル・モニターを定義できます。モニターに関する情報については、「モニターモデルの品質とエンドポイントの正常性」を参照してください。

例

次の例では、品質モニターを定義しています。

YAML
resources:
  quality_monitors:
    my_quality_monitor:
      table_name: dev.mlops_schema.predictions
      output_schema_name: ${bundle.target}.mlops_schema
      assets_dir: /Users/${workspace.current_user.userName}/databricks_lakehouse_monitoring
      inference_log:
        granularities: [1 day]
        model_id_col: model_id
        prediction_col: prediction
        label_col: price
        problem_type: PROBLEM_TYPE_REGRESSION
        timestamp_col: timestamp
      schedule:
        quartz_cron_expression: 0 0 8 * * ? # Run Every day at 8am
        timezone_id: UTC

registered_model (Unity Catalog)

登録済みのモデルリソースを使用すると、Unity Catalog でモデルを定義できます。登録されたモデルに関する情報については、「Unity Catalog でのモデルのライフサイクルの管理Unity Catalog 」を参照してください。

例

次の例では、Unity Catalog に登録されているモデルを定義しています。

YAML
resources:
  registered_models:
    model:
      name: my_model
      catalog_name: ${bundle.target}
      schema_name: mlops_schema
      comment: Registered model in Unity Catalog for ${bundle.target} deployment target
      grants:
        - privileges:
            - EXECUTE
          principal: account users

パイプライン

パイプラインリソースを使用すると、DLT パイプラインを作成できます。パイプラインに関する情報については、「 DLT とは」を参照してください。 Databricks Asset Bundles テンプレートを使用してパイプラインを作成するチュートリアルについては、「Databricks Asset Bundles を使用した DLT パイプラインの開発」を参照してください。

例

次の例では、リソースキーが hello-pipelineを持つパイプラインを定義しています。

YAML
resources:
  pipelines:
    hello-pipeline:
      name: hello-pipeline
      clusters:
        - label: default
          num_workers: 1
      development: true
      continuous: false
      channel: CURRENT
      edition: CORE
      photon: false
      libraries:
        - notebook:
            path: ./pipeline.py

スキーマ (Unity Catalog)

スキーマリソースの種類を使用すると、バンドルの一部として作成されたワークフローとパイプライン内のテーブルやその他のアセットの Unity Catalog スキーマを定義できます。スキーマは、他のリソースタイプとは異なり、次の制限があります。

スキーマリソースの所有者は常にデプロイメントユーザーであり、変更することはできません。バンドルにrun_asが指定されている場合、スキーマに対する操作では無視されます。
対応するスキーマオブジェクト作成 API でサポートされているフィールドのみが、スキーマリソースで使用できます。たとえば、 enable_predictive_optimization は更新 API でのみ使用できるため、サポートされていません。

例

次の例では、リソースキー my_pipeline を使用してパイプラインを定義し、キー my_schema をターゲットとして Unity Catalog スキーマを作成します。

YAML
resources:
  pipelines:
    my_pipeline:
      name: test-pipeline-{{.unique_id}}
      libraries:
        - notebook:
            path: ./nb.sql
      development: true
      catalog: main
      target: ${resources.schemas.my_schema.id}

  schemas:
    my_schema:
      name: test-schema-{{.unique_id}}
      catalog_name: main
      comment: This schema was created by DABs.

最上位の付与マッピングは Databricks Asset Bundle ではサポートされていないため、スキーマの付与を設定する場合は、 schemas マッピング内でスキーマの付与を定義します。権限の詳細については、「権限の表示、付与、および取り消し」を参照してください。

次の例では、許可を使用して Unity Catalog スキーマを定義しています。

YAML
resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - SELECT
        - principal: my_team
          privileges:
            - CAN_MANAGE
      catalog_name: main

ボリューム (Unity Catalog)

ボリュームリソースの種類を使用すると、Unity Catalog ボリュームをバンドルの一部として定義および作成できます。ボリュームが定義されたバンドルをデプロイする場合は、次の点に注意してください。

ボリュームは、ワークスペースに存在するまで、バンドルの artifact_path で参照できません。したがって、Databricks Asset Bundles を使用してボリュームを作成する場合は、まずバンドルでボリュームを定義し、それをデプロイしてボリュームを作成し、その後のデプロイで artifact_path で参照する必要があります。
バンドル内のボリュームは、デプロイメントターゲットがmode: development設定されている場合、dev_${workspace.current_user.short_name}プレフィックスが先頭に付けられません。ただし、このプレフィックスは手動で設定できます。「カスタムプリセット」を参照してください。

例

次の例では、キー my_volume( T ) を使用して Unity Catalog ボリュームを作成します。

YAML
resources:
  volumes:
    my_volume:
      catalog_name: main
      name: my_volume
      schema_name: my_schema

Unity Catalog ボリューム内のファイルに書き込むジョブを実行するバンドルの例については、 bundle-examples GitHub リポジトリを参照してください。

サポートされているリソース​

アプリ​

例​

クラスター​

例​

ダッシュボード​

例​

エクスペリメント​

例​

ジョブ​

例​

モデル(レガシー)​

モデル_サービス_エンドポイント​

例​

quality_monitor (Unity Catalog)​

例​

registered_model (Unity Catalog)​

例​

パイプライン​

例​

スキーマ (Unity Catalog)​

例​

ボリューム (Unity Catalog)​

例​