config.md

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

Packages:

• gitops.jenkins-x.io/v1alpha1

gitops.jenkins-x.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• KptStrategies
• SecretMapping
• SourceConfig

KptStrategies

KptStrategies contains a collection of merge strategies Jenkins X will use when performing kpt updates

Field	Description
apiVersion string	gitops.jenkins-x.io/v1alpha1
kind string	KptStrategies
config []KptStrategyConfig	KptStrategyConfig contains a collection of merge strategies Jenkins X will use when performing kpt updates

SecretMapping

SecretMapping represents a collection of mappings of Secrets to destinations in the underlying secret store (e.g. Vault keys)

Field	Description
apiVersion string	gitops.jenkins-x.io/v1alpha1
kind string	SecretMapping
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SecretMappingSpec	(Optional) Spec holds the desired state of the SecretMapping from the client secrets []SecretRule Secrets rules for each secret defaults Defaults

SourceConfig

SourceConfig represents a collection source repostory groups and repositories

Field	Description
apiVersion string	gitops.jenkins-x.io/v1alpha1
kind string	SourceConfig
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SourceConfigSpec	(Optional) Spec holds the desired state of the SourceConfig from the client groups []RepositoryGroup Groups the groups of source repositories scheduler string Scheduler the default scheduler for any group/repository which does not specify one

BackendType (string alias)

(Appears on: Defaults, SecretRule)

BackendType describes a secrets backend

Defaults

(Appears on: SecretMappingSpec)

Defaults contains default mapping configuration for any Kubernetes secrets to External Secrets

Field	Description
backendType BackendType	DefaultBackendType the default back end to use if there’s no specific mapping
gcpSecretsManager GcpSecretsManager	GcpSecretsManager config

GcpSecretsManager

(Appears on: Defaults, SecretRule)

GcpSecretsManager the predicates which must be true to invoke the associated tasks/pipelines

Field	Description
version string	Version of the referenced secret
projectId string	ProjectId for the secret, defaults to the current GCP project
uniquePrefix string	UniquePrefix needs to be a unique prefix in the GCP project where the secret resides, defaults to cluster name

JenkinsConfig

(Appears on: Repository, RepositoryGroup)

JenkinsConfig the Jenkins configuration for a group or repository if applicable

Field	Description
xmlTemplate string	XmlTemplate the configuration template file to use to generate the projects XML configuration file
server string	Server the name of the Jenkins Server to use

KptStrategyConfig

(Appears on: KptStrategies)

KptStrategyConfig used by jx gitops upgrade kpt

Field	Description
relativePath string	RelativePath the relative path to the folder the strategy should apply to
strategy string	Strategy is the merge strategy kpt will use see https://googlecontainertools.github.io/kpt/reference/pkg/update/#flags

Mapping

(Appears on: SecretRule)

Mapping the predicates which must be true to invoke the associated tasks/pipelines

Field	Description
name string	Name the secret entry name which maps to the Key of the Secret.Data map
key string	(Optional) Key the Vault key to load the secret value
property string	(Optional) Property the Vault property on the key to load the secret value

Repository

(Appears on: RepositoryGroup)

Repository the name of the repository to import and the optional scheduler

Field	Description
name string	Name the name of the repository
scheduler string	Scheduler the optional name of the scheduler to use if different to the group
jenkins JenkinsConfig	Jenkins the jenkins configuration if using Jenkins
description string	Description the optional description of this repository
url string	URL the URL to access this repository
httpCloneURL string	HTTPCloneURL the HTTP/HTTPS based clone URL
sshCloneURL string	SSHCloneURL the SSH based clone URL

RepositoryGroup

(Appears on: SourceConfigSpec)

SourceConfigSpec defines the desired state of SourceConfig.

Field	Description
provider string	Provider the git provider server URL
providerKind string	ProviderKind the git provider kind
providerName string	ProviderName the git provider name
owner string	Owner the name of the organisation/owner/project/user that owns the repository
repositories []Repository	Repositories the repositories for the
scheduler string	Scheduler the default scheduler for this group
jenkins JenkinsConfig	Jenkins the jenkins configuration if using Jenkins

SecretMappingSpec

(Appears on: SecretMapping)

SecretMappingSpec defines the desired state of SecretMapping.

Field	Description
secrets []SecretRule	Secrets rules for each secret
defaults Defaults

SecretRule

(Appears on: SecretMappingSpec)

SecretRule the rules for a specific Secret

Field	Description
name string	Name name of the secret
namespace string	Namespace name of the secret
backendType BackendType	BackendType for the secret
mappings []Mapping	Mappings one more mappings
mandatory bool	Mandatory marks this secret as being mandatory
gcpSecretsManager GcpSecretsManager	GcpSecretsManager config

SourceConfigSpec

(Appears on: SourceConfig)

SourceConfigSpec defines the desired state of SourceConfig.

Field	Description
groups []RepositoryGroup	Groups the groups of source repositories
scheduler string	Scheduler the default scheduler for any group/repository which does not specify one

---

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