Overview
flytectl update modifies existing Flyte resources in FlyteAdmin.
flytectl update <resource> [name] -p <project> -d <domain> [flags]
Subcommands
| Subcommand | Description |
|---|
update project | Activate, archive, or edit project metadata |
update launchplan | Activate or deactivate a launch plan schedule |
update launchplan-meta | Update a launch plan’s description or archive state |
update execution | Update execution tags or state |
update task-meta | Update a task’s description or archive state |
update workflow-meta | Update a workflow’s description or archive state |
update task-resource-attribute | Update task resource default/limit overrides |
update cluster-resource-attribute | Update cluster resource attribute overrides |
update execution-cluster-label | Update execution cluster label overrides |
update execution-queue-attribute | Update execution queue attribute overrides |
update plugin-override | Update plugin override settings |
update workflow-execution-config | Update workflow execution config overrides |
update project
Modify project metadata, or archive/activate a project.
# Activate (unarchive) a project
flytectl update project -p my-project-id --activate
# Archive a project
flytectl update project -p my-project-id --archive
# Update description and labels
flytectl update project -p my-project-id \
--description "A wonderful project" \
--labels app=my-app
# Update from a YAML file
flytectl update project --file project.yaml
id: "my-project-id"
name: "my-project-name"
labels:
values:
app: my-app
description: "A wonderful project"
state: 1 and pass --archive:
# update.yaml
id: "my-project-id"
state: 1
flytectl update project --file update.yaml --archive
state: 0 and still pass --archive:
# update.yaml
id: "my-project-id"
state: 0
flytectl update project --file update.yaml --archive
When using a YAML file, the --activate flag is not used. The --archive flag controls whether the state field in the file is applied.
| Flag | Description |
|---|
--activate | Activate (unarchive) the project |
--archive | Archive the project |
--name | Update the display name |
--description | Update the description |
--labels | Update labels (key=value) |
--file | Path to a project YAML definition file |
--dryRun | Print the diff without applying changes |
--force | Skip the confirmation prompt |
update launchplan
Activate or deactivate a versioned launch plan to enable or disable its schedule.
# Activate a launch plan (enables the schedule)
flytectl update launchplan -p flytesnacks -d development \
core.control_flow.merge_sort.merge_sort \
--version v1 --activate
# Deactivate a launch plan (disables the schedule)
flytectl update launchplan -p flytesnacks -d development \
core.control_flow.merge_sort.merge_sort \
--version v1 --deactivate
| Flag | Description |
|---|
--version | Version of the launch plan to update (required) |
--activate | Activate the launch plan |
--deactivate | Deactivate the launch plan |
--dryRun | Print the request without executing it |
--force | Skip the confirmation prompt |
You cannot specify both --activate and --deactivate in the same command.
Matchable attribute updates
Matchable resource attributes allow you to override resource defaults at different scopes. All attribute updates require reading a YAML file via --attrFile.
Use flytectl get <attribute> --attrFile <file> to dump the current configuration before updating it.
update task-resource-attribute
Override default and limit CPU/memory for tasks in a project+domain (or project+domain+workflow).
flytectl update task-resource-attribute --attrFile tra.yaml
tra.yaml (project+domain scope):
domain: development
project: flytesnacks
defaults:
cpu: "1"
memory: "150Mi"
limits:
cpu: "2"
memory: "450Mi"
tra.yaml (project+domain+workflow scope):
domain: development
project: flytesnacks
workflow: core.control_flow.merge_sort.merge_sort
defaults:
cpu: "1"
memory: "150Mi"
limits:
cpu: "2"
memory: "450Mi"
update cluster-resource-attribute
Override cluster resource attributes (custom template variables injected into Kubernetes resources).
flytectl update cluster-resource-attribute --attrFile cra.yaml
cra.yaml:
domain: development
project: flytesnacks
attributes:
foo: "bar"
buzz: "lightyear"
update execution-cluster-label
Pin executions for a project+domain to a specific cluster.
flytectl update execution-cluster-label --attrFile ecl.yaml
ecl.yaml:
domain: development
project: flytesnacks
value: foo
ecl.yaml (workflow scope):
domain: development
project: flytesnacks
workflow: core.control_flow.merge_sort.merge_sort
value: foo
update execution-queue-attribute
flytectl update execution-queue-attribute --attrFile eqa.yaml
update plugin-override
flytectl update plugin-override --attrFile po.yaml
update workflow-execution-config
flytectl update workflow-execution-config --attrFile wec.yaml
| Flag | Description |
|---|
--attrFile | Path to the attribute YAML file (required) |
--dryRun | Print the request without executing it |
--force | Skip the confirmation prompt |
