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 LoadConfigObjs(source map[string]interface{}, workingDir string) (map[string]types.ConfigObjConfig, error)
- func LoadNetworks(source map[string]interface{}) (map[string]types.NetworkConfig, error)
- func LoadSecrets(source map[string]interface{}, workingDir string) (map[string]types.SecretConfig, error)
- func LoadService(name string, serviceDict map[string]interface{}, workingDir string, ...) (*types.ServiceConfig, error)
- func LoadServices(servicesDict map[string]interface{}, workingDir string, ...) ([]types.ServiceConfig, error)
- func LoadVolumes(source map[string]interface{}) (map[string]types.VolumeConfig, error)
- func ParseVolume(spec string) (types.ServiceVolumeConfig, error)
- func ParseYAML(source []byte) (map[string]interface{}, error)
- type ForbiddenPropertiesError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 LoadConfigObjs ¶
func LoadConfigObjs(source map[string]interface{}, workingDir string) (map[string]types.ConfigObjConfig, error)
LoadConfigObjs produces a ConfigObjConfig map from a compose file Dict the source Dict is not validated if directly used. Use Load() to enable validation
func LoadNetworks ¶
func LoadNetworks(source map[string]interface{}) (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 map[string]interface{}, 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 map[string]interface{}, 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 map[string]interface{}, 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 map[string]interface{}) (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 ParseVolume ¶
func ParseVolume(spec string) (types.ServiceVolumeConfig, error)
ParseVolume parses a volume spec without any knowledge of the target platform
Types ¶
type ForbiddenPropertiesError ¶
ForbiddenPropertiesError is returned when there are properties in the Compose file that are forbidden.
func (*ForbiddenPropertiesError) Error ¶
func (e *ForbiddenPropertiesError) Error() string