constants

Documentation

Overview

SPDX-License-Identifier: Apache-2.0

SPDX-License-Identifier: Apache-2.0

Index

• Constants

Constants

const (
	// DriverPostgres defines the driver type when integrating with a PostgreSQL database.
	DriverPostgres = "postgres"

	// DriverSqlite defines the driver type when integrating with a SQLite database.
	DriverSqlite = "sqlite3"
)

Server database drivers.

const (
	// DriverDarwin defines the driver type when integrating with a darwin distribution.
	DriverDarwin = "darwin"

	// DriverLinux defines the driver type when integrating with a linux distribution.
	DriverLinux = "linux"

	// DriverLocal defines the driver type when integrating with a local system.
	DriverLocal = "local"

	// DriverWindows defines the driver type when integrating with a windows distribution.
	DriverWindows = "windows"
)

Worker executor drivers.

const (

	// DriverKafka defines the driver type when integrating with a Kafka queue.
	DriverKafka = "kafka"

	// DriverRedis defines the driver type when integrating with a Redis queue.
	DriverRedis = "redis"
)

Server and worker queue drivers.

const (
	// DriverDocker defines the driver type when integrating with a Docker runtime.
	DriverDocker = "docker"

	// DriverKubernetes defines the driver type when integrating with a Kubernetes runtime.
	DriverKubernetes = "kubernetes"
)

Worker runtime drivers.

const (
	// DriverNative defines the driver type when integrating with a Vela secret service.
	DriverNative = "native"

	// DriverVault defines the driver type when integrating with a Vault secret service.
	DriverVault = "vault"
)

Server and worker secret drivers.

const (
	// DriverGitHub defines the driver type when integrating with a Github source code system.
	DriverGithub = "github"

	// DriverGitLab defines the driver type when integrating with a Gitlab source code system.
	DriverGitlab = "gitlab"
)

Server source drivers.

const (
	// BuildLimitMin defines the minimum value for repo concurrent build limit.
	BuildLimitMin = 1

	// BuildLimitMax defines the maximum value for repo concurrent build limit.
	BuildLimitMax = 30

	// BuildLimitDefault defines the default value for repo concurrent build limit.
	BuildLimitDefault = 10

	// BuildTimeoutMin defines the minimum value in minutes for repo build timeout.
	BuildTimeoutMin = 1

	// BuildTimeoutMax defines the maximum value in minutes for repo build timeout.
	BuildTimeoutMax = 90

	// BuildTimeoutDefault defines the default value in minutes for repo build timeout.
	BuildTimeoutDefault = 30

	// FavoritesMaxSize defines the maximum size in characters for user favorites.
	FavoritesMaxSize = 5000

	// RunningBuildIDsMaxSize defines the maximum size in characters for worker RunningBuildIDs.
	RunningBuildIDsMaxSize = 500

	// TopicsMaxSize defines the maximum size in characters for repo topics. Ex: GitHub has a 20-topic, 50-char limit.
	TopicsMaxSize = 1020

	// DeployBuildsMaxSize defines the maximum size in characters for deployment builds.
	DeployBuildsMaxSize = 500

	// ReportStepStatusLimit defines the maximum number of steps in a pipeline that may report their status to the SCM.
	ReportStepStatusLimit = 10

	// DashboardRepoLimit defines the maximum number of repos that can be assigned to a dashboard.
	DashboardRepoLimit = 10

	// UserDashboardLimit defines the maximum number of dashboards that can be assigned to a user.
	UserDashboardLimit = 10

	// DashboardAdminMaxSize defines the maximum size in characters for dashboard admins.
	DashboardAdminMaxSize = 5000
)

Limits and constraints.

const (
	// PipelineTypeYAML defines the pipeline type for allowing users
	// in Vela to control their pipeline being compiled as yaml.
	PipelineTypeYAML = "yaml"

	// PipelineTypeGo defines the pipeline type for allowing users
	// in Vela to control their pipeline being compiled as Go templates.
	PipelineTypeGo = "go"

	// PipelineTypeStarlark defines the pipeline type for allowing users
	// in Vela to control their pipeline being compiled as Starlark templates.
	PipelineTypeStarlark = "starlark"
)

Repo get pipeline types.

const (
	// ApproveForkAlways defines the CI strategy of having a repo administrator approve
	// all builds triggered from a forked PR.
	ApproveForkAlways = "fork-always"

	// ApproveForkNoWrite defines the CI strategy of having a repo administrator approve
	// all builds triggered from a forked PR where the author does not have write access.
	ApproveForkNoWrite = "fork-no-write"

	// ApproveOnce defines the CI strategy of having a repo administrator approve
	// all builds triggered from an outside contributor if this is their first time contributing.
	ApproveOnce = "first-time"

	// ApproveNever defines the CI strategy of never having to approve CI builds from outside contributors.
	ApproveNever = "never"
)

