schema.md

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

Packages:

• secret.jenkins-x.io/v1alpha1

secret.jenkins-x.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• Schema

Schema

Schema defines a schema of objects with properties

Field	Description
apiVersion string	secret.jenkins-x.io/v1alpha1
kind string	Schema
metadata Kubernetes meta/v1.ObjectMeta	(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
Spec SchemaSpec	Spec the schema specification

Object

(Appears on: SchemaSpec)

Object defines a type of object with some properties

Field	Description
name string	Name the name of the object kind
properties []Property	Properties the property definitions
mandatory bool	Mandatory marks this secret as being mandatory to be setup before we can install a cluster

Property

(Appears on: Object)

Property defines a property in an object

Field	Description
name string	Name the name of the property
question string	Question the main prompt generated in a user interface when asking to populate the property
help string	Help the tooltip or help text for this property
defaultValue string	DefaultValue is used to specify default values populated on startup
pattern string	Pattern is a regular expression pattern used for validation
requires string	Requires specifies a requirements expression
format string	Format the format of the value
generator string	Generator the name of the generator to use to create values if this value is non zero we assume Generate is effectively true
template string	Template the go template used to generate the value of this secret if we need to combine multiple secret values together into a composite secret value. For example if we want to create a maven-settings.xml file or a docker config JSON document made up of lots of static text but some real secrets embedded we can define the template in the schema
onlyTemplateIfBlank bool	OnlyTemplateIfBlank if this is true then lets only regenerate a template value if the current value is empty
retry bool	Retry enable a retry loop if a template does not evaluate correctly first time
labels map[string]string	Labels allows arbitrary metadata labels to be associated with the property
minLength int	MinLength the minimum number of characters in the value
maxLength int	MaxLength the maximum number of characters in the value
noMask bool	NoMask whether to exclude from Secret masking in logs

SchemaSpec

(Appears on: Schema)

SchemaSpec defines the objects and their properties

Field	Description
Objects []Object	Objects the list of objects (or kinds) in the schema

---

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