values

Documentation

Index

• type Image
• type UserContainerValues
• type UserHelmValues
• type UserJsonSchema
• type UserOperatorValues
  • func (o UserOperatorValues) FormattedName() string
• type UserValues
• type UserValuesInlineDocs
  • func (u *UserValuesInlineDocs) Enabled() bool
  • func (u *UserValuesInlineDocs) LineLength() int

Types

type Image

type Image struct {
	Tag        string        `json:"tag,omitempty" desc:"Version tag for the container image."`
	Repository string        `json:"repository,omitempty" desc:"Image name (repository)."`
	Registry   string        `json:"registry,omitempty" desc:"Image registry."`
	PullPolicy v1.PullPolicy `json:"pullPolicy,omitempty" desc:"Image pull policy."`
	PullSecret string        `json:"pullSecret,omitempty" desc:"Image pull secret."`
}

this image type is shared with the skv2 Chart model

type UserContainerValues

type UserContainerValues struct {
	Image           Image                    `json:"image" desc:"Container image."`
	Env             []v1.EnvVar              `` /* 220-byte string literal not displayed */
	ExtraEnvs       struct{}                 `json:"extraEnvs" desc:"Extra environment variables for the container"`
	Resources       *v1.ResourceRequirements `` /* 236-byte string literal not displayed */
	SecurityContext *v1.SecurityContext      `` /* 286-byte string literal not displayed */
}

document values structure for a container

type UserHelmValues

type UserHelmValues struct {
	Operators        []UserOperatorValues
	CustomValues     interface{}
	ValuesInlineDocs *UserValuesInlineDocs
	JsonSchema       UserJsonSchema
}

used to document the values structure of the generated Helm Chart

type UserJsonSchema

type UserJsonSchema struct {
	CustomTypeMapper func(reflect.Type, map[string]interface{}) interface{}
}

type UserOperatorValues

type UserOperatorValues struct {
	Name                   string
	ValuesFileNameOverride string
	ValuePath              string
	Values                 UserValues
	CustomValues           interface{}
}

func (UserOperatorValues) FormattedName

func (o UserOperatorValues) FormattedName() string

type UserValues

type UserValues struct {
	UserContainerValues `json:",inline"`

	// Required to have an interface value in order to use the `index` function in the template
	Sidecars       map[string]UserContainerValues `json:"sidecars" desc:"Optional configuration for the deployed containers."`
	FloatingUserID bool                           `json:"floatingUserId" desc:"Allow the pod to be assigned a dynamic user ID. Required for OpenShift installations."`
	RunAsUser      uint32                         `json:"runAsUser" desc:"Static user ID to run the containers as. Unused if floatingUserId is 'true'."`
	ServiceType    v1.ServiceType                 `` /* 132-byte string literal not displayed */
	ServicePorts   map[string]uint32              `json:"ports" desc:"Service ports as a map from port name to port number."`

	// Overrides which can be set by the user
	DeploymentOverrides *appsv1.Deployment `` /* 202-byte string literal not displayed */
	ServiceOverrides    *v1.Service        `` /* 193-byte string literal not displayed */

	Enabled bool `json:"enabled" desc:"Enable creation of the deployment/service."`
}

document values structure for an operator

type UserValuesInlineDocs

type UserValuesInlineDocs struct {
	LineLengthLimit int
}

func (*UserValuesInlineDocs) Enabled

func (u *UserValuesInlineDocs) Enabled() bool

func (*UserValuesInlineDocs) LineLength

func (u *UserValuesInlineDocs) LineLength() int