sethvargo commented on a change in pull request #7795: URL: https://github.com/apache/airflow/pull/7795#discussion_r421850039
########## File path: airflow/providers/google/cloud/secrets/secrets_manager.py ########## @@ -0,0 +1,132 @@ +# 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. + +""" +Objects relating to sourcing connections from GCP Secrets Manager +""" +from typing import List, Optional + +from cached_property import cached_property +from google.api_core.exceptions import NotFound +from google.api_core.gapic_v1.client_info import ClientInfo +from google.cloud.secretmanager_v1 import SecretManagerServiceClient + +from airflow import version +from airflow.models import Connection +from airflow.providers.google.cloud.utils.credentials_provider import ( + _get_scopes, get_credentials_and_project_id, +) +from airflow.secrets import BaseSecretsBackend +from airflow.utils.log.logging_mixin import LoggingMixin + + +class CloudSecretsManagerSecretsBackend(BaseSecretsBackend, LoggingMixin): + """ + Retrieves Connection object from GCP Secrets Manager + + Configurable via ``airflow.cfg`` as follows: + + .. code-block:: ini + + [secrets] + backend = airflow.providers.google.cloud.secrets.secrets_manager.CloudSecretsManagerSecretsBackend + backend_kwargs = {"connections_prefix": "airflow/connections"} + + For example, if secret id is ``airflow/connections/smtp_default``, this would be accessible + if you provide ``{"connections_prefix": "airflow/connections"}`` and request conn_id ``smtp_default``. + + :param connections_prefix: Specifies the prefix of the secret to read to get Connections. + :type connections_prefix: str + :param gcp_key_path: Path to GCP Credential JSON file; + use default credentials in the current environment if not provided. + :type gcp_key_path: str + :param gcp_scopes: Comma-separated string containing GCP scopes + :type gcp_scopes: str + """ + def __init__( + self, + connections_prefix: str = "airflow/connections", + gcp_key_path: Optional[str] = None, + gcp_scopes: Optional[str] = None, + **kwargs + ): + self.connections_prefix = connections_prefix.rstrip("/") + self.gcp_key_path = gcp_key_path + self.gcp_scopes = gcp_scopes + self.credentials: Optional[str] = None + self.project_id: Optional[str] = None + super().__init__(**kwargs) + + @cached_property + def client(self) -> SecretManagerServiceClient: + """ + Create an authenticated KMS client + """ + scopes = _get_scopes(self.gcp_scopes) + self.credentials, self.project_id = get_credentials_and_project_id( + key_path=self.gcp_key_path, + scopes=scopes + ) + _client = SecretManagerServiceClient( + credentials=self.credentials, + client_info=ClientInfo(client_library_version='airflow_v' + version.version) + ) + return _client + + def build_secret_id(self, conn_id: str) -> str: + """ + Given conn_id, build path for Secrets Manager + + :param conn_id: connection id + :type conn_id: str + """ + secret_id = f"{self.connections_prefix}/{conn_id}" + return secret_id + + def get_conn_uri(self, conn_id: str) -> Optional[str]: + """ + Get secret value from Secrets Manager. + + :param conn_id: connection id + :type conn_id: str + """ + secret_id = self.build_secret_id(conn_id=conn_id) + # always return the latest version of the secret + secret_version = "latest" Review comment: Hey @kaxil - [here's the protocol](https://github.com/spring-cloud/spring-cloud-gcp/pull/2302) we'd like most integrators to try and align on. Latest is a floating alias that resolves to "the highest numbered secret version" for the secret. Often times, the team creating the secret is separate from the team consuming the secret. In these cases, the latest version may not be active or usable yet. Generally, you want a workload to be coupled to a specific secret so you can roll forward and roll backward in the event something breaks. It's fine to allow users to _specify_ latest, but I don't think it should be the default behavior. You can see how we recommend specifying the format in the linked issue above. ---------------------------------------------------------------- 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]
