launch_plan.proto

flyteidl.admin.LaunchPlanCreateRequest

[flyteidl.admin.LaunchPlanCreateRequest proto]

Request to register a launch plan. A LaunchPlanSpec may include a complete or incomplete set of inputs required to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have created a launch plan.

{
  "id": "{...}",
  "spec": "{...}"
}
id

(flyteidl.core.Identifier) Uniquely identifies a launch plan entity.

spec

(flyteidl.admin.LaunchPlanSpec) User-provided launch plan details, including reference workflow, inputs and other metadata.

flyteidl.admin.LaunchPlanCreateResponse

[flyteidl.admin.LaunchPlanCreateResponse proto]

{}

flyteidl.admin.LaunchPlan

[flyteidl.admin.LaunchPlan proto]

A LaunchPlan provides the capability to templatize workflow executions. Launch plans simplify associating one or more schedules, inputs and notifications with your workflows. Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow definition doesn’t necessarily have a default value for said input.

{
  "id": "{...}",
  "spec": "{...}",
  "closure": "{...}"
}
id

(flyteidl.core.Identifier)

spec

(flyteidl.admin.LaunchPlanSpec)

closure

(flyteidl.admin.LaunchPlanClosure)

flyteidl.admin.LaunchPlanList

[flyteidl.admin.LaunchPlanList proto]

Response object for list launch plan requests.

{
  "launch_plans": [],
  "token": "..."
}
launch_plans

(flyteidl.admin.LaunchPlan)

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.

flyteidl.admin.Auth

[flyteidl.admin.Auth proto]

Defines permissions associated with executions created by this launch plan spec.

{
  "assumable_iam_role": "...",
  "kubernetes_service_account": "..."
}
assumable_iam_role

(string)

Only one of assumable_iam_role, kubernetes_service_account may be set.

kubernetes_service_account

(string)

Only one of assumable_iam_role, kubernetes_service_account may be set.

flyteidl.admin.LaunchPlanSpec

[flyteidl.admin.LaunchPlanSpec proto]

User-provided launch plan definition and configuration values.

{
  "workflow_id": "{...}",
  "entity_metadata": "{...}",
  "default_inputs": "{...}",
  "fixed_inputs": "{...}",
  "role": "...",
  "labels": "{...}",
  "annotations": "{...}",
  "auth": "{...}"
}
workflow_id

(flyteidl.core.Identifier) Reference to the Workflow template that the launch plan references

entity_metadata

(flyteidl.admin.LaunchPlanMetadata) Metadata for the Launch Plan

default_inputs

(flyteidl.core.ParameterMap) Input values to be passed for the execution

fixed_inputs

(flyteidl.core.LiteralMap) Fixed, non-overridable inputs for the Launch Plan

role

(string) String to indicate the role to use to execute the workflow underneath

labels

(flyteidl.admin.Labels) Custom labels to be applied to the execution resource.

annotations

(flyteidl.admin.Annotations) Custom annotations to be applied to the execution resource.

auth

(flyteidl.admin.Auth) Indicates the permission associated with workflow executions triggered with this launch plan.

flyteidl.admin.LaunchPlanClosure

[flyteidl.admin.LaunchPlanClosure proto]

Values computed by the flyte platform after launch plan registration. These include expected_inputs required to be present in a CreateExecutionRequest to launch the reference workflow as well timestamp values associated with the launch plan.

{
  "state": "...",
  "expected_inputs": "{...}",
  "expected_outputs": "{...}",
  "created_at": "{...}",
  "updated_at": "{...}"
}
state

(flyteidl.admin.LaunchPlanState) Indicate the Launch plan phase

expected_inputs

(flyteidl.core.ParameterMap) Indicates the set of inputs to execute the Launch plan

expected_outputs

(flyteidl.core.VariableMap) Indicates the set of outputs from the Launch plan

created_at

(google.protobuf.Timestamp) Time at which the launch plan was created.

updated_at

(google.protobuf.Timestamp) Time at which the launch plan was last updated.

flyteidl.admin.LaunchPlanMetadata

[flyteidl.admin.LaunchPlanMetadata proto]

Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch the reference workflow.

{
  "schedule": "{...}",
  "notifications": []
}
schedule

(flyteidl.admin.Schedule) Schedule to execute the Launch Plan

notifications

(flyteidl.admin.Notification) List of notifications based on Execution status transitions

flyteidl.admin.LaunchPlanUpdateRequest

[flyteidl.admin.LaunchPlanUpdateRequest proto]

Request to set the referenced launch plan state to the configured value.

{
  "id": "{...}",
  "state": "..."
}
id

(flyteidl.core.Identifier) Identifier of launch plan for which to change state.

state

(flyteidl.admin.LaunchPlanState) Desired state to apply to the launch plan.

flyteidl.admin.LaunchPlanUpdateResponse

[flyteidl.admin.LaunchPlanUpdateResponse proto]

Purposefully empty, may be populated in the future.

{}

flyteidl.admin.ActiveLaunchPlanRequest

[flyteidl.admin.ActiveLaunchPlanRequest proto]

Represents a request struct for finding an active launch plan for a given NamedEntityIdentifier

{
  "id": "{...}"
}
id

(flyteidl.admin.NamedEntityIdentifier)

flyteidl.admin.ActiveLaunchPlanListRequest

[flyteidl.admin.ActiveLaunchPlanListRequest proto]

Represents a request structure to list active launch plans within a project/domain.

{
  "project": "...",
  "domain": "...",
  "limit": "...",
  "token": "...",
  "sort_by": "{...}"
}
project

(string) Name of the project that contains the identifiers.

domain

(string) Name of the domain the identifiers belongs to within the project.

limit

(uint32) Indicates the number of resources to be returned.

token

(string) In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional

sort_by

(flyteidl.admin.Sort) Sort ordering. +optional

Enum flyteidl.admin.LaunchPlanState

[flyteidl.admin.LaunchPlanState proto]

By default any launch plan regardless of state can be used to launch a workflow execution. However, at most one version of a launch plan (e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be active at a time in regards to schedules. That is, at most one schedule in a NamedEntityIdentifier group will be observed and trigger executions at a defined cadence.

INACTIVE

(DEFAULT)

ACTIVE