curl --request POST \
--url https://mycluster.domino.tech/api/v1/launch_plans \
--header 'Content-Type: application/json' \
--data '
{
"id": {
"resource_type": "UNSPECIFIED",
"project": "<string>",
"domain": "<string>",
"name": "<string>",
"version": "<string>",
"org": "<string>"
},
"spec": {
"workflow_id": {
"resource_type": "UNSPECIFIED",
"project": "<string>",
"domain": "<string>",
"name": "<string>",
"version": "<string>",
"org": "<string>"
},
"entity_metadata": {
"schedule": {
"cron_expression": "<string>",
"rate": {
"value": 123,
"unit": "MINUTE"
},
"cron_schedule": {
"schedule": "<string>",
"offset": "<string>"
},
"kickoff_time_input_arg": "<string>"
},
"notifications": [
{
"phases": [
"UNDEFINED"
],
"email": {
"recipients_email": [
"<string>"
],
"template": "<string>"
},
"pager_duty": {
"recipients_email": [
"<string>"
],
"template": "<string>"
},
"slack": {
"recipients_email": [
"<string>"
],
"template": "<string>"
}
}
],
"launch_conditions": {
"@type": "<string>"
}
},
"default_inputs": {
"parameters": {}
},
"fixed_inputs": {
"literals": {}
},
"role": "<string>",
"labels": {
"values": {}
},
"annotations": {
"values": {}
},
"auth": {
"assumable_iam_role": "<string>",
"kubernetes_service_account": "<string>"
},
"auth_role": {
"assumable_iam_role": "<string>",
"kubernetes_service_account": "<string>"
},
"security_context": {
"run_as": {
"iam_role": "<string>",
"k8s_service_account": "<string>",
"oauth2_client": {
"client_id": "<string>",
"client_secret": {
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
},
"execution_identity": "<string>"
},
"secrets": [
{
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
],
"tokens": [
{
"name": "<string>",
"type": "CLIENT_CREDENTIALS",
"client": {
"client_id": "<string>",
"client_secret": {
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
},
"idp_discovery_endpoint": "<string>",
"token_endpoint": "<string>"
}
]
},
"quality_of_service": {
"tier": "UNDEFINED",
"spec": {
"queueing_budget": "<string>"
}
},
"raw_output_data_config": {
"output_location_prefix": "<string>"
},
"max_parallelism": 123,
"interruptible": true,
"overwrite_cache": true,
"envs": {
"values": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"execution_env_assignments": [
{
"node_ids": [
"<string>"
],
"task_type": "<string>",
"execution_env": {
"name": "<string>",
"type": "<string>",
"extant": {},
"spec": {},
"version": "<string>"
}
}
],
"cluster_assignment": {
"cluster_pool_name": "<string>"
},
"concurrency_policy": {
"max": 123,
"behavior": "CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED"
}
}
}
'{}Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
Create and register a launch plan definition.
curl --request POST \
--url https://mycluster.domino.tech/api/v1/launch_plans \
--header 'Content-Type: application/json' \
--data '
{
"id": {
"resource_type": "UNSPECIFIED",
"project": "<string>",
"domain": "<string>",
"name": "<string>",
"version": "<string>",
"org": "<string>"
},
"spec": {
"workflow_id": {
"resource_type": "UNSPECIFIED",
"project": "<string>",
"domain": "<string>",
"name": "<string>",
"version": "<string>",
"org": "<string>"
},
"entity_metadata": {
"schedule": {
"cron_expression": "<string>",
"rate": {
"value": 123,
"unit": "MINUTE"
},
"cron_schedule": {
"schedule": "<string>",
"offset": "<string>"
},
"kickoff_time_input_arg": "<string>"
},
"notifications": [
{
"phases": [
"UNDEFINED"
],
"email": {
"recipients_email": [
"<string>"
],
"template": "<string>"
},
"pager_duty": {
"recipients_email": [
"<string>"
],
"template": "<string>"
},
"slack": {
"recipients_email": [
"<string>"
],
"template": "<string>"
}
}
],
"launch_conditions": {
"@type": "<string>"
}
},
"default_inputs": {
"parameters": {}
},
"fixed_inputs": {
"literals": {}
},
"role": "<string>",
"labels": {
"values": {}
},
"annotations": {
"values": {}
},
"auth": {
"assumable_iam_role": "<string>",
"kubernetes_service_account": "<string>"
},
"auth_role": {
"assumable_iam_role": "<string>",
"kubernetes_service_account": "<string>"
},
"security_context": {
"run_as": {
"iam_role": "<string>",
"k8s_service_account": "<string>",
"oauth2_client": {
"client_id": "<string>",
"client_secret": {
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
},
"execution_identity": "<string>"
},
"secrets": [
{
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
],
"tokens": [
{
"name": "<string>",
"type": "CLIENT_CREDENTIALS",
"client": {
"client_id": "<string>",
"client_secret": {
"group": "<string>",
"group_version": "<string>",
"key": "<string>",
"mount_requirement": "ANY",
"env_var": "<string>"
}
},
"idp_discovery_endpoint": "<string>",
"token_endpoint": "<string>"
}
]
},
"quality_of_service": {
"tier": "UNDEFINED",
"spec": {
"queueing_budget": "<string>"
}
},
"raw_output_data_config": {
"output_location_prefix": "<string>"
},
"max_parallelism": 123,
"interruptible": true,
"overwrite_cache": true,
"envs": {
"values": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"execution_env_assignments": [
{
"node_ids": [
"<string>"
],
"task_type": "<string>",
"execution_env": {
"name": "<string>",
"type": "<string>",
"extant": {},
"spec": {},
"version": "<string>"
}
}
],
"cluster_assignment": {
"cluster_pool_name": "<string>"
},
"concurrency_policy": {
"max": 123,
"behavior": "CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED"
}
}
}
'{}Body
Request to register a launch plan. The included LaunchPlanSpec may have 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 successfully created a launch plan.
Request to register a launch plan. The included LaunchPlanSpec may have 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 successfully created a launch plan.
Response
A successful response.
Purposefully empty, may be populated in the future.
Was this page helpful?