Source code for kfp.kubernetes.secret

# Copyright 2023 The Kubeflow Authors
#
# Licensed 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.

from typing import Dict

from google.protobuf import json_format
from kfp.dsl import PipelineTask
from kfp.kubernetes import common
from kfp.kubernetes import kubernetes_executor_config_pb2 as pb


[docs]def use_secret_as_env(
    task: PipelineTask,
    secret_name: str,
    secret_key_to_env: Dict[str, str],
) -> PipelineTask:
    """Use a Kubernetes Secret as an environment variable as described by the `Kubernetes documentation
    https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-environment-variables `_.

    Args:
        task: Pipeline task.
        secret_name: Name of the Secret.
        secret_key_to_env: Dictionary of Secret data key to environment variable name. For example, ``{'password': 'PASSWORD'}`` sets the data of the Secret's password field to the environment variable ``PASSWORD``.

    Returns:
        Task object with updated secret configuration.
    """

    msg = common.get_existing_kubernetes_config_as_message(task)

    key_to_env = [
        pb.SecretAsEnv.SecretKeyToEnvMap(
            secret_key=secret_key,
            env_var=env_var,
        ) for secret_key, env_var in secret_key_to_env.items()
    ]
    secret_as_env = pb.SecretAsEnv(
        secret_name=secret_name,
        key_to_env=key_to_env,
    )

    msg.secret_as_env.append(secret_as_env)

    task.platform_config['kubernetes'] = json_format.MessageToDict(msg)

    return task


[docs]def use_secret_as_volume(
    task: PipelineTask,
    secret_name: str,
    mount_path: str,
    optional: bool = False,
) -> PipelineTask:
    """Use a Kubernetes Secret by mounting its data to the task's container as
    described by the `Kubernetes documentation <https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod>`_.

    Args:
        task: Pipeline task.
        secret_name: Name of the Secret.
        mount_path: Path to which to mount the Secret data.
        optional: Optional field specifying whether the Secret must be defined.

    Returns:
        Task object with updated secret configuration.
    """

    msg = common.get_existing_kubernetes_config_as_message(task)

    secret_as_vol = pb.SecretAsVolume(
        secret_name=secret_name,
        mount_path=mount_path,
        optional=optional,
    )

    msg.secret_as_volume.append(secret_as_vol)

    task.platform_config['kubernetes'] = json_format.MessageToDict(msg)

    return task