available

Documentation

Index

• func NewCmd() *cobra.Command
• func NewGetCmd(o *GetOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command
• func NewListCmd(o *ListOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command
• type DataValueProperty
• type GetOptions
  • func NewGetOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, ...) *GetOptions
  • func (o *GetOptions) Run(args []string) error
• type ListOptions
  • func NewListOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, ...) *ListOptions
  • func (o *ListOptions) Run(args []string) error
• type PackageSchema
  • func (s PackageSchema) DefaultValues() ([]byte, error)
• type PackageValuesSchemaParser
  • func NewValuesSchemaParser(valuesSchema v1alpha1.ValuesSchema) (*PackageValuesSchemaParser, error)
  • func (parser *PackageValuesSchemaParser) ParseProperties() ([]DataValueProperty, error)

Functions

func NewCmd

func NewCmd() *cobra.Command

func NewGetCmd

func NewGetCmd(o *GetOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command

func NewListCmd

func NewListCmd(o *ListOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command

Types

type DataValueProperty

type DataValueProperty struct {
	Key         string
	Type        string
	Description string
	Default     interface{}
}

DataValueProperty holds the details of each property under Carvel package.spec.valuesSchema.openAPIv3.properties. The example of the schema could be found at: https://carvel.dev/kapp-controller/docs/latest/packaging/#package-1 From above example, we would have the following:

DataValueProperty.Key = "namespace"
DataValueProperty.Type = "string"
DataValueProperty.Description = "Namespace where fluent-bit will be installed."
DataValueProperty.Default = "fluent-bit"

type GetOptions

type GetOptions struct {
	NamespaceFlags cmdcore.NamespaceFlags
	Name           string

	ValuesSchema      bool
	DefaultValuesFile string
	// contains filtered or unexported fields
}

func NewGetOptions

func NewGetOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts, columns *[]string) *GetOptions

func (*GetOptions) Run

func (o *GetOptions) Run(args []string) error

type ListOptions

type ListOptions struct {
	NamespaceFlags cmdcore.NamespaceFlags
	AllNamespaces  bool

	Name string

	Summary bool
	Wide    bool
	// contains filtered or unexported fields
}

func NewListOptions

func NewListOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts, columns *[]string) *ListOptions

func (*ListOptions) Run

func (o *ListOptions) Run(args []string) error

type PackageSchema

type PackageSchema struct {
	Raw []byte
}

func (PackageSchema) DefaultValues

func (s PackageSchema) DefaultValues() ([]byte, error)

DefaultValues returns a yaml byte array with values populated according to schema

type PackageValuesSchemaParser

type PackageValuesSchemaParser struct {
	Doc                 *openapi3.T
	DataValueProperties []DataValueProperty
	// contains filtered or unexported fields
}

PackageValuesSchemaParser loads Carvel package values schema and extract property details

func NewValuesSchemaParser

func NewValuesSchemaParser(valuesSchema v1alpha1.ValuesSchema) (*PackageValuesSchemaParser, error)

func (*PackageValuesSchemaParser) ParseProperties

func (parser *PackageValuesSchemaParser) ParseProperties() ([]DataValueProperty, error)

ParseProperties parses the loaded doc and feed the details into []DataValueProperty