Jenkins X Requirements
Jenkins X Requirements YAML configuration file
| Type | Requirements |
|---|---|
| File match |
jx-requirements.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/jenkins-x-requirements/latest.json |
| Source | https://jenkins-x.io/schemas/jx-requirements.json |
Validate with Lintel
npx @lintel/lintel check
Type:
Requirements
Definitions
AutoUpdateConfig
object
enabled
boolean
schedule
string
autoMerge
boolean
AzureClusterNodesConfig
object
clientID
string
AzureConfig
object
AzureDNSConfig
object
tenantId
string
subscriptionId
string
resourceGroup
string
AzureSecretConfig
object
keyVaultName
string
AzureStorageConfig
object
storageAccountName
string
ClusterConfig
object
chartRepository
string
chartKind
string
chartSecret
string
registry
string
dockerRegistryOrg
string
kanikoFlags
string
environmentGitOwner
string
azure
object
5 nested properties
gke
object
1 nested properties
projectNumber
string
environmentGitPublic
boolean
gitPublic
boolean
provider
string
project
string
clusterName
string
region
string
zone
string
gitName
string
gitKind
string
gitServer
string
externalDNSSAName
string
kanikoSAName
string
EnvironmentConfig
object
key
string
owner
string
repository
string
gitServer
string
gitKind
string
gitUrl
string
ingress
object
9 nested properties
apiVersion
string
externalDNS
boolean
cloud_dns_secret_name
string
domain
string
kind
string
ignoreLoadBalancer
boolean
namespaceSubDomain
string
tls
object
4 nested properties
enabled
boolean
email
string
production
boolean
secretName
string
annotations
Record<string, string>
remoteCluster
boolean
promotionStrategy
string
reusePullRequest
boolean
namespace
string
GKEConfig
object
projectNumber
string
IngressConfig
object
apiVersion
string
externalDNS
boolean
cloud_dns_secret_name
string
domain
string
kind
string
ignoreLoadBalancer
boolean
namespaceSubDomain
string
tls
object
4 nested properties
enabled
boolean
email
string
production
boolean
secretName
string
annotations
Record<string, string>
IssueTracker
object
jira
object
3 nested properties
serverUrl
string
userName
string
project
string
JiraTracker
object
serverUrl
string
userName
string
project
string
MavenRepositoryConfig
object
releaseUrl
string
snapshotUrl
string
RepositoryConfig
object
maven
object
2 nested properties
releaseUrl
string
snapshotUrl
string
Requirements
object
kind
string
apiVersion
string
spec
object
15 nested properties
autoUpdate
object
3 nested properties
enabled
boolean
schedule
string
autoMerge
boolean
cluster
object
22 nested properties
chartRepository
string
chartKind
string
chartSecret
string
registry
string
dockerRegistryOrg
string
kanikoFlags
string
environmentGitOwner
string
azure
object
gke
object
environmentGitPublic
boolean
gitPublic
boolean
provider
string
project
string
clusterName
string
region
string
zone
string
gitName
string
gitKind
string
gitServer
string
externalDNSSAName
string
kanikoSAName
string
issueProvider
object
environments
EnvironmentConfig[]
extraDomains
IngressConfig[]
ingress
object
9 nested properties
apiVersion
string
externalDNS
boolean
cloud_dns_secret_name
string
domain
string
kind
string
ignoreLoadBalancer
boolean
namespaceSubDomain
string
tls
object
annotations
Record<string, string>
kuberhealthy
boolean
pipelineUser
object
2 nested properties
username
string
email
string
repository
string
secretStorage
string
storage
StorageConfig[]
terraform
boolean
terraformVault
boolean
vault
object
webhook
string
RequirementsConfig
object
autoUpdate
object
3 nested properties
enabled
boolean
schedule
string
autoMerge
boolean
cluster
object
22 nested properties
chartRepository
string
chartKind
string
chartSecret
string
registry
string
dockerRegistryOrg
string
kanikoFlags
string
environmentGitOwner
string
azure
object
gke
object
1 nested properties
projectNumber
string
environmentGitPublic
boolean
gitPublic
boolean
provider
string
project
string
clusterName
string
region
string
zone
string
gitName
string
gitKind
string
gitServer
string
externalDNSSAName
string
kanikoSAName
string
environments
EnvironmentConfig[]
extraDomains
IngressConfig[]
ingress
object
9 nested properties
apiVersion
string
externalDNS
boolean
cloud_dns_secret_name
string
domain
string
kind
string
ignoreLoadBalancer
boolean
namespaceSubDomain
string
tls
object
4 nested properties
enabled
boolean
email
string
production
boolean
secretName
string
annotations
Record<string, string>
kuberhealthy
boolean
pipelineUser
object
2 nested properties
username
string
email
string
repository
string
repositories
object
1 nested properties
maven
object
2 nested properties
releaseUrl
string
snapshotUrl
string
secretStorage
string
storage
StorageConfig[]
terraform
boolean
terraformVault
boolean
vault
object
13 nested properties
name
string
bucket
string
recreateBucket
boolean
keyring
string
key
string
disableURLDiscovery
boolean
aws
object
9 nested properties
kmsKeyId
string
kmsRegion
string
s3Bucket
string
s3Prefix
string
s3Region
string
autoCreate
boolean
dynamoDBTable
string
dynamoDBRegion
string
iamUserName
string
azure
object
5 nested properties
tenantId
string
vaultName
string
keyName
string
storageAccountName
string
containerName
string
url
string
serviceAccount
string
namespace
string
secretEngineMountPoint
string
kubernetesAuthPath
string
webhook
string
StorageConfig
object
name
string
url
string
TLSConfig
object
enabled
boolean
email
string
production
boolean
secretName
string
UserNameEmailConfig
object
username
string
email
string
VaultAWSConfig
object
kmsKeyId
string
kmsRegion
string
s3Bucket
string
s3Prefix
string
s3Region
string
autoCreate
boolean
dynamoDBTable
string
dynamoDBRegion
string
iamUserName
string
VaultAzureConfig
object
tenantId
string
vaultName
string
keyName
string
storageAccountName
string
containerName
string
VaultConfig
object
name
string
bucket
string
recreateBucket
boolean
keyring
string
key
string
disableURLDiscovery
boolean
aws
object
9 nested properties
kmsKeyId
string
kmsRegion
string
s3Bucket
string
s3Prefix
string
s3Region
string
autoCreate
boolean
dynamoDBTable
string
dynamoDBRegion
string
iamUserName
string
azure
object
5 nested properties
tenantId
string
vaultName
string
keyName
string
storageAccountName
string
containerName
string
url
string
serviceAccount
string
namespace
string
secretEngineMountPoint
string
kubernetesAuthPath
string