Cloud Composer 1 | Cloud Composer 2
Apache Airflow には REST API インターフェースがあり、DAG 実行とタスクに関する情報の取得、DAG の更新、Airflow 構成の取得、接続の追加と削除、ユーザーの一覧表示などのタスクを実行に使用できます。
Cloud Functions で Airflow REST API を使用する例については、Cloud Functions を使用した DAG のトリガーをご覧ください。
Airflow REST API のバージョン
Cloud Composer 2 では、次の Airflow REST API バージョンを使用できます。
Airflow 2 は、安定版の REST API を使用します。試験運用版の REST API の Airflow によるサポートは終了しました。
Airflow 構成のオーバーライド経由で有効にすると、試験運用版の REST API を引き続き Airflow 2 で使用できます。詳細については、以下をご覧ください。
始める前に
Enable the Cloud Composer API.
安定版の Airflow REST API を有効にする
安定版の REST API は、Airflow 2 でデフォルトですでに有効になっています。
Cloud Composer は独自の API 認証バックエンドを使用します。認可は、Airflow が提供する標準の方法で機能します。新しいユーザーが API を使用して認可すると、デフォルトで、ユーザーのアカウントに Op
ロールが付与されます。
以下の Airflow 構成オプションをオーバーライドすることで、安定版の REST API を有効または無効にできます。また、デフォルトのユーザーロールを変更することもできます。
セクション | キー | 値 | メモ |
---|---|---|---|
api
|
(Airflow 2.2.5 以前)auth_backend (Airflow 2.3.0 以降) auth_backends
|
airflow.composer.api.backend.composer_auth
|
安定版の REST API を無効にするには、airflow.api.auth.backend.deny_all に変更します。 |
api
|
composer_auth_user_registration_role
|
Op
|
その他のロールも指定できます。 |
試験運用版の Airflow REST API を有効にする
試験運用版 API では、API 認証機能はデフォルトで無効になっています。Airflow ウェブサーバーは、すべてのリクエストを拒否します。
API 認証機能と Airflow 2 試験運用版 API を有効にするには、次の Airflow 構成オプションをオーバーライドします。
セクション | キー | 値 | メモ |
---|---|---|---|
api
|
(Airflow 2.2.5 以前)auth_backend (Airflow 2.3.0 以降) auth_backends
|
airflow.api.auth.backend.default
|
デフォルトは airflow.composer.api.backend.composer_auth です。 |
api
|
enable_experimental_api
|
True
|
デフォルトは False です。 |
この構成オプションを airflow.api.auth.backend.default
に設定すると、Airflow ウェブサーバーは認証を行うことなくすべての API リクエストを受け入れます。Airflow ウェブサーバー自体は認証を必要としませんが、独自の認証レイヤを備える Identity-Aware Proxy によって保護されます。
Webserver Access Control を使用して Airflow REST API への API 呼び出しを許可する
Airflow REST API を呼び出すために使用されるメソッドに応じて、呼び出し元のメソッドは IPv4 または IPv6 アドレスを使用できます。Webserver Access Control を使用して、Airflow REST API への IP トラフィックのブロックを解除します。
Airflow REST API の呼び出しが送信される IP アドレスがわからない場合は、デフォルトの構成オプション All IP addresses have access (default)
を使用します。
Airflow REST API を呼び出す
このセクションでは、安定版の Airflow REST API で DAG をトリガーするために使用できる Python スクリプトの例を示します。
次の例の内容を composer2_airflow_rest_api.py
という名前のファイルに入力し、パラメータで Airflow UI URL、DAG の名前、DAG 実行構成を指定します。
たとえば、次の構成は正しくありません
web_server_url = (
"https://example-airflow-ui-url-dot-us-central1.composer.googleusercontent.com/"
)
サービス アカウントを使用して Airflow REST API にアクセスする
Airflow データベースでは、メール フィールドの長さを 64 文字に制限します。サービス アカウントのメールアドレスが 64 文字を超える場合があります。通常の方法で、このようなサービス アカウントの Airflow ユーザーを作成することはできません。このようなサービス アカウントのために Airflow ユーザーが存在しない場合、Airflow REST API にアクセスすると HTTP エラー 401 と 403 が発生します。
回避策として、サービス アカウントの Airflow ユーザーを事前登録できます。これを行うには、accounts.google.com:NUMERIC_USER_ID
をユーザー名として使用し、一意の文字列をメールとして使用します。
サービス アカウントの
NUMERIC_USER_ID
を取得するには、次のコマンドを実行します。gcloud iam service-accounts describe \ SA_NAME@PROJECT_ID.iam.gserviceaccount.com \ --format="value(oauth2ClientId)"
次のように置き換えます。
SA_NAME
は、サービス アカウント名に置き換えます。PROJECT_ID
は、プロジェクト ID に置き換えます。
サービス アカウントの
Op
ロールを持つ Airflow ユーザーを作成します。Airflow UI
[セキュリティ] > [ユーザーの一覧表示] の順に移動し、[新しいレコードを追加する] をクリックします。このページを開くには、Airflow ユーザーに
Admin
ロールが必要です。ユーザー名として
accounts.google.com:NUMERIC_USER_ID
を指定します。NUMERIC_USER_ID
を前の手順で取得したユーザー ID に置き換えます。メールアドレスとして一意の識別子を指定します。任意の一意の文字列を使用できます。
ユーザーのロールを指定します。例:
Op
[有効] チェックボックスがオンになっていることを確認します。
ユーザーの姓と名を指定します。任意の文字列を使用できます。
[保存] をクリックします。
gcloud
次の Airflow CLI コマンドを実行します。
gcloud composer environments run ENVIRONMENT_NAME \ --location LOCATION \ users create -- \ -u accounts.google.com:NUMERIC_USER_ID \ -e UNIQUE_ID \ -f UNIQUE_ID \ -l - -r Op --use-random-password
次のように置き換えます。
ENVIRONMENT_NAME
を環境の名前にする。LOCATION
は、環境が配置されているリージョン。NUMERIC_USER_ID
は、前のステップで取得したユーザー ID に置き換えます。UNIQUE_ID
は Airflow ユーザーの識別子に置き換えます。任意の一意の文字列を使用できます。
サービス アカウントの Airflow ユーザーを作成すると、サービス アカウントとして認証された呼び出し元は、登録済みユーザーとして認識され、Airflow にログインします。
Airflow REST API コンポーネントのスケーリング
Airflow REST API と Airflow UI エンドポイントは、コンポーネント(Airflow ウェブサーバーなど)内で実行されます。REST API を集中使用する場合は、CPU とメモリのパラメータを増やして、Airflow ウェブサーバー リソースを予想される負荷に合わせて調整することを検討してください。