メインコンテンツまでスキップ

Databricks アプリの実行を構成する app.yaml

Databricks アプリのapp.yamlファイルは、アプリの実行方法を定義します。アプリに別のエントリ ポイントまたは環境固有の構成が必要な場合は、このオプションのファイルをプロジェクトに含めて、デフォルトの動作をオーバーライドできます。

.yamlまたは.ymlファイル拡張子を使用できます。このファイルは、プロジェクトディレクトリのルートに配置する必要があります。

サポートされている設定​

app.yaml ファイルでは、次の設定がサポートされています。

設定

Type

説明

command

sequence

アプリをランするためのカスタムコマンドが必要な場合にこの設定を使用します。defaultでは、Databricks はコマンド python <my-app.py> を使用して Python アプリを実行します。ここで <my-app.py> はアプリのルートディレクトリ内の最初の .py ファイル(アルファベット順)です。アプリに start スクリプトを含む package.json が含まれている場合、default コマンドは npm run start です。ロジックのデプロイを参照してください。

Databricksはコマンドをシェルで実行しないため、アプリ構成の外で定義された環境変数はアプリから利用できません。1 つの例外はDATABRICKS_APP_PORTで、これはランタイム時にコマンド内の実際のポート番号に置き換えられます。 アプリが実行に追加の問題を必要とする場合は、 env構造を使用します。

この設定はオプションです。

env

list

Databricks は、アプリのランタイム環境にいくつかの デフォルト 環境変数 を自動的に設定します。 この最上位のキーは、アプリに渡す追加の環境変数の省略可能なリストを定義します。各変数は、ハードコードされた値を使用するか、シークレットやデータベースエントリなどの外部ソースを参照できます。

リスト内の有効な項目は次のとおりです。

  • name: 環境変数の名前。
  • これは次のいずれかになります。

この設定はオプションです。

health_check

map

デプロイが成功したとマークする前にDatabricksがチェックするHTTP Endpointを定義します。有効なキーは以下の通りです。

  • path:/healthなどのリクエスト先のパス。/で起動する必要があります。
  • timeout_seconds:Endpointが正常に応答するのを待機する時間(秒単位)。default値と最大値は 300 です。

デプロイメントのヘルスチェックを設定するをご覧ください。

この設定はオプションです。

設定

Type

説明

command

sequence

アプリをランするためのカスタムコマンドが必要な場合にこの設定を使用します。defaultでは、Databricks はコマンド python <my-app.py> を使用して Python アプリを実行します。ここで <my-app.py> はアプリのルートディレクトリ内の最初の .py ファイル(アルファベット順)です。アプリに start スクリプトを含む package.json が含まれている場合、default コマンドは npm run start です。ロジックのデプロイを参照してください。

Databricksはコマンドをシェルで実行しないため、アプリ構成の外で定義された環境変数はアプリから利用できません。1 つの例外はDATABRICKS_APP_PORTで、これはランタイム時にコマンド内の実際のポート番号に置き換えられます。 アプリが実行に追加の問題を必要とする場合は、 env構造を使用します。

この設定はオプションです。

env

list

Databricks は、アプリのランタイム環境にいくつかの デフォルト 環境変数 を自動的に設定します。 この最上位のキーは、アプリに渡す追加の環境変数の省略可能なリストを定義します。各変数は、ハードコードされた値を使用するか、シークレットやデータベースエントリなどの外部ソースを参照できます。

リスト内の有効な項目は次のとおりです。

  • name: 環境変数の名前。
  • これは次のいずれかになります。

この設定はオプションです。

health_check

map

デプロイが成功したとマークする前にDatabricksがチェックするHTTP Endpointを定義します。有効なキーは以下の通りです。

  • path:/healthなどのリクエスト先のパス。/で起動する必要があります。
  • timeout_seconds:Endpointが正常に応答するのを待機する時間(秒単位)。default値と最大値は 300 です。

デプロイメントのヘルスチェックを設定するをご覧ください。

この設定はオプションです。

デプロイメントのヘルスチェックを設定する​

defaultでは、Databricksはアプリプロセスが起動されるとすぐにデプロイメントが成功したとマークします。アプリがリクエストを処理する準備がまだできていない場合でも同様です。health_check設定を追加して、Databricksがアプリの準備が完了するまで待機してからデプロイメントを完了するようにします。

ヘルスチェックが構成されている場合、Databricksはアプリの起動後にアプリの path にHTTP GET リクエストを送信し、Endpointが 2xx ステータスコードを返すか timeout_seconds が経過するまでそれらを繰り返します。ヘルスチェックは、アプリがデプロイまたは起動されるたびにランします。

  • Endpointが2xxステータスコードを返す場合、デプロイは成功し、新しいバージョンがトラフィックの処理を開始します。
  • タイムアウトまでにEndpointがステータスコード2xxを返さない場合、またはアプリのプロセスが終了した場合、デプロイは失敗します。デプロイ Logs には、ヘルスチェックが受信した最後のステータスコードまたはエラーが含まれます。

ヘルス チェックが失敗した後の以前のバージョンの処理は、アプリの種類によって異なります。

  • 水平スケールされたアプリ : 前のバージョンが引き続きトラフィックを処理します。Databricks Appsの水平スケーリングをご覧ください。
  • Standard アプリ : Databricks は前のバージョンを停止してから新しいバージョンを起動するため、ヘルスチェックに失敗するとアプリは停止します。問題を修正して再デプロイします。

次の例では、/health Endpoint が 2xx ステータスコードを返すまで最大 60 秒待機します。

YAML
command: ['python', 'app.py']
health_check:
path: '/health'
timeout_seconds: 60

Streamlit アプリの例app.yaml​

次の app.yaml ファイルは、Streamlitアプリの設定方法を示しています。カスタムコマンドを使用して streamlit run でアプリを起動し、アプリリソースからSQL Warehouse IDを読み取り、使用状況追跡フラグを設定します。valueFrom フィールドには、キー sql-warehouse を持つSQLウェアハウスリソースが必要です。Databricks アプリに SQL ウェアハウス リソースを追加するを参照してください。

YAML
command: ['streamlit', 'run', 'app.py']
env:
- name: 'DATABRICKS_WAREHOUSE_ID'
valueFrom: 'sql-warehouse'
- name: 'STREAMLIT_GATHER_USAGE_STATS'
value: 'false'

アプリが特定のコンピュート リソース ( SQLウェアハウスなど) に依存している場合、またはランタイムの動作を制御するために特定の環境変数が必要な場合は、このようなセットアップを使用します。

Flaskアプリの例app.yaml​

この例では、Gunicorn サーバーを使用して Flask アプリを構成する方法を示します。command 設定では Gunicorn のスタートアップ パラメーターを指定し、env セクションでは環境変数として Unity Catalog ボリュームへのパスを設定します。

YAML
command:
- gunicorn
- app:app
- -w
- 4
env:
- name: 'VOLUME_URI'
value: '/Volumes/catalog-name/schema-name/dir-name'

このアプローチは、アプリが Gunicorn のような本番運用可能な WSGI サーバーを必要としている場合や、 Unity Catalog ボリュームまたは別の環境固有のパスに保存されたデータに依存している場合に使用します。

その他のリソース​