Add

Learn how to add a worker (Vela Platform Admins only).

Command

$ vela add worker <parameters...> <arguments...>

For more information, you can run vela add worker --help.

Parameters

The following parameters are used to configure the command:

Name	Description	Environment Variables
`worker.address`	address of the worker	`VELA_WORKER_ADDRESS`, `WORKER_ADDRESS`
`worker.hostname`	hostname of the worker	`VELA_WORKER_HOSTNAME`, `WORKER_HOSTNAME`
`output`	format the output for the worker	`VELA_OUTPUT`, `WORKER_OUTPUT`

This command also supports setting the following parameters via a configuration file:

output

For more information, please review the CLI config documentation.

Permissions

Vela Platform Admin

Sample

This section assumes you have already installed and setup the CLI and are authenticated as a Vela platform admin.

To install the CLI, please review the installation documentation.

To setup the CLI, please review the authentication documentation.

Request

$ vela add worker --worker.address myworker.example.com

Not passing --worker.hostname will automatically use the hostname part of the passed in --worker.address as the hostname.

Response generated from successful CLI command

worker registered successfully

Examples

EXAMPLES:
  1. Add a worker reachable at the provided address.
    $ vela add worker --worker.address myworker.example.com
  2. Add a worker with the provided hostname and reachable at the address given.
    $ vela add worker --worker.hostname MyWorker --worker.address myworker.example.com

Last modified April 26, 2023: feat(worker): add worker commands (#362) (596adba5)