`airflow.providers.google.cloud.operators.kubernetes_engine`¶

此模組包含 Google Kubernetes Engine 運算子。

模組內容¶

類別¶

`GKEClusterAuthDetails`	用於獲取叢集資訊以進行連線的輔助程式。
`GKEOperatorMixin`	GKE 運算子的 Mixin，提供適當的統一 Hook 建立。
`GKEDeleteClusterOperator`	刪除叢集，包括 Kubernetes 端點和所有工作節點。
`GKECreateClusterOperator`	建立指定維度的 Google Kubernetes Engine 叢集，並等待叢集建立完成。
`GKEStartKueueInsideClusterOperator`	在叢集內部安裝特定版本的 Kueue。
`GKEStartPodOperator`	在指定的 Google Kubernetes Engine 叢集的 Kubernetes Pod 中執行任務。
`GKEStartJobOperator`	在指定的 Google Kubernetes Engine 叢集中執行 Kubernetes Job。
`GKEDescribeJobOperator`	檢索有關給定名稱的 Job 的資訊。
`GKEListJobsOperator`	檢索 Job 列表。
`GKECreateCustomResourceOperator`	在指定的 Google Kubernetes Engine 叢集中建立資源。
`GKEDeleteCustomResourceOperator`	在指定的 Google Kubernetes Engine 叢集中刪除資源。
`GKEStartKueueJobOperator`	在指定的 Google Kubernetes Engine 叢集的 Kueue 中執行 Kubernetes Job。
`GKEDeleteJobOperator`	在指定的 Google Kubernetes Engine 叢集中刪除 Kubernetes Job。
`GKESuspendJobOperator`	暫停給定名稱的 Job。
`GKEResumeJobOperator`	恢復給定名稱的 Job。

屬性¶

KUBE_CONFIG_ENV_VAR

airflow.providers.google.cloud.operators.kubernetes_engine.KUBE_CONFIG_ENV_VAR = 'KUBECONFIG'[原始碼]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEClusterAuthDetails(cluster_name, project_id, use_internal_ip, cluster_hook)[原始碼]¶

用於獲取叢集資訊以進行連線的輔助程式。

參數

cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
project_id (str) – Google 開發人員控制台專案 ID。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
cluster_hook (airflow.providers.google.cloud.hooks.kubernetes_engine.GKEHook) – 用於處理 Kubernetes 叢集的 airflow hook。

fetch_cluster_info()[原始碼]¶

獲取叢集資訊以進行連線。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEOperatorMixin[原始碼]¶

GKE 運算子的 Mixin，提供適當的統一 Hook 建立。

property cluster_url: str[原始碼]¶

property ssl_ca_cert: str[原始碼]¶

enable_tcp_keepalive = False[原始碼]¶

template_fields: collections.abc.Sequence[str] = ('location', 'cluster_name', 'use_internal_ip', 'project_id', 'gcp_conn_id', 'impersonation_chain')[原始碼]¶

cluster_hook()[原始碼]¶

hook()[原始碼]¶

cluster_info()[原始碼]¶

獲取叢集資訊以進行連線。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEDeleteClusterOperator(location, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, cluster_name=None, name=None, api_version='v2', deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), poll_interval=10, *args, **kwargs)[原始碼]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

刪除叢集，包括 Kubernetes 端點和所有工作節點。

若要刪除特定叢集，您必須指定 project_id、叢集的 cluster_name、叢集所在的 location 和 task_id。

運算子建立:

operator = GKEClusterDeleteOperator(
            task_id='cluster_delete',
            project_id='my-project',
            location='cluster-location'
            cluster_name='cluster-name')

另請參閱

如需有關刪除叢集的更多詳細資訊，請參閱參考資料： https://google-cloud-python.readthedocs.io/en/latest/container/gapic/v1/api.html#google.cloud.container_v1.ClusterManagerClient.delete_cluster

另請參閱

如需有關如何使用此運算子的更多資訊，請參閱指南：刪除 GKE 叢集

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str | None) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。
name (str | None) – (已過時) 要刪除的資源名稱，在此案例中為叢集名稱
api_version (str) – 要使用的 API 版本
deferrable (bool) – 在可延遲模式下執行運算子。
poll_interval (int) – 定義檢查操作狀態頻率的間隔大小。

property name: str | None[原始碼]¶

template_fields: collections.abc.Sequence[str][原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

execute_complete(context, event)[原始碼]¶

在觸發器 Job 完成後執行。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKECreateClusterOperator(body, location, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, api_version='v2', deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), poll_interval=10, *args, **kwargs)[原始碼]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

建立指定維度的 Google Kubernetes Engine 叢集，並等待叢集建立完成。

