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.

Sign up for GitHub

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

feat: add Yandex Cloud Lockbox secrets backend #36449

Merged
merged 4 commits into from
Jan 25, 2024
Merged

feat: add Yandex Cloud Lockbox secrets backend #36449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
744d69c
refactor: move credentials logic to utils
ImpressionableRaccoon Jan 15, 2024
21a61aa
docs: using metadata service in Yandex.Cloud Connection
ImpressionableRaccoon Jan 10, 2024
7c88d26
feat: Yandex Cloud Lockbox Secret Backend
ImpressionableRaccoon Jan 15, 2024
2622b59
docs: Yandex LockboxSecretBackend
ImpressionableRaccoon Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 40 additions & 82 deletions airflow/providers/yandex/hooks/yandex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,37 @@
# under the License.
from __future__ import annotations

import json
import warnings
from typing import Any

import yandexcloud

from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning
from airflow.exceptions import AirflowProviderDeprecationWarning
from airflow.hooks.base import BaseHook
from airflow.providers.yandex.utils.credentials import (
get_credentials,
get_service_account_id,
)
from airflow.providers.yandex.utils.defaults import conn_name_attr, conn_type, default_conn_name, hook_name
from airflow.providers.yandex.utils.fields import get_field_from_extras
from airflow.providers.yandex.utils.user_agent import provider_user_agent


class YandexCloudBaseHook(BaseHook):
"""
A base hook for Yandex.Cloud related tasks.

:param yandex_conn_id: The connection ID to use when fetching connection info.
:param yandex_conn_id: The connection ID to use when fetching connection info
:param connection_id: Deprecated, use yandex_conn_id instead
:param default_folder_id: The folder ID to use instead of connection folder ID
:param default_public_ssh_key: The key to use instead of connection key
:param default_service_account_id: The service account ID to use instead of key service account ID
"""

conn_name_attr = "yandex_conn_id"
default_conn_name = "yandexcloud_default"
conn_type = "yandexcloud"
hook_name = "Yandex Cloud"
conn_name_attr = conn_name_attr
default_conn_name = default_conn_name
conn_type = conn_type
hook_name = hook_name

