loader

Documentation

Index

• func GetDeprecatedProperties(configDetails types.ConfigDetails) map[string]string
• func GetUnsupportedProperties(configDetails types.ConfigDetails) []string
• func Load(configDetails types.ConfigDetails) (*types.Config, error)
• func LoadNetworks(source types.Dict) (map[string]types.NetworkConfig, error)
• func LoadSecrets(source types.Dict, workingDir string) (map[string]types.SecretConfig, error)
• func LoadService(name string, serviceDict types.Dict, workingDir string, ...) (*types.ServiceConfig, error)
• func LoadServices(servicesDict types.Dict, workingDir string, lookupEnv template.Mapping) ([]types.ServiceConfig, error)
• func LoadVolumes(source types.Dict) (map[string]types.VolumeConfig, error)
• func ParseYAML(source []byte) (types.Dict, error)
• type ForbiddenPropertiesError
  • func (e *ForbiddenPropertiesError) Error() string

Functions

func GetDeprecatedProperties

func GetDeprecatedProperties(configDetails types.ConfigDetails) map[string]string

GetDeprecatedProperties returns the list of any deprecated properties that are used in the compose files.

func GetUnsupportedProperties

func GetUnsupportedProperties(configDetails types.ConfigDetails) []string

GetUnsupportedProperties returns the list of any unsupported properties that are used in the Compose files.

func Load

func Load(configDetails types.ConfigDetails) (*types.Config, error)

Load reads a ConfigDetails and returns a fully loaded configuration

func LoadNetworks

func LoadNetworks(source types.Dict) (map[string]types.NetworkConfig, error)

LoadNetworks produces a NetworkConfig map from a compose file Dict the source Dict is not validated if directly used. Use Load() to enable validation

func LoadSecrets

func LoadSecrets(source types.Dict, workingDir string) (map[string]types.SecretConfig, error)

LoadSecrets produces a SecretConfig map from a compose file Dict the source Dict is not validated if directly used. Use Load() to enable validation

func LoadService

func LoadService(name string, serviceDict types.Dict, workingDir string, lookupEnv template.Mapping) (*types.ServiceConfig, error)

LoadService produces a single ServiceConfig from a compose file Dict the serviceDict is not validated if directly used. Use Load() to enable validation

func LoadServices

func LoadServices(servicesDict types.Dict, workingDir string, lookupEnv template.Mapping) ([]types.ServiceConfig, error)

LoadServices produces a ServiceConfig map from a compose file Dict the servicesDict is not validated if directly used. Use Load() to enable validation

func LoadVolumes

func LoadVolumes(source types.Dict) (map[string]types.VolumeConfig, error)

LoadVolumes produces a VolumeConfig map from a compose file Dict the source Dict is not validated if directly used. Use Load() to enable validation

func ParseYAML

func ParseYAML(source []byte) (types.Dict, error)

ParseYAML reads the bytes from a file, parses the bytes into a mapping structure, and returns it.

Types

type ForbiddenPropertiesError

type ForbiddenPropertiesError struct {
	Properties map[string]string
}

ForbiddenPropertiesError is returned when there are properties in the Compose file that are forbidden.

func (*ForbiddenPropertiesError) Error

func (e *ForbiddenPropertiesError) Error() string