Reference on JayeX - Cloud Native CI/CD Built On Kubernetes

Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

The following are the links to the various configuration file formats:

Tekton resources:

A Task is made up of Steps which each support all of the properties you can modify on a kubernetes Container

Mon, 01 Jan 0001 00:00:00 +0000

JayeX uses GitOps and so has a number of different source files with declarative schemas.

You may also find the git layout document useful.

File	Schema	Description
`.jx/settings.yaml`	Settings	Optional file to override any settings from the development cluster git repository; such as the chart repository, container registry or environments to promote to. Usually the Requirements in the dev cluster git repository are used.
`.jx/updatebot.yaml`	Updatebot	Describes the settings when using the jx updatebot plugin to promote versions of a repository to different git repositories using different strategies
`.lighthouse/*/triggers.yaml`	TriggerConfig	Defines the pipeline triggers in lighthouse which start tekton pipelines in response to git or ChatOps activity
`.lighthouse//.yaml`	PipelineRun	Tekton pipelines to define pull request pipelines (or `presubmits`) and release pipelines (`postsubmits`). For more detail check out the pipeline reference
`charts`	helm chart	Defines the kubernetes resources to be installed in a kubernetes cluster
`Dockerfile`	Dockerfile	Defines how to create a container image for repositories that create images
`OWNERS`	OWNERS	this lighthouse configuration file defines who can review and approve files
`OWNERS_ALIASES`	OWNERS_ALIASES	this lighthouse configuration file defines aliases for who can review and approve files
`preview/helmfile.yaml`	helmfile	The helmfile defines the helm charts, version and value mappings to be installed in a preview environment

The following files are only used in a development cluster git repository

Mon, 01 Jan 0001 00:00:00 +0000

The following tekton parameters and environment variables are available inside the pipeline catalog. They are populated by lighthouse

Variable	Description
BUILD_ID	a unique long number for this build
JOB_NAME	the name of the build which matches the name in the `presubmit` or `postsubmit` in your lighthouse `triggers.yaml`
JOB_SPEC	is of the form `type:presumit` or `type:postsubmit` so you know what kind of job you are inside
PULL_BASE_REF	the base branch name. e.g. `master` or `main`
PULL_BASE_SHA	the base git SHA being built
REPO_NAME	the name of the git repository
REPO_OWNER	the owner of the git repository (a user or organisation)
REPO_URL	the git URL to clone the repository being built

Pull Requests presubmit also have the following values:

Mon, 01 Jan 0001 00:00:00 +0000

You can type the following ChatOps commands on Pull Requests as comments:

ChatOps Command	Description
`/lgtm`	This PR looks good to me - this command can be from anyone with access to the repo who is in the `OWNERS` file
`/approve`	This PR can be merged - must be someone in the repo `OWNERS` file
`/test this`	Run the default test pipeline context for this PR
`/test (context)`	Run a specific test pipeline context by name
`/retest`	Rerun any failed test pipeline contexts for this PR
`/override (context)`	Override a failed pipeline context
`/hold`	Set this PR to not automerge even if it has been set `lgtm` and approved
`/hold cancel`	remove the `hold` label from the PR, allowing automerge
`/assign (user)`	assign the PR to the given (`user`)
`/unassign (user)`	remove the `user` as assignee
`/cc (user)`	add the given `user` as a reviewer for the PR
`/uncc (user)`	remove the `user` as a reviewer
`/ok-to-test`	If a `user` without write access to the repo opens a PR, the PR will not be built automatically. It receives the `needs-ok-to-test` label, until a user with rights enters `/ok-to-test`, at which point it gets be built

Mon, 01 Jan 0001 00:00:00 +0000

You can browse the Command Line Reference online or you can use the jx CLI directly to get help:

jx --help

To get help about a particular plugin, such as gitops you can type:

jx gitops --help