Configuration Reference

List of global environment variables to add to each branch build and each step

One of label or image is required.

Legacy fields from jenkinsfile.PipelineAgent

Name of the application / helm chart

Repository the helm repository

Namespace to install the application into

Phase of the pipeline to install application

Applications of applications

DefaultNamespace the default namespace to install applications into

Enabled autoupdate

Schedule cron of auto updates

RegistrySubscription the registry subscription for defaulting the container registry. Not used if you specify a Registry explicitly

Username stores the basic authentication user name

Password stores the basic authentication password

Location contains location config

Name

GitURL

GitRef

AzureConfig the azure specific configuration

ChartRepository the repository URL to deploy charts to

GKEConfig the gke specific configuration

EnvironmentGitOwner the default git owner for environment repositories if none is specified explicitly

EnvironmentGitPublic determines whether jx boot create public or private git repos for the environments

GitPublic determines whether jx boot create public or private git repos for the applications

Provider the kubernetes provider (e.g. gke)

Namespace the namespace to install the dev environment

ProjectID the cloud project ID e.g. on GCP

ClusterName the logical name of the cluster

VaultName the name of the vault if using vault for secrets Deprecated

Region the cloud region being used

Zone the cloud zone being used

GitName is the name of the default git service

GitKind is the kind of git server (github, bitbucketserver etc)

GitServer is the URL of the git server

ExternalDNSSAName the service account name for external dns

Registry the host name of the container registry

VaultSAName the service account name for vault Deprecated

KanikoSAName the service account name for kaniko

HelmMajorVersion contains the major helm version number. Assumes helm 2.x with no tiller if no value specified

DevEnvApprovers contains an optional list of approvers to populate the initial OWNERS file in the dev env repo

DockerRegistryOrg the default organisation used for container images

StrictPermissions lets you decide how to boot the cluster when it comes to permissions If it’s false, cluster wide permissions will be used, normal, namespaced permissions will be used otherwise and extra steps will be necessary to get the cluster working

Key is the key of the environment configuration

Owner is the git user or organisation for the repository

Repository is the name of the repository within the owner

GitServer is the URL of the git server

GitKind is the kind of git server (github, bitbucketserver etc)

Ingress contains ingress specific requirements

RemoteCluster specifies this environment runs on a remote cluster to the development cluster

PromotionStrategy what kind of promotion strategy to use

URLTemplate is the template to use for your environment’s exposecontroller generated URLs

ProjectNumber the unique project number GKE assigns to a project (required for workload identity).

Enabled this determines whether this install should use the jenkins x github app for access tokens

Schedule cron of the github app token refresher

URL contains a URL to the github app

DNS is enabled

CloudDNSSecretName secret name which contains the service account for external-dns and cert-manager issuer to access the Cloud DNS service to resolve a DNS challenge

Domain to expose ingress endpoints

IgnoreLoadBalancer if the nginx-controller LoadBalancer service should not be used to detect and update the domain if you are using a dynamic domain resolver like .nip.io rather than a real DNS configuration. With this flag enabled the Domain value will be used and never re-created based on the current LoadBalancer IP address.

Exposer the exposer used to expose ingress endpoints. Defaults to “Ingress”

NamespaceSubDomain the sub domain expression to expose ingress. Defaults to “.jx.”

TLS enable automated TLS using certmanager

DomainIssuerURL contains a URL used to retrieve a Domain

The variable name.

The list of values to iterate over

The steps to run

Replaced by Env, retained for backwards compatibility

PreSteps if using inheritance then invoke these steps before the base steps

Replace if using inheritance then replace steps from the base pipeline

TODO: Conditional execution of something after a Task or Pipeline completes is not yet implemented

TODO: Notifications are not yet supported in Build Pipeline per se.

Also, we’ll need to do some magic to do type verification during translation - i.e., this action wants a number for this option, so translate the string value for that option to a number.

AutoUpdate contains auto update config

BootConfigURL contains the url to which the dev environment is associated with

BuildPackConfig contains custom build pack settings

Cluster contains cluster specific requirements

Environments the requirements for the environments

GithubApp contains github app config

GitOps if enabled we will setup a webhook in the boot configuration git repository so that we can re-run ‘jx boot’ when changes merge to the master branch

Indicates if we are using helmfile and helm 3 to spin up environments. This is currently an experimental feature flag used to implement better Multi-Cluster support. See https://github.com/jenkins-x/jx/issues/6442

Kaniko whether to enable kaniko for building docker images

Ingress contains ingress specific requirements

Repository specifies what kind of artifact repository you wish to use for storing artifacts (jars, tarballs, npm modules etc)

SecretStorage how should we store secrets for the cluster

Storage contains storage requirements

Terraform specifies if we are managing the kubernetes cluster and cloud resources with Terraform

Vault the configuration for vault

Velero the configuration for running velero for backing up the cluster resources

VersionStream contains version stream info

Webhook specifies what engine we should use for webhooks

RequirementsConfig contains the logical installation requirements

ContainerOptions allows for advanced configuration of containers for a single stage or the whole pipeline, adding to configuration that can be configured through the syntax already. This includes things like CPU/RAM requests/limits, secrets, ports, etc. Some of these things will end up with native syntax approaches down the road.

Replaced by Env, retained for backwards compatibility

(Members of RootOptions are embedded into this type.)

TODO: Not yet implemented in build-pipeline

Eventually make this optional so that you can do volumes instead

An optional name to give the step for reporting purposes

One of command, step, or loop is required.

args is optional, but only allowed with command

dir is optional, but only allowed with command. Refers to subdirectory of workspace

options is optional, but only allowed with step Also, we’ll need to do some magic to do type verification during translation - i.e., this step wants a number for this option, so translate the string value for that option to a number.

agent can be overridden on a step

Image alows the docker image for a step to be specified

env allows defining per-step environment variables

Legacy fields from jenkinsfile.PipelineStep before it was eliminated.

Logs for storing build logs

Tests for storing test results, coverage + code quality reports

Repository for storing repository artifacts

Backup for backing up kubernetes resource

Enabled if the storage is enabled

URL the cloud storage bucket URL such as ‘gs://mybucket’ or ‘s3://foo’ or `azblob://thingy’ see https://jenkins-x.io/architecture/storage/

TLS enabled

Email address to register with services like LetsEncrypt

Production false uses self-signed certificates from the LetsEncrypt staging server, true enables the production server which incurs higher rate limiting https://letsencrypt.org/docs/rate-limits/

SecretName the name of the secret which contains the TLS certificate

Has some sane default - probably seconds

Name the name of the Vault if using Jenkins X managed Vault instance. Cannot be used in conjunction with the URL attribute

DisableURLDiscovery allows us to optionally override the default lookup of the Vault URL, could be incluster service or external ingress

AWSConfig describes the AWS specific configuration needed for the Vault Operator.

URL specifies the URL of an Vault instance to use for secret storage. Needs to be specified together with the Service Account and namespace to use for connecting to Vault. This cannot be used in conjunction with the Name attribute.

ServiceAccount is the name of the Kubernetes service account allowed to authenticate against Vault.

Namespace of the Kubernetes service account allowed to authenticate against Vault.

SecretEngineMountPoint is the secret engine mount point to be used for writing data into the KV engine of Vault. If not specified the ‘secret’ is used.

KubernetesAuthPath is the auth path of used for this cluster If not specified the ‘kubernetes’ is used.

Namespace the namespace to install velero into

ServiceAccount the cloud service account used to run velero

Schedule of backups

TimeToLive period for backups to be retained

URL of the version stream to use

Ref of the version stream to use