[ 
https://issues.apache.org/jira/browse/AIRFLOW-6788?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Ash Berlin-Taylor updated AIRFLOW-6788:
---------------------------------------
    Component/s:     (was: database)
                 documentation
        Summary: Improve the instructions for getting started with Postgres  
(was: The Goddamn installation instructions for using Postgres as a backend 
need to be scrapped and rewritten)

> Improve the instructions for getting started with Postgres
> ----------------------------------------------------------
>
>                 Key: AIRFLOW-6788
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-6788
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 1.10.9
>         Environment: RHEL 8
>            Reporter: DevLocalCA
>            Priority: Major
>
>  
> *The installation instructions for Airflow using Postgres as a backend are 
> fkced.*
> The Apache Airflow documentation is not clear on how to get Airflow installed 
> and configured with Postgres as a backend.
>  
> ----
> I installed with:
> {code:java}
> pip install apache-airflow[postgres]{code}
> *now what?*
> The installation instructions have a link to *"Initializing a Database 
> Bakend"*
> *I click there.*
> *It has this line:*
> {code:java}
> If you decide to use Postgres, we recommend using the psycopg2 driver and 
> specifying it in your SqlAlchemy connection string.{code}
> OK, so I `pip install psychopg2', is this enough to satisfy the 
> recommendation of using the 'psycopg2' driver?
> *And so now where is my 'SqlAlchemy connection string'? Where is the 
> SqlAlchemy string located? what file? I don't see any files anywhere.*
> ----
>  
> *Now it says:*
> {code:java}
> Also note that since SqlAlchemy does not expose a way to target a specific 
> schema in the Postgres connection URI, you may want to set a default schema 
> for your role with a command similar to ALTER ROLE username SET search_path = 
> airflow, foobar;{code}
> *What the hell does this mean?*
> Does this mean I am to create a role/username for Airflow/SqlAlchemy to use?
> And if so what would be a good username? ( 'airflow' ? )
> ----
> *And Where do I set the Postgres connection URI and exactly what would the 
> syntax be?*
> The installation instructions seem to be suggestions in using the word *"may 
> want to"*, and then gives no specifics on how to follow those suggestions.
> ----
> I don't think install instructions should use wordings that indicate 
> suggestions, I simply want step by step instructions on how to get this 
> working.
> ----
> *It then says:*
> Once you've setup your database to host Airflow
>  
> *wait, wait, wait, how did I setup my database to host Airflow? What did I do 
> there that achieved that goal?*
> ---
> *then it says:*
> {code:java}
> you'll need to alter the SqlAlchemy connection string located in your 
> configuration file $AIRFLOW_HOME/airflow.cfg{code}
> *I don't see an airflow.cfg anywhere - it's no where to be found.*
> ----
> *It then says:*
> {code:java}
> You should then also change the "executor" setting to use "LocalExecutor", an 
> executor that can parallelize task instances locally.{code}
> *WTF does that mean?*
> ----
> At this point it says:
> {code:java}
> # initialize the database
>  airflow initdb{code}
> so Jesus Christ, I don't think I should run that at this point because I have 
> no goddamn idea what the previous instructions were talking about.
> ----
> If what should be very simple documentation is this bad, I can't imagine what 
> the code looks like.
> ----
> I'm not liking this project already and think that open source is not for me.
> I would rather pay for something where someone comes in daily and gets paid 
> to write clear concise documentation.
> I would save money by paying for a commercial product with the future 
> headaches I perceive with this Airflow project.
> ----
> Everyone take a fking month off and review your documentation, the slack 
> channel and other support channels are crammed full of confused people.
> ----
> Can the airflow team please recruit someone that has at least a 10th grade 
> level in writing skills?
> 'documentation' is not even in the 'components' list on Jira, so I can see 
> how important it is to the team.
> Jesus Fucking Christ



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to