no_list | title | linkTitle | weight | description |
---|---|---|---|---|
true |
Reference |
Reference |
4 |
This section contains a reference of configuration options for the Vela server service.
|
The server is made up of several components, responsible for specific tasks, necessary for the service to operate:
Name | Description |
---|---|
compiler |
transforms a pipeline into an executable workload for the worker |
database |
integrates with a database provider for storing application data at rest |
queue |
integrates with a queue provider for pushing workloads that will be run by a worker |
secret |
integrates with a secret provider for storing sensitive application data at rest |
source |
integrates with a source control management (SCM) provider for authentication and authorization |
This section contains a list of all variables that must be provided to the server.
This variable sets a fully qualified URL to the Vela server address.
The variable should be provided as a string
.
This configuration variable is used by the database component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets the AES key for encrypting/decrypting values for data stored in the database.
The variable should be provided as an string
.
This configuration variable is used by the queue component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets a fully qualified URL to the queue instance for pushing workloads that will be run by a worker.
The variable should be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable should match the VELA_QUEUE_ADDR
variable provided to the worker.
{{% /alert %}}
This configuration variable is used by the queue component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets the driver to use for the queue functionality for the server.
The variable should be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable should match the VELA_QUEUE_DRIVER
variable provided to the worker.
The possible options to provide for this variable are:
redis
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets the client ID from the OAuth application created on the SCM system.
The variable should be provided as a string
.
This configuration variable is used by the SCM component for the server.
This variable sets the client secret from the OAuth application created on the SCM system.
The variable should be provided as a string
.
This variable sets the private key that will be used to sign all JWT tokens within Vela. Please be sure to follow guidelines related to generating a private key.
The variable should be provided as a string
.
This section contains a list of all variables that can be provided to the server.
This variable sets a shared secret with the Vela worker for authenticating communication between workers and the server.
Only necessary to provide if utilizing the server-worker trusted symmetric worker authentication method.
The variable should be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable should match the VELA_SERVER_SECRET
variable provided to the worker.
{{% /alert %}}
This configuration variable is used by the compiler component for the server.
The clone image sets the clone image to use for the Vela injected clone step in a pipeline.
By default, Vela will use the latest available release of the clone image at the time of a server release.
This variable should be provided as a string
.
This configuration variable is used by the compiler component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable enables using GitHub or GitHub Enterprise Server as a registry for fetching pipeline templates from.
By default, Vela will use GitHub as a registry for fetching templates.
However, to fetch templates from a private organization or repository on GitHub, you need to provide this configuration.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of false
.
{{% /alert %}}
This configuration variable is used by the compiler component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets a Personal Access Token (PAT) for fetching pipeline templates from GitHub or GitHub Enterprise Server.
By default, Vela will use GitHub as a registry for fetching templates.
However, to fetch templates from a private organization or repository on GitHub, you need to provide this configuration.
The variable can be provided as a string
.
This configuration variable is used by the compiler component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets a fully qualified URL to GitHub or GitHub Enterprise Server used for fetching pipeline templates from.
By default, Vela will use GitHub as a registry for fetching templates.
However, to fetch templates from a private organization or repository on GitHub, you need to provide this configuration.
The variable can be provided as a string
.
This configuration variable is used by the database component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets a fully qualified URL to the database instance for storing data at rest.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of vela.sqlite
.
{{% /alert %}}
This configuration variable is used by the database component for the server.
This variable sets the level of compression for workload logs, uploaded by the Vela worker, which are stored in the database.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 3
.
The possible options to provide for this variable are:
-1
0
- produces no compression for the log data1
- produces compression for the log data the fastest and with the largest size of data2
3
4
5
- produces compression for the log data with an even balance of speed and size of data6
7
8
9
- produces compression for the log data the slowest and with the smallest size of data {{% /alert %}}
This configuration variable is used by the database component for the server.
This variable sets the maximum number of idle connections allowed for the database client.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 2
.
{{% /alert %}}
This configuration variable is used by the database component for the server.
This variable sets the maximum duration of time a connection is reusable for the database client.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 30m
.
{{% /alert %}}
This configuration variable is used by the database component for the server.
This variable sets the maximum number of open connections allowed for the database client.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 0
(meaning no limit is set).
{{% /alert %}}
This configuration variable is used by the database component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets the driver to use for the database functionality for the server.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of sqlite3
.
The possible options to provide for this variable are:
postgres
sqlite3
{{% /alert %}}
This configuration variable is used by the database component for the server.
This variable enables skipping the creation of tables and indexes in the database system.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of false
.
{{% /alert %}}
This variable sets the default amount of concurrent builds a repo is allowed to run.
In this context, concurrent builds refers to any pending
or running
builds for that repo.
If the amount of concurrent builds for a repo matches the limit, then any new builds will be blocked from being created.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 10
.
{{% /alert %}}
This variable sets the default duration of time a build is allowed to run on a worker.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 30
.
{{% /alert %}}
This variable sets the default active events for newly activated repositories.
The variable can be provided as a comma-separated list
(i.e. push,tag,deployment
).
{{% alert title="Note:" color="primary" %}}
By default, the push
event is enabled. Valid values are: push
, pull_request
, tag
, deployment
, and comment
.
{{% /alert %}}
This variable disables validation of webhooks sent by the SCM to the server.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}} This variable should only be used for local development.
This variable has a default value of false
.
{{% /alert %}}
This enables using cookies with the secure flag set by the server.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}} This variable should only be used for local development.
This variable has a default value of true
.
{{% /alert %}}
This variable sets the maximum amount of concurrent builds a repo is allowed to run.
In this context, concurrent builds refers to any pending
or running
builds for that repo.
If the amount of concurrent builds for a repo matches the limit, then any new builds will be blocked from being created.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 30
.
This variable should match the VELA_MAX_BUILD_LIMIT
variable provided to the UI.
{{% /alert %}}
This configuration variable is used by the compiler component for the server.
This variable sets a fully qualified URL to the modification endpoint used for the compiler.
The variable can be provided as a string
.
This configuration variable is used by the compiler component for the server.
This variable sets the maximum number of times to resend failed requests to the modification endpoint for the compiler.
The variable can be provided as an integer
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 5
.
{{% /alert %}}
This configuration variable is used by the compiler component for the server.
This variable sets a shared secret for authenticating communication between the compiler and the modification endpoint.
The variable can be provided as a string
.
This configuration variable is used by the compiler component for the server.
This variable sets the maximum duration of time the compiler will wait before timing out requests sent to the modification endpoint.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 8s
.
{{% /alert %}}
This variable sets the port the server API responds on for HTTP requests.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 8080
.
{{% /alert %}}
This configuration variable is used by the queue component for the server.
This variable enables the server to connect to a queue cluster rather than a standalone instance.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}}
This variable should match the VELA_QUEUE_CLUSTER
variable provided to the worker.
{{% /alert %}}
This configuration variable is unused by the queue component for the server.
This variable sets the maximum duration of time the worker will wait before timing out requests sent for pushing workloads.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 60s
.
{{% /alert %}}
This configuration variable is used by the queue component for the server.
This variable sets the unique channels or topics to push workloads to.
The variable can be provided as a comma-separated list
(i.e. myRoute1,myRoute2
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of vela
.
{{% /alert %}}
This variable sets a group of repositories, from the SCM, that can be enabled on the server.
The variable can be provided as a comma-separated list
(i.e. myOrg1/myRepo1,myOrg1/myRepo2,myOrg2/*
).
{{% alert title="Note:" color="primary" %}}
By default, no repositories are allowed to be enabled. To allow any repository to be enabled, provide a single value of *
.
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets a fully qualified URL to the source control management (SCM) system.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of https://github.com
.
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets the message to set in the commit status on the SCM system.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of continuous-integration/vela
.
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets the driver to use for the SCM functionality for the server.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of github
.
The possible options to provide for this variable are:
github
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets the permission scopes to apply for OAuth credentials captured from the SCM system.
The variable can be provided as a comma-separated list
(i.e. myScope1,myScope2
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of read:org,read:user,repo,repo:status,user:email
.
{{% /alert %}}
This configuration variable is used by the SCM component for the server.
This variable sets a fully qualified URL on the SCM system to send webhooks to the server.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of the VELA_ADDR
variable provided to the server.
{{% /alert %}}
This configuration variable is used by the secret component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable enables using HashiCorp Vault as a secret engine.
The variable can be provided as a boolean
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of false
.
{{% /alert %}}
This configuration variable is used by the secret component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets a fully qualified URL to the HashiCorp Vault instance.
The variable can be provided as a string
.
This configuration variable is used by the secret component for the server.
This variable sets the authentication method to obtain a token from the HashiCorp Vault instance.
The variable can be provided as a string
.
This configuration variable is used by the secret component for the server.
This variable sets the HashiCorp Vault role to connect to the auth/aws/login
endpoint.
The variable can be provided as a string
.
This configuration variable is used by the secret component for the server.
This variable sets the prefix for k/v secrets in the HashiCorp Vault instance.
The variable can be provided as a string
.
This configuration variable is used by the secret component for the server.
This variable sets the frequency to renew the token for the HashiCorp Vault instance.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 30m
.
{{% /alert %}}
This configuration variable is used by the secret component for the server.
Examples using this configuration variable are provided in the above reference documentation.
This variable sets the token for accessing the HashiCorp Vault instance.
The variable can be provided as a string
.
This configuration variable is used by the secret component for the server.
This variable sets the version for the k/v backend for the HashiCorp Vault instance.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 2
.
{{% /alert %}}
This variable sets the maximum duration of time a Vela access token for a user is valid on the server.
The access token is used for authenticating user's requests to the server.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 15m
.
{{% /alert %}}
This variable sets the maximum duration of time a Vela refresh token for a user is valid on the server.
The refresh token is used for refreshing a user's access token on the server.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 8h
.
{{% /alert %}}
This variable sets the maximum duration of time a Vela build token for a build extends beyond the repo build limit to maintain validity on the server.
The build token is used for authenticating a worker's access to the server to update build resources.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 5m
.
{{% /alert %}}
This variable sets a fully qualified URL to the Vela UI address.
The variable can be provided as a string
.
This variable sets the endpoint to use for the OAuth callback path for the Vela UI.
The variable can be provided as a string
.
{{% alert title="Note:" color="primary" %}}
This variable has a default value of /account/authenticate
.
{{% /alert %}}
This variable sets the maximum duration of time a Vela auth token for a worker is valid on the server.
The worker auth token is used for authenticating a worker's access to the server to check-in and request build tokens.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Notes:" color="primary" %}} This variable should be longer than the VELA_CHECK_IN in order to be able to refresh the auth token.
This variable has a default value of 20m
.
{{% /alert %}}
This variable sets the maximum duration of time a Vela registration token for a worker is valid on the server.
The worker register token is used for onboarding a worker onto the server and beginning its auth refresh routine.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Notes:" color="primary" %}} This variable should be relatively short-lived. There is a CLI Command to quicken the registration process for admins.
This variable has a default value of 1m
.
{{% /alert %}}
This variable sets the interval of time the workers will be considered active. A worker is considered active if it has registered with the server inside the give duration.
The variable can be provided as a duration
(i.e. 5s
, 10m
).
{{% alert title="Note:" color="primary" %}}
This variable has a default value of 5m
.
The value should coordinate with the VELA_CHECK_IN
setting provided to the worker.
{{% /alert %}}