repository

Documentation

Index

• func Init() error
• func Install(repo string, force bool, branch string) error
• func List() (string, error)
• func Search(name string) (string, error)
• type Component
  • func (c *Component) String() string
• type ComponentCommand
  • func (cc *ComponentCommand) String() string
• type ComponentVersion
  • func GetModule(repoName, moduleName, moduleVersion string) (*ComponentVersion, error)
  • func (cv *ComponentVersion) String() string
• type V1

Functions

func Init

func Init() error

func Install

func Install(repo string, force bool, branch string) error

func List

func List() (string, error)

func Search

func Search(name string) (string, error)

Types

type Component

type Component struct {
	Name     string             `yaml:"name"`
	Type     string             `yaml:"type"`
	Versions []ComponentVersion `yaml:"versions"`
}

Component struct is main element in repository identifying component and gathering all versions of it

func (*Component) String

func (c *Component) String() string

type ComponentCommand

type ComponentCommand struct {
	Name        string            `yaml:"name"`
	Description string            `yaml:"description"`
	Command     string            `yaml:"command"`
	Envs        map[string]string `yaml:"envs"`
	Args        []string          `yaml:"args"`
}

ComponentCommand struct contains information about specific command provided by component to be executed

func (*ComponentCommand) String

func (cc *ComponentCommand) String() string

type ComponentVersion

type ComponentVersion struct {
	Name          string             `yaml:"-"`
	Type          string             `yaml:"-"`
	Version       string             `yaml:"version"`
	IsLatest      bool               `yaml:"latest"`
	Image         string             `yaml:"image"`
	WorkDirectory string             `yaml:"workdir"`
	Mounts        []string           `yaml:"mounts"`
	Shared        string             `yaml:"shared"`
	Commands      []ComponentCommand `yaml:"commands"`
}

ComponentVersion struct contains information about version of component available to be installed

func GetModule

func GetModule(repoName, moduleName, moduleVersion string) (*ComponentVersion, error)

func (*ComponentVersion) String

func (cv *ComponentVersion) String() string

type V1

type V1 struct {
	Version    string      `yaml:"version"`
	Kind       string      `yaml:"kind"`
	Name       string      `yaml:"name"`
	Components []Component `yaml:"components"`
}

V1 struct is entrypoint repository for version 1 of used repository structure