You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/01/03 02:54:49 UTC

[GitHub] [airflow] mik-laj opened a new pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

mik-laj opened a new pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014
 
 
   Add documentation about the unpopular feature.
   
   ---
   Link to JIRA issue: https://issues.apache.org/jira/browse/AIRFLOW-XXXX
   
   - [X] Description above provides context of the change
   - [X] Commit message starts with `[AIRFLOW-NNNN]`, where AIRFLOW-NNNN = JIRA ID*
   - [X] Unit tests coverage for changes (not needed for documentation changes)
   - [X] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
   - [X] Relevant documentation is updated including usage instructions.
   - [X] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
   
   (*) For document-only changes, no JIRA issue is needed. Commit message starts `[AIRFLOW-XXXX]`.
   
   ---
   In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362854367
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
+
+ * ``bmp``,
+ * ``canon``, ``dot``, ``gv``, ``xdot``, ``xdot1.2``, ``xdot1.4``,
+ * ``cgimage``,
+ * ``cmap``,
+ * ``eps``,
+ * ``exr``,
+ * ``fig``,
+ * ``gd``, ``gd2``,
+ * ``gif``,
+ * ``gtk``,
+ * ``ico``,
+ * ``imap``, ``cmapx``,
+ * ``imap_np``, ``cmapx_np``,
+ * ``ismap``,
+ * ``jp2``,
+ * ``jpg``, ``jpeg``, ``jpe``,
+ * ``json``, ``json0``, ``dot_json``, ``xdot_json``,
+ * ``pct``, ``pict``,
+ * ``pdf``,
+ * ``pic``,
+ * ``plain``, ``plain-ext``,
+ * ``png``,
+ * ``pov``,
+ * ``ps``,
+ * ``ps2``,
+ * ``psd``,
+ * ``sgi``,
+ * ``svg``, ``svgz``,
+ * ``tga``,
+ * ``tif``, ``tiff``,
+ * ``tk``,
+ * ``vml``, ``vmlz``,
+ * ``vrml``,
+ * ``wbmp``,
+ * ``webp``,
+ * ``xlib``,
+ * ``x11``.
+
+Display DAGs
+------------
+
+Sometimes you will work on DAGs that contain complex dependencies. It is helpful then to preview
+the DAG to see if it is correct.
+
+If you have macOS with `Graphviz <https://graphviz.gitlab.io/download/>`_  and `iTerm2 <https://iterm2.com/>`__
 
 Review comment:
   Oh yeah, I love iTerm2. Can we add the above comment in the docs too for the 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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] codecov-io commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
