Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements for database setup docs #13696

Merged
merged 6 commits into from
Jan 15, 2021
Merged

Conversation

mik-laj
Copy link
Member

@mik-laj mik-laj commented Jan 15, 2021

  • First of all, the previous version had a title that did not describe its content well. I corrected it which will make it easier to find this page.
  • I have added sections that describe the requirements for the supported database versions. Previously, there was only a link to HA requirements, but no description for the basic configuration.
  • I have moved the sections on database URI to the top of this document as this knowledge is needed in the following sections.
  • I have created separate sections for MySQL and PostgreSQL because users who use MySQL are not interested in the information for PostgresSQL and vice versa. This also allowed us to delete various blocks of notes that were difficult to format and read.

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

@mik-laj mik-laj requested a review from kaxil January 15, 2021 13:49
@mik-laj mik-laj changed the title Improvements for documentation on database setup Improvements for database setup docs Jan 15, 2021

The exact format description is described in the SQLAlchemy documentation, see `Database Urls <https://docs.sqlalchemy.org/en/14/core/engines.html>`__. We will also show you some examples below.

Set up a MySQL
Copy link
Member

@kaxil kaxil Jan 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Set up a MySQL
Set up MySQL

or

Suggested change
Set up a MySQL
Setting up a MySQL Database

Comment on lines 94 to 95
Set up a PostgreSQL
-------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Set up a PostgreSQL
-------------------
Set up a PostgreSQL Database
-----------------------------

or

Suggested change
Set up a PostgreSQL
-------------------
Set up PostgreSQL
-----------------------------

CREATE USER airflow_user WITH PASSWORD 'airflow_user';
GRANT ALL PRIVILEGES ON DATABASE airflow_db TO airflow_user;

You need to create a database and a user that Airflow will use to access this database.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You need to create a database and a user that Airflow will use to access this database.

already mentioned before the code-block

Copy link
Member

@kaxil kaxil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes suggested or else LGTM

@github-actions
Copy link

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Jan 15, 2021
@mik-laj
Copy link
Member Author

mik-laj commented Jan 15, 2021

@kaxil Updated. See: 1662aa0

@mik-laj mik-laj merged commit 8080929 into apache:master Jan 15, 2021
@mik-laj mik-laj deleted the db-docs branch January 15, 2021 23:21
kaxil pushed a commit that referenced this pull request Jan 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation okay to merge It's ok to merge this PR as it does not require more tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants