flytekit.remote.remote.Options

class flytekit.remote.remote.Options(labels=None, annotations=None, raw_output_data_config=None, security_context=None, max_parallelism=None, notifications=None, disable_notifications=None, overwrite_cache=None)[source]

These are options that can be configured for a launchplan during registration or overridden during an execution. For instance two people may want to run the same workflow but have the offloaded data stored in two different buckets. Or you may want labels or annotations to be different. This object is used when launching an execution in a Flyte backend, and also when registering launch plans.

Parameters:

  • labels (Labels | None) – Custom labels to be applied to the execution resource

  • annotations (Annotations | None) – Custom annotations to be applied to the execution resource

  • security_context (SecurityContext | None) – Indicates security context for permissions triggered with this launch plan

  • raw_output_data_config (RawOutputDataConfig | None) – Optional location of offloaded data for things like S3, etc. remote prefix for storage location of the form s3://<bucket>/key... or gcs://... or file://.... If not specified will use the platform configured default. This is where the data for offloaded types is stored.

  • max_parallelism (int | None) – Controls the maximum number of tasknodes that can be run in parallel for the entire workflow.

  • notifications (List[Notification] | None) – List of notifications for this execution.

  • disable_notifications (bool | None) – This should be set to true if all notifications are intended to be disabled for this execution.

  • overwrite_cache (bool | None)

Methods

classmethod default_from(k8s_service_account=None, raw_data_prefix=None)[source]
Parameters:

  • k8s_service_account (str | None)

  • raw_data_prefix (str | None)

Return type:

Options

Attributes

annotations: Annotations | None = None
disable_notifications: bool | None = None
labels: Labels | None = None
max_parallelism: int | None = None
notifications: List[Notification] | None = None
overwrite_cache: bool | None = None
raw_output_data_config: RawOutputDataConfig | None = None
security_context: SecurityContext | None = None