ir

Documentation

Index

• type Inputs
  • func FromCompose(project *composeTypes.Project) *Inputs
  • func NewInputs() *Inputs
• type Service
  • func NewService(name string, composeService composeTypes.ServiceConfig) Service
  • func (s *Service) AsCompose() composeTypes.ServiceConfig
  • func (s *Service) IsSingleton() bool
  • func (s *Service) Labels() map[string]string
  • func (s *Service) VolumeNames() []string
  • func (s *Service) Volumes(volumes map[string]Volume) ([]Volume, []Volume)
• type Volume
  • func NewVolume(name string, composeVolume composeTypes.VolumeConfig) Volume
  • func (v *Volume) IsShared() bool
  • func (v *Volume) IsSingleton() bool
  • func (v *Volume) Labels() map[string]string
  • func (v *Volume) Size(fallback string) resource.Quantity
  • func (v *Volume) SizeIsMissing() bool

Types

type Inputs

type Inputs struct {
	Services map[string]Service
	Volumes  map[string]Volume
}

func FromCompose

func FromCompose(project *composeTypes.Project) *Inputs

func NewInputs

func NewInputs() *Inputs

type Service

type Service struct {
	Name string
	// contains filtered or unexported fields
}

Service provides some k8ify-specific abstractions & utility around Compose service configurations.

func NewService

func NewService(name string, composeService composeTypes.ServiceConfig) Service

func (*Service) AsCompose

func (s *Service) AsCompose() composeTypes.ServiceConfig

AsCompose returns the underlying compose config TODO(mh): make me obsolete!

func (*Service) IsSingleton

func (s *Service) IsSingleton() bool

func (*Service) Labels

func (s *Service) Labels() map[string]string

func (*Service) VolumeNames

func (s *Service) VolumeNames() []string

VolumeNames lists the names of all volumes that are mounted by this service

func (*Service) Volumes

func (s *Service) Volumes(volumes map[string]Volume) ([]Volume, []Volume)

type Volume

type Volume struct {
	Name string
	// contains filtered or unexported fields
}

Volume provides some k8ify-specific abstractions & utility around Compose volume configurations.

func NewVolume

func NewVolume(name string, composeVolume composeTypes.VolumeConfig) Volume

func (*Volume) IsShared

func (v *Volume) IsShared() bool

func (*Volume) IsSingleton

func (v *Volume) IsSingleton() bool

func (*Volume) Labels

func (v *Volume) Labels() map[string]string

func (*Volume) Size

func (v *Volume) Size(fallback string) resource.Quantity

func (*Volume) SizeIsMissing

func (v *Volume) SizeIsMissing() bool