codecov-io commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#issuecomment-570931920
 
 
   # [Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=h1) Report
   > Merging [#7014](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=desc) into [master](https://codecov.io/gh/apache/airflow/commit/869ca9619c6af8103b1b6af4e1d2f0cf82d89e6f?src=pr&el=desc) will **decrease** coverage by `0.24%`.
   > The diff coverage is `100%`.
   
   [![Impacted file tree graph](https://codecov.io/gh/apache/airflow/pull/7014/graphs/tree.svg?width=650&token=WdLKlKHOAU&height=150&src=pr)](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=tree)
   
   ```diff
   @@            Coverage Diff             @@
   ##           master    #7014      +/-   ##
   ==========================================
   - Coverage   84.99%   84.74%   -0.25%     
   ==========================================
     Files         679      680       +1     
     Lines       38647    38731      +84     
   ==========================================
   - Hits        32847    32822      -25     
   - Misses       5800     5909     +109
   ```
   
   
   | [Impacted Files](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=tree) | Coverage Δ | |
   |---|---|---|
   | [airflow/example\_dags/example\_complex.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9leGFtcGxlX2RhZ3MvZXhhbXBsZV9jb21wbGV4LnB5) | `100% <100%> (ø)` | |
   | [airflow/kubernetes/volume\_mount.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZV9tb3VudC5weQ==) | `44.44% <0%> (-55.56%)` | :arrow_down: |
   | [airflow/kubernetes/volume.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZS5weQ==) | `52.94% <0%> (-47.06%)` | :arrow_down: |
   | [airflow/kubernetes/pod\_launcher.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3BvZF9sYXVuY2hlci5weQ==) | `45.25% <0%> (-46.72%)` | :arrow_down: |
   | [airflow/kubernetes/refresh\_config.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3JlZnJlc2hfY29uZmlnLnB5) | `50.98% <0%> (-23.53%)` | :arrow_down: |
   | [...rflow/contrib/operators/kubernetes\_pod\_operator.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL29wZXJhdG9ycy9rdWJlcm5ldGVzX3BvZF9vcGVyYXRvci5weQ==) | `78.75% <0%> (-20%)` | :arrow_down: |
   | [airflow/contrib/operators/ssh\_operator.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL29wZXJhdG9ycy9zc2hfb3BlcmF0b3IucHk=) | `84.61% <0%> (+1.28%)` | :arrow_up: |
   
   ------
   
   [Continue to review full report at Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=continue).
   > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
   > `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
   > Powered by [Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=footer). Last update [869ca96...588322b](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362763555
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
 
 Review comment:
   ```suggestion
   or send another without having to send the DAG file and install the application at
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] nuclearpinguin commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
nuclearpinguin commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362794892
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
 
 Review comment:
   Should we use more generic example? Not all users have to have GCP installed. Additionally, where should be the DAG file? Does this work only for DAGs in `AIRFLOW__CORE__DAGS_FOLDER`?

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362819656
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter, the command will print DAG to the screen in the DOT format.
 
 Review comment:
   ```suggestion
   After passing the ``dag_id`` parameter, the command will print rendered DAG structure (similar to Graph View) to the screen in the DOT format.
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362772502
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
 
 Review comment:
   ```suggestion
   However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362763555
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
 
 Review comment:
   ```suggestion
   or share with other people without having to send the DAG file and need to install the application.
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk merged pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk merged pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014
 
 
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362820001
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
+
+ * ``bmp``,
+ * ``canon``, ``dot``, ``gv``, ``xdot``, ``xdot1.2``, ``xdot1.4``,
+ * ``cgimage``,
+ * ``cmap``,
+ * ``eps``,
+ * ``exr``,
+ * ``fig``,
+ * ``gd``, ``gd2``,
+ * ``gif``,
+ * ``gtk``,
+ * ``ico``,
+ * ``imap``, ``cmapx``,
+ * ``imap_np``, ``cmapx_np``,
+ * ``ismap``,
+ * ``jp2``,
+ * ``jpg``, ``jpeg``, ``jpe``,
+ * ``json``, ``json0``, ``dot_json``, ``xdot_json``,
+ * ``pct``, ``pict``,
+ * ``pdf``,
+ * ``pic``,
+ * ``plain``, ``plain-ext``,
+ * ``png``,
+ * ``pov``,
+ * ``ps``,
+ * ``ps2``,
+ * ``psd``,
+ * ``sgi``,
+ * ``svg``, ``svgz``,
+ * ``tga``,
+ * ``tif``, ``tiff``,
+ * ``tk``,
+ * ``vml``, ``vmlz``,
+ * ``vrml``,
+ * ``wbmp``,
+ * ``webp``,
+ * ``xlib``,
+ * ``x11``.
+
+Display DAGs
+------------
+
+Sometimes you will work on DAGs that contain complex dependencies. It is helpful then to preview
+the DAG to see if it is correct.
+
+If you have macOS with `Graphviz <https://graphviz.gitlab.io/download/>`_  and `iTerm2 <https://iterm2.com/>`__
 
 Review comment:
   It will work for normal Terminal app as well, isn't it? Or does it only work on iTerm2?

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362818776
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
 
 Review comment:
   ```suggestion
   Exporting DAGs structure to images
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] codecov-io edited a comment on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
codecov-io edited a comment on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#issuecomment-570931920
 
 
   # [Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=h1) Report
   > Merging [#7014](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=desc) into [master](https://codecov.io/gh/apache/airflow/commit/869ca9619c6af8103b1b6af4e1d2f0cf82d89e6f?src=pr&el=desc) will **decrease** coverage by `0.24%`.
   > The diff coverage is `100%`.
   
   [![Impacted file tree graph](https://codecov.io/gh/apache/airflow/pull/7014/graphs/tree.svg?width=650&token=WdLKlKHOAU&height=150&src=pr)](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=tree)
   
   ```diff
   @@            Coverage Diff             @@
   ##           master    #7014      +/-   ##
   ==========================================
   - Coverage   84.99%   84.74%   -0.25%     
   ==========================================
     Files         679      680       +1     
     Lines       38647    38731      +84     
   ==========================================
   - Hits        32847    32822      -25     
   - Misses       5800     5909     +109
   ```
   
   
   | [Impacted Files](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=tree) | Coverage Δ | |
   |---|---|---|
   | [airflow/example\_dags/example\_complex.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9leGFtcGxlX2RhZ3MvZXhhbXBsZV9jb21wbGV4LnB5) | `100% <100%> (ø)` | |
   | [airflow/kubernetes/volume\_mount.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZV9tb3VudC5weQ==) | `44.44% <0%> (-55.56%)` | :arrow_down: |
   | [airflow/kubernetes/volume.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3ZvbHVtZS5weQ==) | `52.94% <0%> (-47.06%)` | :arrow_down: |
   | [airflow/kubernetes/pod\_launcher.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3BvZF9sYXVuY2hlci5weQ==) | `45.25% <0%> (-46.72%)` | :arrow_down: |
   | [airflow/kubernetes/refresh\_config.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9rdWJlcm5ldGVzL3JlZnJlc2hfY29uZmlnLnB5) | `50.98% <0%> (-23.53%)` | :arrow_down: |
   | [...rflow/contrib/operators/kubernetes\_pod\_operator.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL29wZXJhdG9ycy9rdWJlcm5ldGVzX3BvZF9vcGVyYXRvci5weQ==) | `78.75% <0%> (-20%)` | :arrow_down: |
   | [airflow/contrib/operators/ssh\_operator.py](https://codecov.io/gh/apache/airflow/pull/7014/diff?src=pr&el=tree#diff-YWlyZmxvdy9jb250cmliL29wZXJhdG9ycy9zc2hfb3BlcmF0b3IucHk=) | `84.61% <0%> (+1.28%)` | :arrow_up: |
   
   ------
   
   [Continue to review full report at Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=continue).
   > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
   > `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
   > Powered by [Codecov](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=footer). Last update [869ca96...588322b](https://codecov.io/gh/apache/airflow/pull/7014?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#issuecomment-570849985
 
 
   Merge Conflicts !

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] zhongjiajie commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#issuecomment-570554257
 
 
   Love this ❤️ 

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362798204
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
 
 Review comment:
   I will add a description of the `subdir` switch.  I wanted to show that CLI can also show very complex DAGs. Then this features is the most useful.  Unfortunately, other examples are relatively simple. This is just an example. so it can refer to specific operators. 

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362764360
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter itself, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
 
 Review comment:
   How about putting that list in single coma separated list ? It will take less space then.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362763921
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
 
 Review comment:
   ```suggestion
   However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362764008
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter itself, the command will print DAG to the screen in the DOT format.
 
 Review comment:
   ```suggestion
   After passing the ``dag_id`` parameter, the command will print DAG to the screen in the DOT format.
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362819450
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
 
 Review comment:
   I agree with @nuclearpinguin , we should add 1 example for our tutorial DAG or any other DAGs from https://github.com/apache/airflow/tree/master/airflow/example_dags

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r363108740
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter itself, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
 
 Review comment:
   OK.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362763555
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
 
 Review comment:
   ```suggestion
   or share with other people without having to send the DAG file and install the application at
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362853858
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+or share with other people without having to send the DAG file and need to install the application.
+However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed to generate it.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
+
+ * ``bmp``,
+ * ``canon``, ``dot``, ``gv``, ``xdot``, ``xdot1.2``, ``xdot1.4``,
+ * ``cgimage``,
+ * ``cmap``,
+ * ``eps``,
+ * ``exr``,
+ * ``fig``,
+ * ``gd``, ``gd2``,
+ * ``gif``,
+ * ``gtk``,
+ * ``ico``,
+ * ``imap``, ``cmapx``,
+ * ``imap_np``, ``cmapx_np``,
+ * ``ismap``,
+ * ``jp2``,
+ * ``jpg``, ``jpeg``, ``jpe``,
+ * ``json``, ``json0``, ``dot_json``, ``xdot_json``,
+ * ``pct``, ``pict``,
+ * ``pdf``,
+ * ``pic``,
+ * ``plain``, ``plain-ext``,
+ * ``png``,
+ * ``pov``,
+ * ``ps``,
+ * ``ps2``,
+ * ``psd``,
+ * ``sgi``,
+ * ``svg``, ``svgz``,
+ * ``tga``,
+ * ``tif``, ``tiff``,
+ * ``tk``,
+ * ``vml``, ``vmlz``,
+ * ``vrml``,
+ * ``wbmp``,
+ * ``webp``,
+ * ``xlib``,
+ * ``x11``.
+
+Display DAGs
+------------
+
+Sometimes you will work on DAGs that contain complex dependencies. It is helpful then to preview
+the DAG to see if it is correct.
+
+If you have macOS with `Graphviz <https://graphviz.gitlab.io/download/>`_  and `iTerm2 <https://iterm2.com/>`__
 
 Review comment:
   I tested it only with iTerm2. It seems to me that this is not a standardized mechanism and other applications do not allow the display of high-quality images. We can convert the image to text for display in another application, but this will not allow you to read its content.  It will be too poor quality.
   ![image](https://user-images.githubusercontent.com/12058428/71732404-7218b900-2e47-11ea-804f-b2b018549b93.png)
   So ... in theory it works with other programs, but it won't make sense.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#discussion_r362772234
 
 

 ##########
 File path: docs/usage-cli.rst
 ##########
 @@ -68,3 +68,94 @@ If you’re using ``zsh``, add the following to your ``.zshrc``:
   autoload bashcompinit
   bashcompinit
   eval "$(register-python-argcomplete airflow)"
+
+Exporting DAGs to images
+------------------------
+
+The application has the functionality of saving DAG to image file. You can attach them to the documentation
+for the documentation, or send another without having to send the DAG file and install the application at
+the other person. However, you need to have `Graphviz <https://graphviz.gitlab.io/download/>`_ installed.
+
+For example, if you want to export ``example_gcp_datacatalog`` DAG then you can use the following command:
+
+.. code-block:: bash
+
+  airflow dag show example_gcp_datacatalog
+
+After passing the ``dag_id`` parameter itself, the command will print DAG to the screen in the DOT format.
+
+It is possible to save the file in a different format. To do this, add the switch ``--save [filename].[format]``.
+If you want to save files as PNG, you can use the following command:
+
+.. code-block:: bash
+
+  airflow dags show example_gcp_datacatalog --save example_gcp_datacatalog.png
+
+An example image file may look as follow:
+
+.. figure:: img/usage_cli_export.png
+    :width: 100%
+
+    Example DAG representation
+
+The following file formats are supported:
 
 Review comment:
   It will be very difficult to find the format because each format has a different length. For me, a longer list is not a problem because it can be easily scrolled over.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [airflow] potiuk commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide

Posted by GitBox <gi...@apache.org>.
potiuk commented on issue #7014: [AIRFLOW-XXXX] Add `airflow dags show` command guide
URL: https://github.com/apache/airflow/pull/7014#issuecomment-570934827
 
 
   Really nice!

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services