config

Documentation

Index

• func ParseDocuments(r io.Reader) ([]string, error)
• func ParseDocumentsBytes(b []byte) ([]string, error)
• func ParseDocumentsFile(p string) ([]string, error)
• func ParseDocumentsString(s string) ([]string, error)
• type Clone
• type Config
  • func Parse(r io.Reader) (*Config, error)
  • func ParseBytes(b []byte) (*Config, error)
  • func ParseFile(p string) (*Config, error)
  • func ParseMulti(r io.Reader) ([]*Config, error)
  • func ParseMultiBytes(b []byte) ([]*Config, error)
  • func ParseMultiFile(p string) ([]*Config, error)
  • func ParseMultiString(s string) ([]*Config, error)
  • func ParseString(s string) (*Config, error)
• type Metadata
• type Network
• type Platform
• type Secret
• type Volume
• type Workspace

Functions

func ParseDocuments

func ParseDocuments(r io.Reader) ([]string, error)

ParseDocuments returns the yaml documents.

func ParseDocumentsBytes

func ParseDocumentsBytes(b []byte) ([]string, error)

ParseDocumentsBytes returns the yaml documents.

func ParseDocumentsFile

func ParseDocumentsFile(p string) ([]string, error)

ParseDocumentsFile returns the yaml documents from file p.

func ParseDocumentsString

func ParseDocumentsString(s string) ([]string, error)

ParseDocumentsString returns the yaml documents.

Types

type Clone

type Clone struct {
	Disable bool
	Depth   int
}

Clone provides clone customization

type Config

type Config struct {
	Metadata  Metadata
	Platform  Platform
	Clone     Clone
	Workspace Workspace
	Version   yaml.StringInt
	DependsOn yaml.StringSlice `yaml:"depends_on"`
	Trigger   yaml.Constraints
	Labels    yaml.SliceMap
	Pipeline  []map[string]*yaml.Container
	Services  map[string]*yaml.Container
	Networks  map[string]Network
	Volumes   map[string]Volume
	Secrets   map[string]Secret
}

Config represents the pipeline configuration.

func Parse

func Parse(r io.Reader) (*Config, error)

Parse parses the configuration from bytes b.

func ParseBytes

func ParseBytes(b []byte) (*Config, error)

ParseBytes parses the configuration from bytes b.

func ParseFile

func ParseFile(p string) (*Config, error)

ParseFile parses the configuration from path p.

func ParseMulti

func ParseMulti(r io.Reader) ([]*Config, error)

ParseMulti parses the configurations from bytes b.

func ParseMultiBytes

func ParseMultiBytes(b []byte) ([]*Config, error)

ParseMultiBytes parses the configurations from bytes b.

func ParseMultiFile

func ParseMultiFile(p string) ([]*Config, error)

ParseMultiFile parses the configurations from path p.

func ParseMultiString

func ParseMultiString(s string) ([]*Config, error)

ParseMultiString parses the configurations from string s.

func ParseString

func ParseString(s string) (*Config, error)

ParseString parses the configuration from string s.

type Metadata

type Metadata struct {
	Name string
}

Metadata provides platform details

type Network

type Network struct {
	Driver     string
	DriverOpts map[string]string `yaml:"driver_opts,omitempty"`
}

Network represents the container network configuration.

type Platform

type Platform struct {
	Name    string
	OS      string `yaml:"os"`
	Arch    string `yaml:"arch"`
	Variant string `yaml:"variant"`
	Kernel  string `yaml:"kernel"`
}

Platform provides platform details

type Secret

type Secret struct {
	External   yaml.External
	File       string
	Aescbc     string
	Aesgcm     string
	Secretbox  string
	Driver     string
	DriverOpts map[string]interface{} `yaml:"driver_opts,omitempty"`
}

Secret represents the container secret configuration.

type Volume

type Volume struct {
	Driver     string
	DriverOpts map[string]string `yaml:"driver_opts,omitempty"`
}

Volume represents the container volume configuration.

type Workspace

type Workspace struct {
	Base string
	Path string
}

Workspace represents the pipeline workspace configuraiton.