@classmethod
def get_connection_form_widgets(cls) -> dict[str, Any]:
Expand All @@ -50,14 +60,14 @@ def get_connection_form_widgets(cls) -> dict[str, Any]:
lazy_gettext("Service account auth JSON"),
widget=BS3PasswordFieldWidget(),
description="Service account auth JSON. Looks like "
'{"id", "...", "service_account_id": "...", "private_key": "..."}. '
'{"id": "...", "service_account_id": "...", "private_key": "..."}. '
"Will be used instead of OAuth token and SA JSON file path field if specified.",
),
"service_account_json_path": StringField(
lazy_gettext("Service account auth JSON file path"),
widget=BS3TextFieldWidget(),
description="Service account auth JSON file path. File content looks like "
'{"id", "...", "service_account_id": "...", "private_key": "..."}. '
'{"id": "...", "service_account_id": "...", "private_key": "..."}. '
"Will be used instead of OAuth token if specified.",
),
"oauth": PasswordField(
Expand All @@ -75,7 +85,7 @@ def get_connection_form_widgets(cls) -> dict[str, Any]:
"public_ssh_key": StringField(
lazy_gettext("Public SSH key"),
widget=BS3TextFieldWidget(),
description="Optional. This key will be placed to all created Compute nodes"
description="Optional. This key will be placed to all created Compute nodes "
"to let you have a root shell there",
),
"endpoint": StringField(
Expand All @@ -87,30 +97,13 @@ def get_connection_form_widgets(cls) -> dict[str, Any]:

@classmethod
def provider_user_agent(cls) -> str | None:
"""Construct User-Agent from Airflow core & provider package versions."""
from airflow import __version__ as airflow_version
from airflow.configuration import conf
from airflow.providers_manager import ProvidersManager

try:
manager = ProvidersManager()
provider_name = manager.hooks[cls.conn_type].package_name # type: ignore[union-attr]
provider = manager.providers[provider_name]
return " ".join(
(
conf.get("yandex", "sdk_user_agent_prefix", fallback=""),
f"apache-airflow/{airflow_version}",
f"{provider_name}/{provider.version}",
)
).strip()
except KeyError:
warnings.warn(
f"Hook '{cls.hook_name}' info is not initialized in airflow.ProviderManager",
UserWarning,
stacklevel=2,
)

return None
warnings.warn(
"Using `provider_user_agent` in `YandexCloudBaseHook` is deprecated. "
"Please use it in `utils.user_agent` instead.",
AirflowProviderDeprecationWarning,
stacklevel=2,
)
return provider_user_agent()

@classmethod
def get_ui_field_behaviour(cls) -> dict[str, Any]:
Expand All @@ -122,7 +115,7 @@ def get_ui_field_behaviour(cls) -> dict[str, Any]:

def __init__(
self,
# Connection id is deprecated. Use yandex_conn_id instead
# connection_id is deprecated, use yandex_conn_id instead
connection_id: str | None = None,
yandex_conn_id: str | None = None,
default_folder_id: str | None = None,
Expand All @@ -137,46 +130,23 @@ def __init__(
AirflowProviderDeprecationWarning,
stacklevel=2,
)
self.connection_id = yandex_conn_id or connection_id or self.default_conn_name
self.connection_id = yandex_conn_id or connection_id or default_conn_name
self.connection = self.get_connection(self.connection_id)
self.extras = self.connection.extra_dejson
credentials = self._get_credentials()
credentials = get_credentials(
oauth_token=self._get_field("oauth"),
service_account_json=self._get_field("service_account_json"),
service_account_json_path=self._get_field("service_account_json_path"),
)
sdk_config = self._get_endpoint()
self.sdk = yandexcloud.SDK(user_agent=self.provider_user_agent(), **sdk_config, **credentials)
self.sdk = yandexcloud.SDK(user_agent=provider_user_agent(), **sdk_config, **credentials)
self.default_folder_id = default_folder_id or self._get_field("folder_id")
self.default_public_ssh_key = default_public_ssh_key or self._get_field("public_ssh_key")
self.default_service_account_id = default_service_account_id or self._get_service_account_id()
self.client = self.sdk.client

def _get_service_account_key(self) -> dict[str, str] | None:
service_account_json = self._get_field("service_account_json")
service_account_json_path = self._get_field("service_account_json_path")
if service_account_json_path:
with open(service_account_json_path) as infile:
service_account_json = infile.read()
if service_account_json:
return json.loads(service_account_json)
return None

def _get_service_account_id(self) -> str | None:
sa_key = self._get_service_account_key()
if sa_key:
return sa_key.get("service_account_id")
return None

def _get_credentials(self) -> dict[str, Any]:
oauth_token = self._get_field("oauth")
if oauth_token:
return {"token": oauth_token}

service_account_key = self._get_service_account_key()
if service_account_key:
return {"service_account_key": service_account_key}

raise AirflowException(
"No credentials are found in connection. Specify either service account "
"authentication JSON or user OAuth token in Yandex.Cloud connection"
self.default_service_account_id = default_service_account_id or get_service_account_id(
service_account_json=self._get_field("service_account_json"),
service_account_json_path=self._get_field("service_account_json_path"),
)
self.client = self.sdk.client

def _get_endpoint(self) -> dict[str, str]:
sdk_config = {}
Expand All @@ -186,18 +156,6 @@ def _get_endpoint(self) -> dict[str, str]:
return sdk_config

def _get_field(self, field_name: str, default: Any = None) -> Any:
"""Get field from extra, first checking short name, then for backcompat we check for prefixed name."""
if not hasattr(self, "extras"):
return default
backcompat_prefix = "extra__yandexcloud__"
if field_name.startswith("extra__"):
raise ValueError(
f"Got prefixed name {field_name}; please remove the '{backcompat_prefix}' prefix "
"when using this method."
)
if field_name in self.extras:
return self.extras[field_name]
prefixed_name = f"{backcompat_prefix}{field_name}"
if prefixed_name in self.extras:
return self.extras[prefixed_name]
return default
return get_field_from_extras(self.extras, field_name, default)
16 changes: 16 additions & 0 deletions airflow/providers/yandex/secrets/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 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.
Loading