flytekit.extend.ImageConfig#

class flytekit.extend.ImageConfig(default_image=None, images=None)[source]#

ImageConfig holds available images which can be used at registration time. A default image can be specified along with optional additional images. Each image in the config must have a unique name.

Parameters
Return type

None

default_image#

The default image to be used as a container for task serialization.

Type

str

images#

Optional, additional images which can be used in task container definitions.

Type

List[Image]

__init__(default_image=None, images=None)#
Parameters
Return type

None

Methods

__init__([default_image, images])

auto([config_file, img_name])

Reads from config file or from img_name Note that this function does not take into account the flytekit default images (see the Dockerfiles at the base of this repo).

auto_default_image()

create_from(default_image[, other_images])

find_image(name)

Return an image, by name, if it exists.

from_dict(kvs, *[, infer_missing])

from_images(default_image[, m])

Allows you to programmatically create an ImageConfig. Usually only the default_image is required, unless

from_json(s, *[, parse_float, parse_int, ...])

schema(*[, infer_missing, only, exclude, ...])

to_dict([encode_json])

to_json(*[, skipkeys, ensure_ascii, ...])

validate_image(_, param, values)

Validates the image to match the standard format. Also validates that only one default image is provided. a default image, is one that is specified as default=img or just img. All other images should be provided with a name, in the format name=img This method can be used with the CLI.

Attributes