Repo ApproveBuild types.

const (
	// SecretPullBuild defines the pull policy type for a secret.
	SecretPullBuild = "build_start"

	// SecretPullStep defines the pull policy type for a secret.
	SecretPullStep = "step_start"

	// SecretOrg defines the secret type for a secret scoped to a specific org.
	SecretOrg = "org"

	// SecretRepo defines the secret type for a secret scoped to a specific repo.
	SecretRepo = "repo"

	// SecretShared defines the secret type for a secret shared across the installation.
	SecretShared = "shared"

	// SecretMask defines the secret mask to be used in place of secret values returned to users.
	SecretMask = "[secure]"

	// SecretLogMask defines the secret mask to be used when distributing logs that contain secrets.
	SecretLogMask = "***"

	// SecretRestrictedCharacters defines the set of characters that a secret name cannot contain.
	// This matches the following characters:
	//   Equal Sign =
	//   Null Character \x00
	SecretRestrictedCharacters = "=\x00"
)

Secret types.

const (
	// StatusError defines the status type for build and step error statuses.
	StatusError = "error"

	// StatusFailure defines the status type for build and step failure statuses.
	StatusFailure = "failure"

	// StatusKilled defines the status type for build and step killed statuses.
	StatusKilled = "killed"

	// StatusCanceled defines the status type for build and step canceled statuses.
	StatusCanceled = "canceled"

	// StatusPending defines the status type for build and step pending statuses.
	StatusPending = "pending"

	// StatusPendingApproval defines the status type for a build waiting to be approved to run.
	StatusPendingApproval = "pending approval"

	// StatusRunning defines the status type for build and step running statuses.
	StatusRunning = "running"

	// StatusSuccess defines the status type for build and step success statuses.
	StatusSuccess = "success"

	// StatusSkipped defines the status type for build and step skipped statuses.
	StatusSkipped = "skipped"
)

Build and step statuses.

const (
	// TableBuild defines the table type for the database builds table.
	TableBuild = "builds"

	// TableBuildExecutable defines the table type for the database build_executables table.
	TableBuildExecutable = "build_executables"

	// TableDashboard defines the table type for the database dashboards table.
	TableDashboard = "dashboards"

	// TableDeployment defines the table type for the database deployments table.
	TableDeployment = "deployments"

	// TableHook defines the table type for the database hooks table.
	TableHook = "hooks"

	// TableJWK defines the table type for the database jwks table.
	TableJWK = "jwks"

	// TableLog defines the table type for the database logs table.
	TableLog = "logs"

	// TablePipeline defines the table type for the database pipelines table.
	TablePipeline = "pipelines"

	// TableRepo defines the table type for the database repos table.
	TableRepo = "repos"

	// TableSchedule defines the table type for the database schedules table.
	TableSchedule = "schedules"

	// TableSecret defines the table type for the database secrets table.
	TableSecret = "secrets"

	// TableService defines the table type for the database services table.
	TableService = "services"

	// TableStep defines the table type for the database steps table.
	TableStep = "steps"

	// TableUser defines the table type for the database users table.
	TableUser = "users"

	// TableWorker defines the table type for the database workers table.
	TableWorker = "workers"
)

Database tables.

const (
	// RefreshTokenName is the name associated with the refresh token.
	RefreshTokenName = "vela_refresh_token"

	// UserAccessTokenType is the name associated with the user access token type.
	UserAccessTokenType = "UserAccess"

	// UserRefreshTokenType is the name associated with the user refresh token type.
	UserRefreshTokenType = "UserRefresh"

	// WorkerAuthTokenType is the name associated with the worker authentication token type.
	WorkerAuthTokenType = "WorkerAuth"

	// WorkerRegisterTokenType is the name associated with the worker registration token type.
	WorkerRegisterTokenType = "WorkerRegister"

	// WorkerBuildTokenType is the name associated with the worker build token type.
	WorkerBuildTokenType = "WorkerBuild"

	// ServerWorkerTokenType is the name associated with the server-worker symmetric token.
	ServerWorkerTokenType = "ServerWorker"

	// IDRequestTokenType is the name associated with the id request token type.
	IDRequestTokenType = "IDRequest"

	// IDTokenType is the name associated with the id token type.
	IDTokenType = "ID"
)

Constants for tokens.

const (
	// VisibilityPublic defines the visibility type for allowing any
	// users in Vela to access their repo regardless of the access
	// defined in the source control system.
	VisibilityPublic = "public"

	// VisibilityPrivate defines the visibility type for only allowing
	// users in Vela with pre-defined access in the source control
	// system to access their repo.
	VisibilityPrivate = "private"
)

Repo visibility types.