Skip to content

config.md

Latest commit

 

History

History
1751 lines (1751 loc) · 26.9 KB

config.md

File metadata and controls

1751 lines (1751 loc) · 26.9 KB
Raw
title API Documentation
linktitle API Documentation
description Reference of the jx-promote configuration
weight 10

Packages:

gitops.jenkins-x.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

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

PipelineCatalog

PipelineCatalog represents a collection quickstart project

Field Description
apiVersion
string		 gitops.jenkins-x.io/v1alpha1
kind
string 		PipelineCatalog
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PipelineCatalogSpec 		(Optional)

Spec holds the desired state of the PipelineCatalog from the client



repositories
[]PipelineCatalogSource

Repositories the repositories containing pipeline catalogs

Quickstarts

Quickstarts represents a collection quickstart project

Field Description
apiVersion
string		 gitops.jenkins-x.io/v1alpha1
kind
string 		Quickstarts
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
QuickstartsSpec 		(Optional)

Spec holds the specified quicksatrt configuration



quickstarts
[]QuickstartSource

Quickstarts custom quickstarts to include
defaultOwner
string

DefaultOwner the default owner if not specfied
imports
[]QuickstartImport

Imports import quickstarts from the version stream

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
slack
SlackNotify

Slack optional default slack notification configuration inherited by groups
jenkinsServers
[]JenkinsServer

JenkinsServers the jenkins servers configured for this repository
jenkinsFolderTemplate
string

JenkinsFolderTemplate the default template file to use to generate the folder job DSL script
jenkinsJobTemplate
string

JenkinsJobTemplate the default template file to use to generate the projects job DSL script

BackendType (string alias)

(Appears on: Defaults, SecretRule)

BackendType describes a secrets backend

BooleanFlag (string alias)

(Appears on: SlackNotify)

BooleanFlag a type that is used for string boolean values that can be blank or yes/no

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

JenkinsServer

(Appears on: SourceConfigSpec)

JenkinsServer the Jenkins server configuration

Field Description
server
string

Server the name of the Jenkins Server to use
folderTemplate
string

FolderTemplate the default template file to use to generate the folder job DSL script
jobTemplate
string

JobTemplate the default template file to use to generate the projects job DSL script
groups
[]RepositoryGroup

Groups the groups of source repositories

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://kpt.dev/reference/cli/pkg/update/?id=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

NotifyKind (string alias)

(Appears on: SlackNotify)

NotifyKind what kind of notification

Pattern

(Appears on: SlackNotify)

Pattern for matching strings

Field Description
name
string

Name
include
[]string

Includes patterns to include in changing
exclude
[]string

Excludes patterns to exclude from upgrading

PipelineCatalogSource

(Appears on: PipelineCatalogSpec)

PipelineCatalogSource the source of a pipeline catalog

Field Description
id
string
label
string
gitUrl
string
gitRef
string

PipelineCatalogSpec

(Appears on: PipelineCatalog)

PipelineCatalogSpec defines the desired state of PipelineCatalog.

Field Description
repositories
[]PipelineCatalogSource

Repositories the repositories containing pipeline catalogs

PipelineKind (string alias)

(Appears on: SlackNotify)

PipelineKind what pipeline to notify on

QuickstartImport

(Appears on: QuickstartsSpec)

QuickstartImport imports quickstats from another folder (such as from the shared version stream)

Field Description
file
string

File file name relative to the root directory to load
includes
[]string
excludes
[]string

QuickstartSource

(Appears on: QuickstartsSpec)

QuickstartSource the source of a quickstart

Field Description
ID
string
Owner
string
Name
string
Version
string
Language
string
Framework
string
Tags
[]string
DownloadZipURL
string
GitServer
string
GitKind
string

QuickstartsSpec

(Appears on: Quickstarts)

QuickstartsSpec defines the desired state of Quickstarts.

Field Description
quickstarts
[]QuickstartSource

Quickstarts custom quickstarts to include
defaultOwner
string

DefaultOwner the default owner if not specfied
imports
[]QuickstartImport

Imports import quickstarts from the version stream

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
jenkinsJobTemplate
string

JenkinsJobTemplate the template file to use to generate the projects job DSL script
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
slack
SlackNotify

Slack optional slack notification configuration

RepositoryGroup

(Appears on: JenkinsServer, 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
jenkinsFolderTemplate
string

JenkinsFolderTemplate the default template file to use to generate the folder job DSL script
jenkinsJobTemplate
string

JenkinsJobTemplate the default job template file to use to generate the projects job DSL script
slack
SlackNotify

Slack optional slack notification configuration
settings
github.com/jenkins-x/jx-api/v4/pkg/apis/core/v4beta1.SettingsConfig

Settings optional settings for repositories in this group
name
string

Name optional field to distinguish repository groups between for example different teams. Not used by jx gitops

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

SlackNotify

(Appears on: Repository, RepositoryGroup, SourceConfigSpec)

SlackNotify the slack notification configuration

Field Description
channel
string

Channel the name of the channel to notify pipelines
kind
NotifyKind

Kind kind of notification such as always, only failures, failures or first succeed, only succeeds etc
pipeline
PipelineKind

Pipeline kind of pipeline to notify on (all, releases, pull requests etc)
directMessage
BooleanFlag

DirectMessage whether to use Direct Messages
notifyReviewers
BooleanFlag

NotifyReviewers whether to notify reviews of Pull Request pipelines
branch
Pattern

Branch specify the branch name or filter to notify
context
Pattern

Context specify the context name or filter to notify
pullRequestLabel
Pattern

PullRequestLabel specify the pull request labels to notify

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
slack
SlackNotify

Slack optional default slack notification configuration inherited by groups
jenkinsServers
[]JenkinsServer

JenkinsServers the jenkins servers configured for this repository
jenkinsFolderTemplate
string

JenkinsFolderTemplate the default template file to use to generate the folder job DSL script
jenkinsJobTemplate
string

JenkinsJobTemplate the default template file to use to generate the projects job DSL script

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