mik-laj commented on a change in pull request #10172: URL: https://github.com/apache/airflow/pull/10172#discussion_r466328531
########## File path: docs/howto/use-alternative-secrets-backend.rst ########## @@ -383,48 +383,75 @@ Note that the secret ``Key`` is ``value``, and secret ``Value`` is ``world`` and .. _secret_manager_backend: -GCP Secret Manager Backend -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Google Cloud Secret Manager Backend +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -To enable GCP Secrets Manager to retrieve connection/variables, specify :py:class:`~airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend` -as the ``backend`` in ``[secrets]`` section of ``airflow.cfg``. +This topic describes how to configure Airflow to use `Secret Manager <https://cloud.google.com/secret-manager/docs>`__ as +a secret bakcned and how to manage secrets. -Available parameters to ``backend_kwargs``: +Before you begin +"""""""""""""""" -* ``connections_prefix``: Specifies the prefix of the secret to read to get Connections. -* ``variables_prefix``: Specifies the prefix of the secret to read to get Variables. -* ``gcp_key_path``: Path to GCP Credential JSON file -* ``gcp_scopes``: Comma-separated string containing GCP scopes -* ``sep``: separator used to concatenate connections_prefix and conn_id. Default: "-" +`Configure Secret Manager and your local environment <https://cloud.google.com/secret-manager/docs/configuring-secret-manager>`__, once per project. -Note: The full GCP Secrets Manager secret id should follow the pattern "[a-zA-Z0-9-_]". +Enabling the secret backend +""""""""""""""""""""""""""" -Here is a sample configuration if you want to just retrieve connections: +To enable the secret backend for Google Cloud Secrets Manager to retrieve connection/variables, +specify :py:class:`~airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend` Review comment: 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. ---------------------------------------------------------------- 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: [email protected]
