Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 20 additions & 2 deletions cloud_pipelines_backend/launchers/kubernetes_launchers.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ def _handle_secrets_after_preparing_pod(
pod: k8s_client_lib.V1Pod,
secret_name_to_secret_value: dict[str, str],
secret_env_name_to_secret_name: dict[str, str],
secret_env_vars_consumed_as_value: set[str],
annotations: dict[str, Any] | None = None,
) -> k8s_client_lib.V1Secret | None:
if not secret_name_to_secret_value or not secret_env_name_to_secret_name:
Expand All @@ -323,10 +324,9 @@ def _handle_secrets_after_preparing_pod(
for container in pod.spec.containers
if container.name == _MAIN_CONTAINER_NAME
)
command_line = (main_container.command or []) + (main_container.args or [])
for env_var_name in secret_env_name_to_secret_name:
# An input consumed as a file reads the Secret volume, not the environment.
if not any(f"$({env_var_name})" in part for part in command_line):
if env_var_name not in secret_env_vars_consumed_as_value:
continue
main_container.env = main_container.env or []
main_container.env.append(
Expand Down Expand Up @@ -390,6 +390,8 @@ def _prepare_kubernetes_pod(
pod_labels: dict[str, str] | None = None,
pod_annotations: dict[str, str] | None = None,
pod_service_account: str | None = None,
# Filled with the env var names of the secret inputs consumed as values.
secret_env_vars_consumed_as_value: set[str],
) -> k8s_client_lib.V1Pod:
if not isinstance(
component_spec.implementation, structures.ContainerImplementation
Expand All @@ -411,6 +413,16 @@ def _prepare_kubernetes_pod(
# They also upload/download artifact data when needed.
def get_input_value(input_name: str) -> str:
input_argument = input_arguments[input_name]
if (
input_argument.dynamic_data
and container_component_utils.parse_dynamic_data_argument(
input_argument.dynamic_data
)[0]
== _DYNAMIC_DATA_SECRET_KEY
):
secret_env_vars_consumed_as_value.add(
_secret_env_var_name(input_name=input_name)
)
if input_argument.is_dir:
raise interfaces.LauncherError(
f"Cannot consume directory as value. {input_name=}, {input_argument=}"
Expand Down Expand Up @@ -760,6 +772,7 @@ def launch_container_task(
)
input_argument.value = dynamic_data_value

secret_env_vars_consumed_as_value: set[str] = set()
pod = self._prepare_kubernetes_pod(
component_spec=component_spec,
input_arguments=input_arguments,
Expand All @@ -771,6 +784,7 @@ def launch_container_task(
pod_labels=self._pod_labels,
pod_annotations=self._pod_annotations,
pod_service_account=self._service_account_name,
secret_env_vars_consumed_as_value=secret_env_vars_consumed_as_value,
)

# Applying the pod post-processor
Expand All @@ -782,6 +796,7 @@ def launch_container_task(
pod=pod,
secret_name_to_secret_value=secret_name_to_secret_value,
secret_env_name_to_secret_name=secret_env_name_to_secret_name,
secret_env_vars_consumed_as_value=secret_env_vars_consumed_as_value,
annotations=annotations,
)

Expand Down Expand Up @@ -1458,6 +1473,7 @@ def launch_container_task(
)
input_argument.value = dynamic_data_value

secret_env_vars_consumed_as_value: set[str] = set()
pod = self._prepare_kubernetes_pod(
component_spec=component_spec,
input_arguments=input_arguments,
Expand All @@ -1469,6 +1485,7 @@ def launch_container_task(
pod_labels=self._pod_labels,
pod_annotations=self._pod_annotations,
pod_service_account=self._service_account_name,
secret_env_vars_consumed_as_value=secret_env_vars_consumed_as_value,
)

# Applying the pod post-processor
Expand All @@ -1483,6 +1500,7 @@ def launch_container_task(
pod=pod,
secret_name_to_secret_value=secret_name_to_secret_value,
secret_env_name_to_secret_name=secret_env_name_to_secret_name,
secret_env_vars_consumed_as_value=secret_env_vars_consumed_as_value,
annotations=annotations,
)

Expand Down
51 changes: 42 additions & 9 deletions tests/launchers/kubernetes/test_kubernetes_secrets.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ def _launch(
pod=pod,
secret_name_to_secret_value=values,
secret_env_name_to_secret_name=env_names,
secret_env_vars_consumed_as_value=set(env_names),
annotations=annotations,
)
return pod
Expand Down Expand Up @@ -244,6 +245,7 @@ def test_secret_carries_the_plain_value_in_string_data() -> None:
pod=_make_pod(args=[]),
secret_name_to_secret_value={"hf-token": _SECRET_VALUE},
secret_env_name_to_secret_name={"__TANGLE_SECRET_TOKEN": "hf-token"},
secret_env_vars_consumed_as_value=set(),
)

assert secret.string_data == {"__TANGLE_SECRET_TOKEN": _SECRET_VALUE}
Expand All @@ -260,6 +262,7 @@ def test_environment_entry_goes_to_the_main_container_not_the_first() -> None:
pod=pod,
secret_name_to_secret_value={"hf-token": _SECRET_VALUE},
secret_env_name_to_secret_name={"__TANGLE_SECRET_TOKEN": "hf-token"},
secret_env_vars_consumed_as_value={"__TANGLE_SECRET_TOKEN"},
annotations=None,
)

Expand All @@ -268,18 +271,47 @@ def test_environment_entry_goes_to_the_main_container_not_the_first() -> None:
assert [env.name for env in main.env] == ["__TANGLE_SECRET_TOKEN"]


@pytest.mark.usefixtures("secrets_api")
def test_placeholder_in_the_command_gets_its_environment_entry() -> None:
pod = _make_pod(args=[])
pod.spec.containers[0].command = ["$(__TANGLE_SECRET_TOKEN)"]
def test_plain_input_holding_the_placeholder_text_gets_no_environment_entry(
secrets_api: _SecretsApi, tmp_path: pathlib.Path
) -> None:
# The secret is consumed as a file; another input happens to hold its placeholder text.
note = interfaces.InputArgument(
total_size=len("$(__TANGLE_SECRET_TOKEN)"),
is_dir=False,
value="$(__TANGLE_SECRET_TOKEN)",
staging_uri="gs://bucket/note",
)
launcher = kubernetes_launchers.KubernetesWithHostPathContainerLauncher(
api_client=k8s_client_lib.ApiClient()
)

_make_launcher()._handle_secrets_after_preparing_pod(
pod=pod,
secret_name_to_secret_value={"hf-token": _SECRET_VALUE},
secret_env_name_to_secret_name={"__TANGLE_SECRET_TOKEN": "hf-token"},
launcher.launch_container_task(
component_spec=structures.ComponentSpec(
name="test",
inputs=[
structures.InputSpec(name="token"),
structures.InputSpec(name="note"),
],
implementation=structures.ContainerImplementation(
container=structures.ContainerSpec(
image="alpine",
args=[
structures.InputPathPlaceholder(input_name="token"),
structures.InputValuePlaceholder(input_name="note"),
],
)
),
),
input_arguments={"token": _make_secret_argument(), "note": note},
output_uris={},
log_uri=str(tmp_path / "log.txt"),
annotations=_EXECUTION_123,
)

assert [env.name for env in pod.spec.containers[0].env] == ["__TANGLE_SECRET_TOKEN"]
[pod] = secrets_api.created_pods
[main] = pod.spec.containers
assert main.args == ["/tmp/inputs/token/data", "$(__TANGLE_SECRET_TOKEN)"]
assert "__TANGLE_SECRET_TOKEN" not in [env.name for env in main.env or []]


_JOB_LAUNCHER: Final = (
Expand Down Expand Up @@ -423,6 +455,7 @@ def test_secret_is_keyed_by_the_env_var_name_so_any_secret_name_works() -> None:
pod=pod,
secret_name_to_secret_value=values,
secret_env_name_to_secret_name=env_names,
secret_env_vars_consumed_as_value=set(env_names),
)

assert secret.string_data == {"__TANGLE_SECRET_TOKEN": _SECRET_VALUE}
Expand Down