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 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 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