manifest

Documentation

Index

• Variables
• type Group
  • func (g Group) GetName() string
  • func (g Group) GetResources() []types.Resource
• type Manifest
  • func (m Manifest) GetGroups() []Group
• type Request
• type Service
  • func (s Service) GetCount() uint32
  • func (s Service) GetUnit() types.Unit
• type ServiceExpose

Variables

var (
	// ErrInvalidSignature represents new error with message "invalid signature"
	ErrInvalidSignature = errors.New("invalid signature")
	// ErrInvalidKey represents new error with message "key is not deployment owner"
	ErrInvalidKey = errors.New("key is not deployment owner")
)

var ErrDifferentHashes = errors.New("manifest hash does not match the expected hash")

ErrDifferentHashes represent new error for "manifest hash not matched with expected hash"

Types

type Group

type Group struct {
	Name     string
	Services []Service
}

Group store name and list of services

func (Group) GetName

func (g Group) GetName() string

GetName returns the name of group

func (Group) GetResources

func (g Group) GetResources() []types.Resource

GetResources returns list of resources in a group

type Manifest

type Manifest []Group

Manifest store list of groups

func (Manifest) GetGroups

func (m Manifest) GetGroups() []Group

GetGroups returns a manifest with groups list

type Request

type Request struct {
	Manifest Manifest
}

Request is the struct that includes manifest details

type Service

type Service struct {
	Name   string
	Image  string
	Args   []string
	Env    []string
	Unit   types.Unit
	Count  uint32
	Expose []ServiceExpose
}

Service stores name, image, args, env, unit, count and expose list of service

func (Service) GetCount

func (s Service) GetCount() uint32

GetCount returns count of service

func (Service) GetUnit

func (s Service) GetUnit() types.Unit

GetUnit returns unit of service

type ServiceExpose

type ServiceExpose struct {
	Port         uint32
	ExternalPort uint32
	Proto        string
	Service      string
	Global       bool
	Hosts        []string
}

ServiceExpose stores exposed ports and hosts details