Update

Learn how to modify platform settings.

Command

$ vela update settings <parameters...> <arguments...>

Parameters

The following parameters are used to configure the command:

NameDescriptionEnvironment Variables
compiler.clone-imageimage used by the compiler to clone repositoriesVELA_COMPILER_CLONE_IMAGE
compiler.template-depthmaximum depth of nested templatesVELA_COMPILER_TEMPLATE_DEPTH
compiler.starlark-exec-limitmaximum execution limit for Starlark templatesVELA_COMPILER_STARLARK_EXEC_LIMIT
queue.add-routeadd a route to the queueVELA_QUEUE_ADD_ROUTES
queue.drop-routedrop a route from the queueVELA_QUEUE_DROP_ROUTES
add-reponame of repository to add to the global allowlistVELA_REPO_ALLOWLIST_ADD_REPOS
drop-reponame of repository to drop from the global allowlistVELA_REPO_ALLOWLIST_DROP_REPOS
add-schedulename of repository to add to the schedules allowlistVELA_SCHEDULE_ALLOWLIST_ADD_REPOS
drop-schedulename of repository to drop from the schedules allowlistVELA_SCHEDULE_ALLOWLIST_DROP_REPOS
filepath to a json/yaml file containing settings updatesVELA_FILE

Permissions

COMING SOON!

Sample

Request

$ pwd
~/github/octocat
$ vela update settings --compiler.clone-image target/vela-git:abc123  --queue.add-route large

Response

id: 1
compiler:
    clone_image: target/vela-git:latest
    template_depth: 3
    starlark_exec_limit: 7500
queue:
    routes:
        - vela
repo_allowlist:
    - 'github/octocat'
schedule_allowlist:
    - '*'
created_at: 0
updated_at: 1715791151
updated_by: octocat

Advanced

Input From File

Vela supports updating a settings record from a file using the @ symbol.

# Syntax
vela update settings --file @/path/to/file

# Example
vela update settings --file @$HOME/tmp/settings.yml
Single YAML document
---
platform:
    compiler:
        clone_image: target/vela-git:latest
        template_depth: 3
        starlark_exec_limit: 7500
    queue:
        routes:
            - vela
    repo_allowlist:
        - 'github/octocat'
    schedule_allowlist:
        - '*'
    created_at: 0
    updated_at: 1715791151
    updated_by: octocat