compose

Documentation

Index

• Constants
• type ComposeAnalyser
  • func (t *ComposeAnalyser) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
  • func (t *ComposeAnalyser) GetConfig() (transformertypes.Transformer, *environment.Environment)
  • func (t *ComposeAnalyser) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)
  • func (t *ComposeAnalyser) Transform(newArtifacts []transformertypes.Artifact, ...) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)
• type ComposeAnalyzerConfig
• type ComposeConfig
• type ComposeGenerator
  • func (t *ComposeGenerator) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
  • func (t *ComposeGenerator) GetConfig() (transformertypes.Transformer, *environment.Environment)
  • func (t *ComposeGenerator) Init(tc transformertypes.Transformer, env *environment.Environment) error
  • func (t *ComposeGenerator) Transform(newArtifacts []transformertypes.Artifact, ...) (pathMappings []transformertypes.PathMapping, ...)
• type ComposeGeneratorYamlConfig

Constants

const (
	// ComposeServiceConfigType represents the Compose service config type
	ComposeServiceConfigType transformertypes.ConfigType = "ComposeService"
	// ComposeFileConfigType represents the docker-compose file config type
	ComposeFileConfigType transformertypes.ConfigType = "DockerCompose"
)

Types

type ComposeAnalyser

type ComposeAnalyser struct {
	Config                transformertypes.Transformer
	Env                   *environment.Environment
	ComposeAnalyzerConfig *ComposeAnalyzerConfig
}

ComposeAnalyser implements Transformer interface

func (*ComposeAnalyser) DirectoryDetect

func (t *ComposeAnalyser) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)

DirectoryDetect detects docker compose files

func (*ComposeAnalyser) GetConfig

func (t *ComposeAnalyser) GetConfig() (transformertypes.Transformer, *environment.Environment)

GetConfig returns the config

func (*ComposeAnalyser) Init

func (t *ComposeAnalyser) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)

Init Initializes the transformer

func (*ComposeAnalyser) Transform

func (t *ComposeAnalyser) Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)

Transform transforms the artifacts

type ComposeAnalyzerConfig

type ComposeAnalyzerConfig struct {
	EnableNetworkParsing bool `yaml:"enableNetworkParsing"`
}

ComposeAnalyzerConfig represents the configuration of the compose analyzer

type ComposeConfig

type ComposeConfig struct {
	ServiceName string `yaml:"serviceName,omitempty"`
}

ComposeConfig stores the config for compose service

type ComposeGenerator

type ComposeGenerator struct {
	Config                 transformertypes.Transformer
	Env                    *environment.Environment
	ComposeGeneratorConfig *ComposeGeneratorYamlConfig
}

ComposeGenerator implements Transformer interface

func (*ComposeGenerator) DirectoryDetect

func (t *ComposeGenerator) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)

DirectoryDetect executes detect in each sub directory

func (*ComposeGenerator) GetConfig

func (t *ComposeGenerator) GetConfig() (transformertypes.Transformer, *environment.Environment)

GetConfig returns the transformer config

func (*ComposeGenerator) Init

func (t *ComposeGenerator) Init(tc transformertypes.Transformer, env *environment.Environment) error

Init Initializes the transformer

func (*ComposeGenerator) Transform

func (t *ComposeGenerator) Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) (pathMappings []transformertypes.PathMapping, createdArtifacts []transformertypes.Artifact, err error)

Transform transforms the artifacts

type ComposeGeneratorYamlConfig

type ComposeGeneratorYamlConfig struct {
	OutputPath string `yaml:"outputPath"`
}

ComposeGeneratorYamlConfig contains all the configuration from the transformer YAML