v1alpha1

Documentation

Overview

+k8s:deepcopy-gen=package +k8s:openapi-gen=true Package v1alpha1 is the v1alpha1 version of the API. +groupName=secret.jenkins-x.io

Index

• Constants
• type Object
• type Property
• type Schema
• type SchemaList
• type SchemaSpec

Constants

const (
	LabelKind = "kind"
)

Types

type Object

type Object struct {
	// Name the name of the object kind
	Name string `yaml:"name" validate:"nonzero"`

	// Properties the property definitions
	Properties []Property `yaml:"properties"`
}

Object defines a type of object with some properties

type Property

type Property struct {
	// Name the name of the property
	Name string `yaml:"name" validate:"nonzero"`

	// Question the main prompt generated in a user interface when asking to populate the property
	Question string `yaml:"question" validate:"nonzero"`

	// Help the tooltip or help text for this property
	Help string `yaml:"help"`

	// DefaultValue is used to specify default values populated on startup
	DefaultValue string `yaml:"defaultValue,omitempty"`

	// Pattern is a regular expression pattern used for validation
	Pattern string `yaml:"pattern,omitempty"`

	// Requires specifies a requirements expression
	Requires string `yaml:"requires,omitempty"`

	// Format the format of the value
	Format string `yaml:"format,omitempty"`

	// Generator the name of the generator to use to create values
	// if this value is non zero we assume Generate is effectively true
	Generator string `yaml:"generator,omitempty"`

	// Labels allows arbitrary metadata labels to be associated with the property
	Labels map[string]string `yaml:"labels,omitempty"`

	// MinLength the minimum number of characters in the value
	MinLength int `yaml:"minLength,omitempty"`

	// MaxLength the maximum number of characters in the value
	MaxLength int `yaml:"maxLength,omitempty"`

	// Mask whether a mask is used on input
	Mask bool `yaml:"mask,omitempty"`
}

Property defines a property in an object

type Schema

type Schema struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata"`

	// Spec the schema specification
	Spec SchemaSpec `yaml:"spec"`
}

Schema defines a schema of objects with properties

+k8s:openapi-gen=true

type SchemaList

type SchemaList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Schema `json:"items"`
}

SchemaList contains a list of Schema objects

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

type SchemaSpec

type SchemaSpec struct {
	Objects []Object `yaml:"objects"`
}

SchemaSpec defines the objects and their properties