runkit

Documentation

Index

• Constants
• func Decorate(ctx context.Context, src, dest string, runxConfig, runxDoc []byte) error
• func Image(runxConfig, runxDoc []byte) (v1.Image, *v1.Descriptor, error)
• type Action
  • func (action *Action) GetRunnable(ref string) (*Runnable, func(), error)
  • func (action *Action) IsDefault() bool
• type ActionType
• type Cache
• type CacheEntry
• type Config
• type ConfigAction
• type ConfigImage
• type Files
• type LocalCache
  • func NewLocalCache(cli command.Cli) *LocalCache
  • func (c *LocalCache) EraseAll() error
  • func (c *LocalCache) EraseNotAccessedInLast30Days() error
  • func (c *LocalCache) Get(digest, src string) (*RunKit, error)
  • func (c *LocalCache) ListCache() (string, []CacheEntry, int64, error)
  • func (c *LocalCache) Set(digest string, runxConfig, runxDoc []byte) error
• type LocalConfig
  • func GetLocalConfig() *LocalConfig
  • func (lc *LocalConfig) Image(src string) (*ConfigImage, bool)
• type Opt
• type OptType
• type RunKit
  • func Get(ctx context.Context, cache Cache, src string) (*RunKit, error)
  • func (rk *RunKit) GetRunnable(action string) (*Runnable, func(), error)
• type Runnable
  • func (r *Runnable) CheckFlags() ([]string, error)
  • func (r *Runnable) Run(ctx context.Context) error
  • func (r *Runnable) SetOptionValues(opts map[string]string) error
• type TemplateData

Constants

const (
	RunxAnnotation   = "vnd.docker.reference.type"
	RunxManifestType = "runx-manifest"
	RunxConfigType   = "application/vnd.runx.config+yaml"
	RunxDocType      = "application/vnd.runx.readme+txt"
)

const (
	ActionTypeRun   ActionType = "run"
	ActionTypeBuild ActionType = "build"

	OptTypeNotSet  OptType = ""
	OptTypeInput   OptType = "input"
	OptTypeSelect  OptType = "select"
	OptTypeConfirm OptType = "confirm"
)

const (
	DefaultLocalConfigFile = ".docker/runx.yaml"
)

Functions

func Decorate

func Decorate(ctx context.Context, src, dest string, runxConfig, runxDoc []byte) error

func Image

func Image(runxConfig, runxDoc []byte) (v1.Image, *v1.Descriptor, error)

Types

type Action

type Action struct {
	ID                string            `yaml:"id" json:"id"`
	Desc              string            `yaml:"desc,omitempty" json:"desc,omitempty"`
	Type              ActionType        `yaml:"type" json:"type"`
	Command           string            `yaml:"cmd" json:"cmd,omitempty"`
	Env               []string          `yaml:"env,omitempty" json:"env,omitempty"`
	Options           []Opt             `yaml:"opts,omitempty" json:"opts,omitempty"`
	Shell             map[string]string `yaml:"shell,omitempty" json:"shell,omitempty"`
	Dockerfile        string            `yaml:"dockerfile,omitempty" json:"dockerfile,omitempty"`
	DockerfileContent string
	// contains filtered or unexported fields
}

func (*Action) GetRunnable

func (action *Action) GetRunnable(ref string) (*Runnable, func(), error)

func (*Action) IsDefault

func (action *Action) IsDefault() bool

type ActionType

type ActionType string

type Cache

type Cache interface {
	Get(digest, src string) (*RunKit, error)
	Set(digest string, runxConfig, runxDoc []byte) error
}

type CacheEntry

type CacheEntry struct {
	LastAccess *time.Time
	Digest     string
	Size       int64
}

type Config

type Config struct {
	Default string   `yaml:"default,omitempty" json:"default,omitempty"`
	Actions []Action `yaml:"actions" json:"actions"`
}

type ConfigAction

type ConfigAction struct {
	Opts map[string]string `yaml:"opts,omitempty" json:"opts,omitempty"`
}

type ConfigImage

type ConfigImage struct {
	Default    string                  `yaml:"default,omitempty" json:"default,omitempty"`
	AllActions ConfigAction            `yaml:"all-actions,omitempty" json:"all-actions,omitempty"`
	Actions    map[string]ConfigAction `yaml:"actions,omitempty" json:"actions,omitempty"`
}

type Files

type Files struct {
	Files []struct {
		Name    string `yaml:"name"`
		Content string `yaml:"content"`
	} `yaml:"files"`
}

type LocalCache

type LocalCache struct {
	// contains filtered or unexported fields
}

func NewLocalCache

func NewLocalCache(cli command.Cli) *LocalCache

func (*LocalCache) EraseAll

func (c *LocalCache) EraseAll() error

func (*LocalCache) EraseNotAccessedInLast30Days

func (c *LocalCache) EraseNotAccessedInLast30Days() error

func (*LocalCache) Get

func (c *LocalCache) Get(digest, src string) (*RunKit, error)

func (*LocalCache) ListCache

func (c *LocalCache) ListCache() (string, []CacheEntry, int64, error)

func (*LocalCache) Set

func (c *LocalCache) Set(digest string, runxConfig, runxDoc []byte) error

type LocalConfig

type LocalConfig struct {
	AcceptTheRisk bool                   `yaml:"accept-the-risk,omitempty" json:"accept-the-risk,omitempty"`
	Ref           string                 `yaml:"ref,omitempty" json:"ref,omitempty"`
	Images        map[string]ConfigImage `yaml:"images,omitempty" json:"images,omitempty"`
}

func GetLocalConfig

func GetLocalConfig() *LocalConfig

func (*LocalConfig) Image

func (lc *LocalConfig) Image(src string) (*ConfigImage, bool)

type Opt

type Opt struct {
	Name        string   `yaml:"name" json:"name"`
	Type        OptType  `yaml:"type,omitempty" json:"type,omitempty"`
	Description string   `yaml:"desc" json:"desc,omitempty"`
	NoPrompt    bool     `yaml:"no-prompt,omitempty" json:"no-prompt,omitempty"`
	Prompt      string   `yaml:"prompt,omitempty" json:"prompt,omitempty"`
	Required    bool     `yaml:"required,omitempty" json:"required,omitempty"`
	Values      []string `yaml:"values,omitempty" json:"values,omitempty"`
	Default     string   `yaml:"default,omitempty" json:"default,omitempty"`
}

type OptType

type OptType string

type RunKit

type RunKit struct {
	Config Config
	Readme string
	Files  map[string]string
	// contains filtered or unexported fields
}

func Get

func Get(ctx context.Context, cache Cache, src string) (*RunKit, error)

func (*RunKit) GetRunnable

func (rk *RunKit) GetRunnable(action string) (*Runnable, func(), error)

type Runnable

type Runnable struct {
	Command string

	Action *Action
	// contains filtered or unexported fields
}

func (*Runnable) CheckFlags

func (r *Runnable) CheckFlags() ([]string, error)

func (*Runnable) Run

func (r *Runnable) Run(ctx context.Context) error

func (*Runnable) SetOptionValues

func (r *Runnable) SetOptionValues(opts map[string]string) error

type TemplateData

type TemplateData struct {
	Ref        string
	Env        map[string]string
	Opts       map[string]string
	Dockerfile string
	IsTTY      bool
}