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/11/21 13:48:17 UTC
[GitHub] [airflow] mik-laj opened a new pull request #12533: Troubleshooting moved to the installation page
mik-laj opened a new pull request #12533:
URL: https://github.com/apache/airflow/pull/12533
Recently our friend - @mschickensoup and [my friend Hektor](https://www.instagram.com/hrabia.hektor/) had this problem. Unfortunately, they couldn't easily find this section in the documentation.
After this change, this page still wouldn't answer all of their questions, but it is possible we could go one step further. Hopefully, I can reserve some time to describe the installation process in more detail one day. Installing Airflow is a problem for many people, so it would be worthwhile to describe it in detail.
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
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).
----------------------------------------------------------------
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
[GitHub] [airflow] github-actions[bot] commented on pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#issuecomment-732014082
The PR is ready to be merged. No tests are needed!
----------------------------------------------------------------
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
[GitHub] [airflow] mik-laj commented on a change in pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#discussion_r528198541
##########
File path: docs/installation.rst
##########
@@ -157,3 +157,32 @@ Docker image
''''''''''''
Airflow is also distributed as a Docker image (OCI Image). For more information, see: :doc:`production-deployment`
+
+Troubleshooting
+'''''''''''''''
+
+This section describes how to troubleshoot installation issues.
+
+``Symbol not found: _Py_GetArgcArgv``
+"""""""""""""""""""""""""""""""""""""
+
+If you see ``Symbol not found: _Py_GetArgcArgv`` while starting or importing Airflow, this may mean that you are using an incompatible version of Python.
Review comment:
I edited the first two sentences slightly to match the section title.
----------------------------------------------------------------
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
[GitHub] [airflow] mik-laj commented on pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
mik-laj commented on pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#issuecomment-731645487
@XD-DENG How will this benefit us? I think this will only make it harder to find this section.
At one of the [docs meetings](https://github.com/apache/airflow/discussions/12112), the FAQ section was discussed and eventually such a sentence appeared in the meeting notes.
> FAQ content should be moved to where it belongs.
----------------------------------------------------------------
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
[GitHub] [airflow] XD-DENG commented on pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
XD-DENG commented on pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#issuecomment-731633669
Does it suffice to have a paragraph redirecting users to the corresponding sections of FAQ?
----------------------------------------------------------------
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
[GitHub] [airflow] mik-laj edited a comment on pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
mik-laj edited a comment on pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#issuecomment-731645487
@XD-DENG How will this benefit us? I think this will only make it harder to find this section.
At one of the [docs meetings](https://github.com/apache/airflow/discussions/12112), the FAQ section was discussed and eventually such a sentence appeared in the meeting notes.
> FAQ content should be moved to where it belongs.
The "Throubleshooting" section is also nothing new in our documentation. [The guide for BashOperator](https://airflow.readthedocs.io/en/latest/howto/operator/bash.html#troubleshooting) is similarly constructed. There we also have a separate section with the title of the error that the user can see.
----------------------------------------------------------------
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
[GitHub] [airflow] XD-DENG commented on pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
XD-DENG commented on pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#issuecomment-731645866
> @XD-DENG How will this benefit us? I think this will only make it harder to find this section.
>
> At one of the [docs meetings](https://github.com/apache/airflow/discussions/12112), the FAQ section was discussed and eventually such a sentence appeared in the meeting notes.
>
> > FAQ content should be moved to where it belongs.
Just an option to suggest. No strong opinion on this. Feel free to proceed the change of course.
----------------------------------------------------------------
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
[GitHub] [airflow] mik-laj commented on a change in pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
mik-laj commented on a change in pull request #12533:
URL: https://github.com/apache/airflow/pull/12533#discussion_r528198455
##########
File path: docs/installation.rst
##########
@@ -157,3 +157,32 @@ Docker image
''''''''''''
Airflow is also distributed as a Docker image (OCI Image). For more information, see: :doc:`production-deployment`
+
+Troubleshooting
+'''''''''''''''
+
+This section describes how to troubleshoot installation issues.
+
+``Symbol not found: _Py_GetArgcArgv``
+"""""""""""""""""""""""""""""""""""""
+
+If you see ``Symbol not found: _Py_GetArgcArgv`` while starting or importing Airflow, this may mean that you are using an incompatible version of Python.
+For a homebrew installed version of Python, this is generally caused by using Python in ``/usr/local/opt/bin`` rather than the Frameworks installation (e.g. for ``python 3.7``: ``/usr/local/opt/python@3.7/Frameworks/Python.framework/Versions/3.7``).
+
+The crux of the issue is that a library Airflow depends on, ``setproctitle``, uses a non-public Python API
+which is not available from the standard installation ``/usr/local/opt/`` (which symlinks to a path under ``/usr/local/Cellar``).
+
+An easy fix is just to ensure you use a version of Python that has a dylib of the Python library available. For example:
+
+.. code-block:: bash
+
+ # Note: these instructions are for python3.7 but can be loosely modified for other versions
+ brew install python@3.7
+ virtualenv -p /usr/local/opt/python@3.7/Frameworks/Python.framework/Versions/3.7/bin/python3 .toy-venv
+ source .toy-venv/bin/activate
+ pip install apache-airflow
+ python
+ >>> import setproctitle
+ # Success!
+
+Alternatively, you can download and install Python directly from the `Python website <https://www.python.org/>`__.
Review comment:
Here was the link markdown. Now there is an RST link.
----------------------------------------------------------------
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
[GitHub] [airflow] mik-laj merged pull request #12533: Troubleshooting moved to the installation page
Posted by GitBox <gi...@apache.org>.
mik-laj merged pull request #12533:
URL: https://github.com/apache/airflow/pull/12533
----------------------------------------------------------------
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