install

Documentation

Overview

Package install implements the install command in liqoctl.

Index

• Constants
• func ValuesWarning(values map[string]interface{}) ([]string, error)
• type CommonOptions
• type Options
  • func NewOptions(f *factory.Factory, commandName string) *Options
  • func (o *Options) Run(ctx context.Context, provider Provider) error
• type Provider

Constants

const (

	// LiqoReleaseName indicates the default release name when installing the Liqo chart.
	LiqoReleaseName = "liqo"

	// DefaultDumpValuesPath is the default path where the helm values file is written.
	DefaultDumpValuesPath = "./values.yaml"
)

Functions

func ValuesWarning

func ValuesWarning(values map[string]interface{}) ([]string, error)

ValuesWarning checks the values map and returns a list of warnings.

Types

type CommonOptions

type CommonOptions struct {
	*factory.Factory
	CommandName string

	Version   string
	RepoURL   string
	ChartPath string

	OverrideValues       []string
	OverrideStringValues []string
	OverrideValuesFiles  []string

	DryRun           bool
	OnlyOutputValues bool
	ValuesPath       string

	Timeout time.Duration

	ClusterID     liqov1beta1.ClusterID
	ClusterLabels map[string]string

	EnableMetrics    bool
	DisableTelemetry bool

	ReservedSubnets []string

	DisableAPIServerSanityChecks bool
	DisableAPIServerDefaulting   bool
	SkipValidation               bool

	DisableKernelVersionCheck bool
	// contains filtered or unexported fields
}

CommonOptions encapsulates common arguments (not modified by providers) of the install command.

type Options

type Options struct {
	*CommonOptions

	APIServer   string
	PodCIDR     string
	ServiceCIDR string
}

Options encapsulates the arguments of the install command.

func NewOptions

func NewOptions(f *factory.Factory, commandName string) *Options

NewOptions returns a new Options struct.

func (*Options) Run

func (o *Options) Run(ctx context.Context, provider Provider) error

Run implements the install command.

type Provider

type Provider interface {
	// Name returns the name of the given provider.
	Name() string
	// Examples returns the examples string for the given provider.
	Examples() string

	// RegisterFlags registers the flags for the given provider.
	RegisterFlags(cmd *cobra.Command)

	// Initialize performs the initialization tasks to retrieve the provider-specific parameters.
	Initialize(ctx context.Context) error
	// Values returns the customized provider-specifc values file parameters.
	Values() map[string]interface{}
}

Provider defines the interface for an install provider.