[
https://issues.apache.org/jira/browse/AIRFLOW-6290?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17110797#comment-17110797
]
ASF GitHub Bot commented on AIRFLOW-6290:
-----------------------------------------
mik-laj commented on a change in pull request #8883:
URL: https://github.com/apache/airflow/pull/8883#discussion_r426998501
##########
File path: docs/howto/operator/gcp/kubernetes_engine.rst
##########
@@ -0,0 +1,122 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+
+Google Kubernetes Engine Operators
+==================================
+
+`Google Kubernetes Engine (GKE)
<https://cloud.google.com/kubernetes-engine/>`__ provides a managed environment
for
+deploying, managing, and scaling your containerized applications using Google
infrastructure. The GKE environment
+consists of multiple machines (specifically, Compute Engine instances) grouped
together to form a cluster.
+
+.. contents::
+ :depth: 1
+ :local:
+
+Prerequisite Tasks
+^^^^^^^^^^^^^^^^^^
+
+.. include:: _partials/prerequisite_tasks.rst
+
+Manage GKE cluster
+^^^^^^^^^^^^^^^^^^
+
+A cluster is the foundation of GKE - all workloads run on on top of the
cluster. It is made up on a cluster master
+and worker nodes. The lifecycle of the master is managed by GKE when creating
or deleting a cluster.
+The worker nodes are represented as Compute Engine VM instances that GKE
creates on your behalf when creating a cluster.
+
+.. _howto/operator:GKECreateClusterOperator:
+
+Create GKE cluster
+""""""""""""""""""
+
+Here is an example of a cluster definition:
+
+.. exampleinclude::
../../../../airflow/providers/google/cloud/example_dags/example_kubernetes_engine.py
+ :language: python
+ :start-after: [START howto_operator_gcp_gke_create_cluster_definition]
+ :end-before: [END howto_operator_gcp_gke_create_cluster_definition]
+
+A dict object like this, or a
+:class:`~google.cloud.container_v1.types.Cluster`
+definition, is required when creating a cluster with
+:class:`~airflow.providers.google.cloud.operators.kubernetes_engine.GKECreateClusterOperator`.
+
+.. exampleinclude::
../../../../airflow/providers/google/cloud/example_dags/example_kubernetes_engine.py
+ :language: python
+ :dedent: 4
+ :start-after: [START howto_operator_gke_create_cluster]
+ :end-before: [END howto_operator_gke_create_cluster]
+
+.. _howto/operator:GKEDeleteClusterOperator:
+
+Delete GKE cluster
+""""""""""""""""""
+
+To delete a cluster, use
+:class:`~airflow.providers.google.cloud.operators.kubernetes_engine.GKEDeleteClusterOperator`.
+This would also delete all the nodes allocated to the cluster.
+
+.. exampleinclude::
../../../../airflow/providers/google/cloud/example_dags/example_kubernetes_engine.py
+ :language: python
+ :dedent: 4
+ :start-after: [START howto_operator_gke_delete_cluster]
+ :end-before: [END howto_operator_gke_delete_cluster]
+
+Manage workloads on a GKE cluster
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+GKE works with containerized applications, such as those created on Docker,
and deploys them to run on the cluster.
+These are called workloads, and when deployed on the cluster they leverage the
CPU and memory resources of the cluster
+to run effectively.
+
+.. _howto/operator:GKEStartPodOperator:
+
+Run a Pod on a GKE cluster
+""""""""""""""""""""""""""
+
+To run a Kubernetes Pod on a GKE cluster, use
+:class:`~airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartPodOperator`.
+It is worth noting that this extends
+:class:`~airflow.providers.cncf.kubernetes.operators.kubernetes_pod.KubernetesPodOperator`
+so many of the same arguments can be used. We can enable the usage of
:ref:`XCom <concepts:xcom>`
+on the operator:
Review comment:
```suggestion
You can use two operators to run pod on a GKE cluster:
*
:class:`~airflow.providers.cncf.kubernetes.operators.kubernetes_pod.KubernetesPodOperator`
*
:class:`~airflow.providers.google.cloud.operators.kubernetes_engine.GKEStartPodOperator`
``GKEPodOperator`` extends ``KubernetesPodOperator`` to provide
authorization using a Google credentials. This way you don't have to manage the
`kube_config` file, but it will be generated automatically. All Kubernetes
(except `config_file`) parameters are also valid for GKEStartPodOperator.
For more information about starting pods on Airflow, please look at:
:ref:`howto/operator:KubernetesPodOperator` guide.
We can enable the usage of :ref:`XCom <concepts:xcom>` on the operator:
```
WDYT? I would like to show a clear difference between these two operators,
because it can be embarrassing. GKEPodOperator is not magic operaotr. It's only
wrapper.
This is especially important for me because this information is not in the
Cloud Composer documentation, and I often redirect users to this documentation
if they want to use KubernetesPodOperator
https://cloud.google.com/composer/docs/how-to/using/using-kubernetes-pod-operator
This guide is in the Cloud Composer documentation but applies to all users.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Create guide for GKE service operator
> -------------------------------------
>
> Key: AIRFLOW-6290
> URL: https://issues.apache.org/jira/browse/AIRFLOW-6290
> Project: Apache Airflow
> Issue Type: New Feature
> Components: documentation, gcp
> Affects Versions: 1.10.6
> Reporter: Kamil Bregula
> Priority: Minor
> Labels: GoodForNewContributors
>
> Hello,
> A guide that describes how to use GKE service operators would be useful.
> Other guides are available:
> https://airflow.readthedocs.io/en/latest/howto/operator/gcp/index.html
> If anyone is interested in this task, I am willing to provide all the
> necessary tips and information.
> Best regards,
> Kamil
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
