flytekit.image_spec.image_spec

Directory

Classes

Methods

Variables

Methods

validate_container_registry_name()

def validate_container_registry_name(
    name: str,
) -> bool

Validate Docker container registry name.

flytekit.image_spec.image_spec.ImageBuildEngine

ImageBuildEngine contains a list of builders that can be used to build an ImageSpec.

Methods

build()

def build(
    image_spec: flytekit.image_spec.image_spec.ImageSpec,
)

get_registry()

def get_registry()

register()

def register(
    builder_type: str,
    image_spec_builder: flytekit.image_spec.image_spec.ImageSpecBuilder,
    priority: int,
)

flytekit.image_spec.image_spec.ImageSpec

This class is used to specify the docker image that will be used to run the task.

Attributes: name (str): Name of the image. python_version (str): Python version of the image. Use default python in the base image if None. builder (Optional[str]): Type of plugin to build the image. Use envd by default. source_root (Optional[str]): Source root of the image. env (Optional[Dict[str, str]]): Environment variables of the image. registry (Optional[str]): Registry of the image. packages (Optional[List[str]]): List of python packages to install. conda_packages (Optional[List[str]]): List of conda packages to install. conda_channels (Optional[List[str]]): List of conda channels. requirements (Optional[str]): Path to the requirements.txt file. apt_packages (Optional[List[str]]): List of apt packages to install. cuda (Optional[str]): Version of cuda to install. cudnn (Optional[str]): Version of cudnn to install. base_image (Optional[Union[str, ‘ImageSpec’]]): Base image of the image. platform (Optional[str]): Specify the target platforms for the build output (for example, windows/amd64 or linux/amd64,darwin/arm64). pip_index (Optional[str]): Specify the custom pip index url. pip_extra_index_url (Optional[List[str]]): Specify one or more pip index urls as a list. pip_secret_mounts (Optional[List[Tuple[str, str]]]): Specify a list of tuples to mount secret for pip install. Each tuple should contain the path to the secret file and the mount path. For example, [(".gitconfig", “/etc/gitconfig”)]. This is experimental and the interface may change in the future. Configuring this should not change the built image. pip_extra_args (Optional[str]): Specify one or more extra pip install arguments as a space-delimited string. registry_config (Optional[str]): Specify the path to a JSON registry config file. entrypoint (Optional[List[str]]): List of strings to overwrite the entrypoint of the base image with, set to [] to remove the entrypoint. commands (Optional[List[str]]): Command to run during the building process. tag_format (Optional[str]): Custom string format for image tag. The ImageSpec hash passed in as spec_hash. For example, to add a “dev” suffix to the image tag, set tag_format="{spec_hash}-dev". source_copy_mode (Optional[CopyFileDetection]): This option allows the user to specify which source files to copy from the local host, into the image. Not setting this option means to use the default flytekit behavior. The default behavior is: - if fast register is used, source files are not copied into the image (because they’re already copied into the fast register tar layer). - if fast register is not used, then the LOADED_MODULES (aka ‘auto’) option is used to copy loaded Python files into the image. If the option is set by the user, then that option is of course used. copy (Optional[List[str]]): List of files/directories to copy to /root. e.g. [“src/file1.txt”, “src/file2.txt”]. python_exec (Optional[str]): Python executable to use for install packages. runtime_packages (Optional[List[str]]): List of packages to be installed during runtime. runtime_packages requires pip to be installed in your base image. - If you are using an ImageSpec as your base image, please include pip into your packages: ImageSpec(..., packages=["pip"]). - If you want to install runtime packages into a fixed base_image and not use an image builder, you can use builder="noop": ImageSpec(base_image="ghcr.io/name/my-custom-image", builder="noop").with_runtime_packages(["numpy"]). builder_options (Optional[Dict[str, Any]]): Additional options for the builder. This is a dictionary that will be passed to the builder. The options are builder-specific and may not be supported by all builders. builder_config (Optional[typing.Dict[str, typing.Any]]): Custom builder images configuration, such as uv and micromamba images.

class ImageSpec(
    name: str,
    python_version: str,
    builder: typing.Optional[str],
    source_root: typing.Optional[str],
    env: typing.Optional[typing.Dict[str, str]],
    registry: typing.Optional[str],
    packages: typing.Optional[typing.List[str]],
    conda_packages: typing.Optional[typing.List[str]],
    conda_channels: typing.Optional[typing.List[str]],
    requirements: typing.Optional[str],
    apt_packages: typing.Optional[typing.List[str]],
    cuda: typing.Optional[str],
    cudnn: typing.Optional[str],
    base_image: typing.Union[str, ForwardRef('ImageSpec'), NoneType],
    platform: typing.Optional[str],
    pip_index: typing.Optional[str],
    pip_extra_index_url: typing.Optional[typing.List[str]],
    pip_secret_mounts: typing.Optional[typing.List[typing.Tuple[str, str]]],
    pip_extra_args: typing.Optional[str],
    registry_config: typing.Optional[str],
    entrypoint: typing.Optional[typing.List[str]],
    commands: typing.Optional[typing.List[str]],
    tag_format: typing.Optional[str],
    source_copy_mode: typing.Optional[flytekit.constants.CopyFileDetection],
    copy: typing.Optional[typing.List[str]],
    python_exec: typing.Optional[str],
    runtime_packages: typing.Optional[typing.List[str]],
    builder_options: typing.Optional[typing.Dict[str, typing.Any]],
    builder_config: typing.Optional[typing.Dict[str, typing.Any]],
)

Methods

exist()

def exist()

Check if the image exists in the registry. Return True if the image exists in the registry, False otherwise. Return None if failed to check if the image exists due to the permission issue or other reasons.

force_push()

def force_push()

Builder that returns a new image spec with force push enabled.

from_env()

def from_env(
    pinned_packages: typing.Optional[typing.List[str]],
    kwargs,
) -> ImageSpec

Create ImageSpec with the environment’s Python version and packages pinned to the ones in the environment.

image_name()

def image_name()

Full image name with tag.

is_container()

def is_container()

Check if the current container image in the pod is built from current image spec. :return: True if the current container image in the pod is built from current image spec, False otherwise.

with_apt_packages()

def with_apt_packages(
    apt_packages: typing.Union[str, typing.List[str]],
) -> ImageSpec

Builder that returns a new image spec with an additional list of apt packages that will be executed during the building process.

with_builder_options()

def with_builder_options(
    builder_options: typing.Dict[str, typing.Any],
) -> ImageSpec

Builder that returns a new image spec with additional builder options.

with_commands()

def with_commands(
    commands: typing.Union[str, typing.List[str]],
) -> ImageSpec

Builder that returns a new image spec with an additional list of commands that will be executed during the building process.

with_copy()

def with_copy(
    src: typing.Union[str, typing.List[str]],
) -> ImageSpec

Builder that returns a new image spec with the source files copied to the destination directory.

with_packages()

def with_packages(
    packages: typing.Union[str, typing.List[str]],
) -> ImageSpec

Builder that returns a new image speck with additional python packages that will be installed during the building process.

with_runtime_packages()

def with_runtime_packages(
    runtime_packages: typing.List[str],
) -> ImageSpec

Builder that returns a new image spec with runtime packages. Dev packages will be installed during runtime.

flytekit.image_spec.image_spec.ImageSpecBuilder

Methods

build_image()

def build_image(
    image_spec: flytekit.image_spec.image_spec.ImageSpec,
) -> typing.Optional[str]

Build the docker image and push it to the registry.

should_build()

def should_build(
    image_spec: flytekit.image_spec.image_spec.ImageSpec,
) -> bool

Whether or not the builder should build the ImageSpec.