config.md

title	linktitle	description	weight
API Documentation	API Documentation	Reference of the jx-promote configuration	10

Packages:

• promote.jenkins-x.io/v1alpha1

promote.jenkins-x.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• Promote

Promote

Promote represents the boot configuration

Field	Description
apiVersion string	promote.jenkins-x.io/v1alpha1
kind string	Promote
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PromoteSpec	(Optional) Spec holds the boot configuration fileRule FileRule File specifies a promotion rule for a File such as for a Makefile or shell script helmRule HelmRule HelmRule specifies a composite helm chart to promote to by adding the app to the charts ‘requirements.yaml’ file helmfileRule HelmfileRule HelmfileRule specifies the location of the helmfile to promote into kptRule KptRule KptRule specifies to fetch the apps resource via kpt : https://googlecontainertools.github.io/kpt/

FileRule

(Appears on: PromoteSpec)

FileRule specifies how to modify a ‘Makefile` or shell script to add a new helm/kpt style command

Field	Description
path string	Path the path to the Makefile or shell script to modify. This is mandatory
linePrefix string	LinePrefix adds a prefix to lines. e.g. for a Makefile that is typically “\t”
insertAfter []LineMatcher	InsertAfter finds the last line to match against to find where to insert
updateTemplate LineMatcher	UpdateTemplate matches line to perform upgrades to an app
commandTemplate string	CommandTemplate the command template for the promote command

HelmRule

(Appears on: PromoteSpec)

HelmRule specifies which chart to add the app to the Chart’s ‘requirements.yaml’ file

Field	Description
path string	Path to the chart folder (which should contain Chart.yaml and requirements.yaml)

HelmfileRule

(Appears on: PromoteSpec)

HelmfileRule specifies which ‘helmfile.yaml’ file to use to promote the app into

Field	Description
path string	Path to the helmfile to modify
namespace string	Namespace if specified the given namespace is used in the helmfile.yml file when using Environments in the same cluster using the same git repository URL as the dev environment
keepOldReleases bool	KeepOldReleases if specified will cause the old releases to be retailed in the helfile Deprecated : use KeepOldVersions
keepOldVersions []string	KeepOldVersions if specified is a list of release names and if the release name is in this list then the old versions are kept

KptRule

(Appears on: PromoteSpec)

KptRule specifies to fetch the apps resource via kpt : https://googlecontainertools.github.io/kpt/

Field	Description
path string	Path specifies the folder to fetch kpt resources into. For example if the ‘config-root” directory contains a Config Sync git layout we may want applications to be deployed into the config-root/namespaces/myapps folder. If so set the path to config-root/namespaces/myapps

LineMatcher

(Appears on: FileRule)

LineMatcher specifies a rule on how to find a line to match

Field	Description
prefix string	Prefix the prefix of a line to match
regex string	Regex the regex of a line to match

PromoteSpec

(Appears on: Promote)

PromoteSpec defines the desired state of Promote.

Field	Description
fileRule FileRule	File specifies a promotion rule for a File such as for a Makefile or shell script
helmRule HelmRule	HelmRule specifies a composite helm chart to promote to by adding the app to the charts ‘requirements.yaml’ file
helmfileRule HelmfileRule	HelmfileRule specifies the location of the helmfile to promote into
kptRule KptRule	KptRule specifies to fetch the apps resource via kpt : https://googlecontainertools.github.io/kpt/

---

Generated with gen-crd-api-reference-docs on git commit bd71f32.