generate

Documentation

Index

• func Components(name string) []string
• func GenerateComponent(ctx context.Context, kind string, name string, cfg *Schematic) error
• func GeneratePlatform(ctx context.Context, name string) error
• func Platforms() []string
• type Schematic
  • func NewSchematic(root string, name string) (*Schematic, error)
  • func (s *Schematic) FlagSet() *flag.FlagSet

Functions

func Components

func Components(name string) []string

Components returns a slice of embedded component schematics or nil if there are none.

func GenerateComponent

func GenerateComponent(ctx context.Context, kind string, name string, cfg *Schematic) error

GenerateComponent writes the cue code for a component to the local working directory.

func GeneratePlatform

func GeneratePlatform(ctx context.Context, name string) error

GeneratePlatform writes the cue code for a platform to the local working directory.

func Platforms

func Platforms() []string

Platforms returns a slice of embedded platforms or nil if there are none.

Types

type Schematic

type Schematic struct {
	// Name represents the name of the resource the schematic generates.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	Short string `json:"short,omitempty" yaml:"short,omitempty"`
	Long  string `json:"long,omitempty" yaml:"long,omitempty"`

	Chart     *string `json:"chart,omitempty" yaml:"chart,omitempty"`
	Version   *string `json:"version,omitempty" yaml:"version,omitempty"`
	Namespace *string `json:"namespace,omitempty" yaml:"namespace,omitempty"`

	RepoName *string `json:"reponame,omitempty" yaml:"reponame,omitempty"`
	RepoURL  *string `json:"repourl,omitempty" yaml:"repourl,omitempty"`
	// contains filtered or unexported fields
}

Schematic represents the flags and command metadata stored in the schematic.yaml file along side each schematic.

func NewSchematic

func NewSchematic(root string, name string) (*Schematic, error)

func (*Schematic) FlagSet

func (s *Schematic) FlagSet() *flag.FlagSet