mik-laj commented on a change in pull request #6393: [AIRFLOW-5718] Add SFTPToGoogleCloudStorageOperator [depends on AIRFLOW-5717] URL: https://github.com/apache/airflow/pull/6393#discussion_r338987587
########## File path: docs/howto/operator/gcp/sftp_to_gcs.rst ########## @@ -0,0 +1,118 @@ + .. 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. + + +SFTP to Google Cloud Storage Transfer Operator +============================================== + +Google has service `Google Cloud Storage <https://cloud.google.com/storage/>`__ that is +used to store large data from various applications. +SFTP (SSH File Transfer Protocol) is a secure file transfer protocol. +It runs over the SSH protocol. It supports the full security and authentication functionality of SSH. + + +.. contents:: + :depth: 1 + :local: + +Prerequisite Tasks +^^^^^^^^^^^^^^^^^^ + +.. include:: _partials/prerequisite_tasks.rst + +.. _howto/operator:SFTPToGoogleCloudStorageOperator: + + +Operator +^^^^^^^^ + +Transfer files between SFTP and Google Storage is performed with the +:class:`~airflow.operators.sftp_to_gcs.SFTPToGoogleCloudStorageOperator` operator. + +You can use :ref:`Jinja templating <jinja-templating>` with +:template-fields:`airflow.operators.sftp_to_gcs.SFTPToGoogleCloudStorageOperator` +parameters which allows you to dynamically determine values. + + +Arguments +^^^^^^^^^ + +Some arguments in the example DAG are taken from the OS environment variables: + +.. exampleinclude:: ../../../../airflow/example_dags/example_sftp_to_gcs.py Review comment: This is not needed in the latest guide template, because we have a button that allows you to see the entire source code of the example. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
