You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2021/09/11 19:10:56 UTC
[airflow] branch main updated: Separate Installing from sources
section and add more details (#18171)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new f9969c1 Separate Installing from sources section and add more details (#18171)
f9969c1 is described below
commit f9969c1650252075816b2b8d0f1596d407a7aca3
Author: Kaxil Naik <ka...@gmail.com>
AuthorDate: Sat Sep 11 20:10:34 2021 +0100
Separate Installing from sources section and add more details (#18171)
This PR separate installing Airflow from sources section and also fixes links for binary source, it had `-bin` suffix which we don't use anymore. And I have added section on verifying integrity. And add more details with examples
---
docs/apache-airflow/index.rst | 1 +
docs/apache-airflow/installation.rst | 17 ----
docs/apache-airflow/installing-from-sources.rst | 114 ++++++++++++++++++++++++
3 files changed, 115 insertions(+), 17 deletions(-)
diff --git a/docs/apache-airflow/index.rst b/docs/apache-airflow/index.rst
index 6853a03..c0b4d8b 100644
--- a/docs/apache-airflow/index.rst
+++ b/docs/apache-airflow/index.rst
@@ -78,6 +78,7 @@ unit of work and continuity.
license
start/index
installation
+ installing-from-sources
upgrading-to-2
upgrade-check
tutorial
diff --git a/docs/apache-airflow/installation.rst b/docs/apache-airflow/installation.rst
index f857f93..88da62e 100644
--- a/docs/apache-airflow/installation.rst
+++ b/docs/apache-airflow/installation.rst
@@ -311,23 +311,6 @@ They are based on the official release schedule of Python and Kubernetes, nicely
make them work in our CI pipeline (which might not be immediate due to dependencies catching up with
new versions of Python mostly) we release a new images/support in Airflow based on the working CI setup.
-Installing Airflow From Released Sources and packages
-'''''''''''''''''''''''''''''''''''''''''''''''''''''
-
-You can also install Airflow using the official sources and packages. Those sources and packages
-released are the "official" sources of installation that you can use if you want to verify the
-origin of the packages and want to verify checksums and signatures of the packages.
-
-The packages are available at the
-`Official Apache Software Foundations Downloads page <https://downloads.apache.org/airflow/>`_
-
-The |version| downloads are available at:
-
-* `Apache Airflow |version| sdist package <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-bin.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-bin.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-bin.tar.gz.sha512>`__)
-* `Apache Airflow |version| wheel package <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl.sha512>`__)
-* `Apache Airflow |version| sources <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz.sha512>`__)
-
-
Set up a database
'''''''''''''''''
diff --git a/docs/apache-airflow/installing-from-sources.rst b/docs/apache-airflow/installing-from-sources.rst
new file mode 100644
index 0000000..d555910
--- /dev/null
+++ b/docs/apache-airflow/installing-from-sources.rst
@@ -0,0 +1,114 @@
+ .. 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.
+
+
+Installing from Sources
+-----------------------
+
+.. contents:: :local:
+
+
+Installing Airflow from released sources and packages
+'''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+You can also install Airflow using the official sources and packages. Those sources and packages
+released are the "official" sources of installation that you can use if you want to verify the
+origin of the packages and want to verify checksums and signatures of the packages.
+
+The packages are available at the
+`Official Apache Software Foundations Downloads page <https://downloads.apache.org/airflow/>`_
+
+The |version| downloads are available at:
+
+* `Apache Airflow |version| sdist package <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|.tar.gz.sha512>`__)
+* `Apache Airflow |version| wheel package <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache_airflow-|version|-py3-none-any.whl.sha512>`__)
+* `Apache Airflow |version| sources <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/|version|/apache-airflow-|version|-source.tar.gz.sha512>`__)
+
+If you want to install from the source code, you can download from the sources link above, it will contain
+a ``INSTALL`` file containing details on how you can build and install Airflow.
+
+Release integrity & Verification of releases
+''''''''''''''''''''''''''''''''''''''''''''
+
+`PGP signatures KEYS <https://downloads.apache.org/airflow/KEYS>`_
+
+It is essential that you verify the integrity of the downloaded files using the PGP or SHA signatures.
+The PGP signatures can be verified using GPG or PGP. Please download the KEYS as well as the asc
+signature files for relevant distribution. It is recommended to get these files from the
+main distribution directory and not from the mirrors.
+
+.. code-block:: bash
+
+ gpg -i KEYS
+
+ or
+
+ pgpk -a KEYS
+
+ or
+
+ pgp -ka KEYS
+
+To verify the binaries/sources you can download the relevant asc files for it from main
+distribution directory and follow the below guide.
+
+.. code-block:: bash
+
+ gpg --verify apache-airflow-********.asc apache-airflow-*********
+
+ or
+
+ pgpv apache-airflow-********.asc
+
+ or
+
+ pgp apache-airflow-********.asc
+
+Example:
+
+.. code-block:: console
+ :substitutions:
+
+ $ gpg --verify apache-airflow-|version|-source.tar.gz.asc apache-airflow-|version|-source.tar.gz
+ gpg: Signature made Sat 11 Sep 12:49:54 2021 BST
+ gpg: using RSA key CDE15C6E4D3A8EC4ECF4BA4B6674E08AD7DE406F
+ gpg: issuer "kaxilnaik@apache.org"
+ gpg: Good signature from "Kaxil Naik <ka...@apache.org>" [unknown]
+ gpg: aka "Kaxil Naik <ka...@gmail.com>" [unknown]
+ gpg: WARNING: The key's User ID is not certified with a trusted signature!
+ gpg: There is no indication that the signature belongs to the owner.
+ Primary key fingerprint: CDE1 5C6E 4D3A 8EC4 ECF4 BA4B 6674 E08A D7DE 406F
+
+The "Good signature from ..." is indication that the signatures are correct.
+Do not worry about the "not certified with a trusted signature" warning. Most of the certificates used
+by release managers are self signed, that's why you get this warning. By importing the server in the
+previous step and importing it via ID from ``KEYS`` page, you know that this is a valid Key already.
+
+For SHA512 sum check, download the relevant ``sha512`` and run the following:
+
+.. code-block:: bash
+
+ shasum -a 512 apache-airflow--******** | diff - apache-airflow--********.sha512
+
+The ``SHASUM`` of the file should match the one provided in ``.sha512`` file.
+
+Example:
+
+.. code-block:: bash
+ :substitutions:
+
+ shasum -a 512 apache-airflow-|version|-source.tar.gz | diff - apache-airflow-|version|-source.tar.gz.sha512