定義要建立的叢集所需的最低限度是

dict() ::: cluster_def = {“name”: “my-cluster-name”, “initial_node_count”: 1}

或

Cluster proto：

from google.cloud.container_v1.types import Cluster

cluster_def = Cluster(name=”my-cluster-name”, initial_node_count=1)

運算子建立:

operator = GKEClusterCreateOperator(
            task_id='cluster_create',
            project_id='my-project',
            location='my-location'
            body=cluster_def)

另請參閱

如需有關建立叢集的更多詳細資訊，請參閱參考資料： google.cloud.container_v1.types.Cluster

另請參閱

如需有關如何使用此運算子的更多資訊，請參閱指南：建立 GKE 叢集

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。
body (dict | google.cloud.container_v1.types.Cluster) – 要建立的叢集定義，可以是 protobuf 或 Python dict，如果為 dict，則必須符合 protobuf 訊息 Cluster
api_version (str) – 要使用的 API 版本
deferrable (bool) – 在可延遲模式下執行運算子。
poll_interval (int) – 定義檢查操作狀態頻率的間隔大小。

template_fields: collections.abc.Sequence[str][原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

execute_complete(context, event)[原始碼]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartKueueInsideClusterOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[原始碼]¶

基礎： GKEOperatorMixin、 airflow.providers.cncf.kubernetes.operators.kueue.KubernetesInstallKueueOperator

在叢集內部安裝特定版本的 Kueue。

另請參閱

如需有關如何使用此運算子的更多資訊，請參閱指南：在叢集內部安裝特定版本的 Kueue

另請參閱

如需有關 Kueue 的更多詳細資訊，請參閱參考資料： https://kueue.sigs.k8s.io/docs/overview/

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

enable_tcp_keepalive = True[原始碼]¶

template_fields[原始碼]¶

operator_extra_links = ()[原始碼]¶

execute(context)[原始碼]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartPodOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, regional=None, on_finish_action=None, is_delete_operator_pod=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), *args, **kwargs)[原始碼]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator

在指定的 Google Kubernetes Engine 叢集的 Kubernetes Pod 中執行任務。

此 Operator 假設系統已安裝 gcloud，並已使用服務帳戶設定連線 ID。

定義要建立叢集所需的最低要求是變數 task_id、project_id、location、cluster_name、name、namespace 和 image

另請參閱

如需 Kubernetes Engine 驗證的更多詳細資訊，請參閱此參考資料： https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#internal_ip

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集上執行 Pod

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。
regional (bool | None) – (已棄用) location 參數為區域名稱。
on_finish_action (str | None) – Pod 達到最終狀態或執行中斷時要執行的動作。若為 “delete_pod”，無論 Pod 狀態為何都將被刪除；若為 “delete_succeeded_pod”，則僅刪除成功的 Pod。您可以設定為 “keep_pod” 以保留 Pod。目前的預設值為 keep_pod，但這將在此供應商的下一個主要版本中變更。
is_delete_operator_pod (bool | None) – (已棄用) Pod 達到最終狀態或執行中斷時要執行的動作。若為 True，則刪除 Pod；若為 False，則保留 Pod。目前的預設值為 False，但這將在此供應商的下一個主要版本中變更。已棄用 - 請改用 on_finish_action。
deferrable (bool) – 在可延遲模式下執行運算子。

property is_delete_operator_pod: bool | None[source]¶

property regional: bool | None[source]¶

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

invoke_defer_method(last_log_time=None)[source]¶

重新定義子類別中使用的觸發器。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartJobOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), job_poll_interval=10.0, *args, **kwargs)[source]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.job.KubernetesJobOperator

在指定的 Google Kubernetes Engine 叢集中執行 Kubernetes Job。

此 Operator 假設系統已安裝 gcloud，並已使用服務帳戶設定連線 ID。

定義要建立叢集所需的最低要求是變數 task_id、project_id、location、cluster_name、name、namespace 和 image

另請參閱

如需 Kubernetes Engine 驗證的更多詳細資訊，請參閱此參考資料： https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#internal_ip

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集上執行 Job

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。
deferrable (bool) – 在可延遲模式下執行運算子。
poll_interval – (僅限可延遲模式) 輪詢間隔（秒），以檢查 Job 的狀態。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

執行建立 Job 的程序。

execute_deferrable()[source]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEDescribeJobOperator(job_name, namespace, location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

檢索有關給定名稱的 Job 的資訊。

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：依指定名稱檢索 Job 的相關資訊

參數

job_name (str) – 要刪除的 Job 名稱
namespace (str) – Google Kubernetes Engine 命名空間的名稱。
location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEListJobsOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, namespace=None, do_xcom_push=True, *args, **kwargs)[source]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

檢索 Job 列表。

如果指定了命名空間參數，則會檢索來自專用命名空間的 Job 列表。如果未指定命名空間，則會輸出所有命名空間的 Job。

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：檢索 Job 列表

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。
namespace (str | None) – Google Kubernetes Engine 命名空間的名稱。
do_xcom_push (bool) – 若設為 True，Job 的結果列表將會推送至任務結果。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKECreateCustomResourceOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.resource.KubernetesCreateResourceOperator

在指定的 Google Kubernetes Engine 叢集中建立資源。

此 Operator 假設系統已安裝 gcloud，並已使用服務帳戶設定連線 ID。

另請參閱

如需 Kubernetes Engine 驗證的更多詳細資訊，請參閱此參考資料： https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#internal_ip

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集中建立資源

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEDeleteCustomResourceOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.resource.KubernetesDeleteResourceOperator

在指定的 Google Kubernetes Engine 叢集中刪除資源。

此 Operator 假設系統已安裝 gcloud，並已使用服務帳戶設定連線 ID。

另請參閱

如需 Kubernetes Engine 驗證的更多詳細資訊，請參閱此參考資料： https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#internal_ip

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集中刪除資源

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartKueueJobOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.kueue.KubernetesStartKueueJobOperator

在指定的 Google Kubernetes Engine 叢集的 Kueue 中執行 Kubernetes Job。

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields[source]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEDeleteJobOperator(location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基底類別： GKEOperatorMixin, airflow.providers.cncf.kubernetes.operators.job.KubernetesDeleteJobOperator

在指定的 Google Kubernetes Engine 叢集中刪除 Kubernetes Job。

此 Operator 假設系統已安裝 gcloud，並已使用服務帳戶設定連線 ID。

定義要建立叢集所需的最低要求是變數 task_id、project_id、location、cluster_name、name、namespace

另請參閱

如需 Kubernetes Engine 驗證的更多詳細資訊，請參閱此參考資料： https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#internal_ip

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集上刪除 Job

參數

location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

class airflow.providers.google.cloud.operators.kubernetes_engine.GKESuspendJobOperator(name, namespace, location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

暫停給定名稱的 Job。

另請參閱

如需關於如何使用此 operator 的更多資訊，請參閱指南：在 GKE 叢集上暫停 Job

參數

name (str) – 要暫停的 Job 名稱
namespace (str) – Google Kubernetes Engine 命名空間的名稱。
location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

class airflow.providers.google.cloud.operators.kubernetes_engine.GKEResumeJobOperator(name, namespace, location, cluster_name, use_internal_ip=False, project_id=PROVIDE_PROJECT_ID, gcp_conn_id='google_cloud_default', impersonation_chain=None, *args, **kwargs)[source]¶

基礎： GKEOperatorMixin、 airflow.providers.google.cloud.operators.cloud_base.GoogleCloudBaseOperator

恢復給定名稱的 Job。

另請參閱

如需瞭解如何使用此運算子，請參閱指南：在 GKE 叢集上恢復 Job

參數

name (str) – 要恢復的 Job 名稱
namespace (str) – Google Kubernetes Engine 命名空間的名稱。
location (str) – Google Kubernetes Engine 區域或地區的名稱，叢集位於其中，例如 'us-central1-a'
cluster_name (str) – Google Kubernetes Engine 叢集的名稱。
use_internal_ip (bool) – 使用內部 IP 位址作為端點。
project_id (str) – Google 開發人員控制台專案 ID
gcp_conn_id (str) – 要使用的 Google Cloud 連線 ID。這允許使用者指定服務帳戶。
impersonation_chain (str | collections.abc.Sequence[str] | None) – 要使用短期憑證模擬的可選服務帳戶，或取得列表中最後一個帳戶的 access_token 所需的帳戶列表，該帳戶將在請求中被模擬。如果設定為字串，則帳戶必須授予原始帳戶「服務帳戶權杖建立者」IAM 角色。如果設定為序列，則列表中的身分必須將「服務帳戶權杖建立者」IAM 角色授予緊鄰的前一個身分，列表中的第一個帳戶將此角色授予原始帳戶（範本化）。

template_fields: collections.abc.Sequence[str][source]¶

operator_extra_links = ()[source]¶

execute(context)[source]¶

在建立運算子時衍生。

Context 是與呈現 Jinja 範本時使用的字典相同的字典。

請參閱 get_template_context 以取得更多上下文。

airflow.providers.google.cloud.operators.kubernetes_engine¶

模組內容¶

類別¶

屬性¶

`airflow.providers.google.cloud.operators.kubernetes_engine`¶