Skip to content

Update guide for Google Cloud Secret Manager Backend #10172

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

Merged
merged 7 commits into from
Aug 6, 2020
Merged
Prev Previous commit
Next Next commit
fixup! Update guide for Google Cloud Secret Manager Backend
  • Loading branch information
Kamil Breguła committed Aug 5, 2020
commit 90b96701d66bca77332edfa0c6e967d68f9aae3d
8 changes: 4 additions & 4 deletions docs/howto/use-alternative-secrets-backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,8 @@ Before you begin

`Configure Secret Manager and your local environment <https://cloud.google.com/secret-manager/docs/configuring-secret-manager>`__, once per project.

Configure Airflow
"""""""""""""""""
Enabling the secret backend
"""""""""""""""""""""""""""

To enable `Google Cloud Secrets Manager <https://cloud.google.com/secret-manager/docs>`__ to retrieve connection/variables,
specify :py:class:`~airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend`
Copy link
Contributor

Choose a reason for hiding this comment

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

This requires installing backport-operators. Maybe it's worth to mention that?

Copy link
Member Author

Choose a reason for hiding this comment

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

Unfortunately, this is documentation for Airflow 2.0 where these packages don't work. We don't have documentation for Airflow 1.10 with backport packages.

Copy link
Member

Choose a reason for hiding this comment

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

Backport Packages have their own documentation - - and I already have a mechanism to incorpoare some extra information in it - I will extract some of the useful GCP guides ther with the next wave of backport packages.

The documentation is here: https://github.com/apache/airflow/tree/master/airflow/providers/google

And when released it can be found in PyPI https://pypi.org/project/apache-airflow-backport-providers-google/2020.6.24/

Expand Down Expand Up @@ -450,8 +450,8 @@ Set-up credentials
You can configure the credentiaps in three ways:
Copy link
Contributor

Choose a reason for hiding this comment

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

typo : credentiaps


* By default, Application Default Credentials (ADC) is used obtain credentials.
* ``gcp_key_path`` option in ``backend_kwargs``. Allows you to configure authorizations with a service account stored in local file.
* ``gcp_keyfile_dict`` option in ``backend_kwargs``. Allows you to configure authorizations with a service account stored in Airflow configuration.
* ``gcp_key_path`` option in ``backend_kwargs`` option - allows you to configure authorizations with a service account stored in local file.
* ``gcp_keyfile_dict`` option in ``backend_kwargs` option` - allows you to configure authorizations with a service account stored in Airflow configuration.

.. note::

Expand Down