compose

Documentation

Overview

Package compose reads docker-compose yaml files and generates architecture json output Would use https://github.com/docker/libcompose if it wasn't so mind-numbingly complicated

Index

• func ComposeArch(name string, c *ComposeV2Yaml)
• type ComposeAttributes
• type ComposeServices
  • func ReadCompose(fn string) ComposeServices
• type ComposeV2Yaml
  • func ReadComposeV2(fn string) *ComposeV2Yaml

Functions

func ComposeArch

func ComposeArch(name string, c *ComposeV2Yaml)

ComposeArch makes an architecture from a compose V2 yaml format

Types

type ComposeAttributes

type ComposeAttributes struct {
	Build    string   `yaml:"build,omitempty"`
	Image    string   `yaml:"image,omitempty"`
	Links    []string `yaml:"links,omitempty"`
	Volumes  []string `yaml:"volumes,omitempty"`
	Ports    []string `yaml:"ports,omitempty"`
	Networks []string `yaml:"networks,omitempty"`
}

ComposeAttributes V1 maps to attributes of a microservice

type ComposeServices

type ComposeServices map[string]ComposeAttributes

ComposeServices type to extract interesting data from compose yaml version 1 file

func ReadCompose

func ReadCompose(fn string) ComposeServices

ReadCompose unmarshalls services from a yaml file

type ComposeV2Yaml

type ComposeV2Yaml struct {
	Version  string                 `yaml:"2,omitempty"`
	Services ComposeServices        `yaml:"services,omitempty"`
	Networks map[string]interface{} `yaml:"networks,omitempty"`
	Volumes  map[string]interface{} `yaml:"volumes,omitempty"`
}

ComposeV2Yaml type to extract interesting data from compose yaml version 2 file

func ReadComposeV2

func ReadComposeV2(fn string) *ComposeV2Yaml

ReadComposeV2 unmarshalls services from a compose V2 yaml file