options

Documentation

Index

• type FileConfig
• type GenericOptions
  • func NewGenericOptions() *GenericOptions
  • func (o *GenericOptions) AddFlags(fs *pflag.FlagSet, configGVK schema.GroupVersionKind)
  • func (o *GenericOptions) ApplyTo(cfg *FileConfig, defaultConfig, bootstrapOverrides Template, ...) error
  • func (o *GenericOptions) Complete() error
  • func (o *GenericOptions) FeatureGateManifests() (RenderedManifests, error)
  • func (o *GenericOptions) FeatureGates() (featuregates.FeatureGateAccess, error)
  • func (o *GenericOptions) FeatureSetName() (configv1.FeatureSet, error)
  • func (o *GenericOptions) ReadInputManifests() (RenderedManifests, error)
  • func (o *GenericOptions) Validate() error
• type ManifestConfig
• type ManifestOptions
  • func NewManifestOptions(componentName, image string) *ManifestOptions
  • func (o *ManifestOptions) AddFlags(fs *pflag.FlagSet, humanReadableComponentName string)
  • func (o *ManifestOptions) ApplyTo(cfg *ManifestConfig) error
  • func (o *ManifestOptions) Complete() error
  • func (o *ManifestOptions) Validate() error
• type RenderedManifest
  • func (c *RenderedManifest) GetDecodedObj() (runtime.Object, error)
• type RenderedManifests
  • func (renderedManifests RenderedManifests) GetManifest(gvk schema.GroupVersionKind, namespace, name string) (RenderedManifest, error)
  • func (renderedManifests RenderedManifests) GetObject(gvk schema.GroupVersionKind, namespace, name string) (runtime.Object, error)
  • func (renderedManifests RenderedManifests) ListManifestOfType(gvk schema.GroupVersionKind) []RenderedManifest
  • func (renderedManifests RenderedManifests) ValidateManifestPredictability() error
• type Template
• type TemplateData

Types

type FileConfig

type FileConfig struct {
	// BootstrapConfig holds the rendered control plane component config file for bootstrapping (phase 1).
	BootstrapConfig []byte

	// Assets holds the loaded assets like certs and keys.
	Assets map[string][]byte
}

type GenericOptions

type GenericOptions struct {
	DefaultFile                    string
	BootstrapOverrideFile          string
	AdditionalConfigOverrideFiles  []string
	RenderedManifestInputFilenames []string

	ConfigOutputFile string

	TemplatesDir   string
	AssetInputDir  string
	AssetOutputDir string

	PayloadVersion string
}

GenericOptions contains the generic render command options.

func NewGenericOptions

func NewGenericOptions() *GenericOptions

NewGenericOptions returns a default set of generic options.

func (*GenericOptions) AddFlags

func (o *GenericOptions) AddFlags(fs *pflag.FlagSet, configGVK schema.GroupVersionKind)

AddFlags adds the generic flags to the flagset.

func (*GenericOptions) ApplyTo

func (o *GenericOptions) ApplyTo(cfg *FileConfig, defaultConfig, bootstrapOverrides Template, templateData interface{}, specialCases map[string]resourcemerge.MergeFunc) error

ApplyTo applies the options to the given config struct using the provided text/template data.

func (*GenericOptions) Complete

func (o *GenericOptions) Complete() error

Complete fills in missing values before execution.

func (*GenericOptions) FeatureGateManifests

func (o *GenericOptions) FeatureGateManifests() (RenderedManifests, error)

FeatureGateManifests is exposed for usage in getting FeatureGateAccess and for convenient by cluster-config-operator

func (*GenericOptions) FeatureGates

func (o *GenericOptions) FeatureGates() (featuregates.FeatureGateAccess, error)

func (*GenericOptions) FeatureSetName

func (o *GenericOptions) FeatureSetName() (configv1.FeatureSet, error)

func (*GenericOptions) ReadInputManifests

func (o *GenericOptions) ReadInputManifests() (RenderedManifests, error)

func (*GenericOptions) Validate

func (o *GenericOptions) Validate() error

Validate verifies the inputs.

type ManifestConfig

type ManifestConfig struct {
	// ConfigHostPath is a host path mounted into the controller manager pods to hold the config file.
	ConfigHostPath string

	// ConfigFileName is the filename of config file inside ConfigHostPath.
	ConfigFileName string

	// CloudProviderHostPath is a host path mounted into the apiserver pods to hold cloud provider configuration.
	CloudProviderHostPath string

	// SecretsHostPath holds certs and keys
	SecretsHostPath string

	// Namespace is the target namespace for the bootstrap controller manager to be created.
	Namespace string

	// Image is the pull spec of the image to use for the controller manager.
	Image string

	// OperatorImage is the pull spec of the image to use for the operator (optional).
	OperatorImage string

	// ImagePullPolicy specifies the image pull policy to use for the images.
	ImagePullPolicy string
}

ManifestConfig is a struct of values to be used in manifest templates.

type ManifestOptions

type ManifestOptions struct {
	Namespace             string
	Image, OperatorImage  string
	ImagePullPolicy       string
	ConfigHostPath        string
	ConfigFileName        string
	CloudProviderHostPath string
	SecretsHostPath       string
}

ManifestOptions contains the values that influence manifest contents.

func NewManifestOptions

func NewManifestOptions(componentName, image string) *ManifestOptions

NewManifestOptions return default values for ManifestOptions.

func (*ManifestOptions) AddFlags

func (o *ManifestOptions) AddFlags(fs *pflag.FlagSet, humanReadableComponentName string)

AddfFlags adds the manifest related flags to the flagset.

func (*ManifestOptions) ApplyTo

func (o *ManifestOptions) ApplyTo(cfg *ManifestConfig) error

ApplyTo applies the options ot the given config struct.

func (*ManifestOptions) Complete

func (o *ManifestOptions) Complete() error

Complete fills in missing values before execution.

func (*ManifestOptions) Validate

func (o *ManifestOptions) Validate() error

Validate verifies the inputs.

type RenderedManifest

type RenderedManifest struct {
	OriginalFilename string
	Content          []byte
	// contains filtered or unexported fields
}

func (*RenderedManifest) GetDecodedObj

func (c *RenderedManifest) GetDecodedObj() (runtime.Object, error)

type RenderedManifests

type RenderedManifests []RenderedManifest

func (RenderedManifests) GetManifest

func (renderedManifests RenderedManifests) GetManifest(gvk schema.GroupVersionKind, namespace, name string) (RenderedManifest, error)

func (RenderedManifests) GetObject

func (renderedManifests RenderedManifests) GetObject(gvk schema.GroupVersionKind, namespace, name string) (runtime.Object, error)

func (RenderedManifests) ListManifestOfType

func (renderedManifests RenderedManifests) ListManifestOfType(gvk schema.GroupVersionKind) []RenderedManifest

func (RenderedManifests) ValidateManifestPredictability

func (renderedManifests RenderedManifests) ValidateManifestPredictability() error

type Template

type Template struct {
	FileName string
	Content  []byte
}

type TemplateData

type TemplateData struct {
	ManifestConfig
	FileConfig
}