config

Documentation

Index

• func CreateConfiguration(configDirPath string, configuration ParticleConfiguration) error
• type Dependencies
• type Dependency
• type Driver
• type ParticleConfiguration
  • func ReadConfiguration(scenario string) (ParticleConfiguration, error)
• type Prepare
• type Provisioner

Functions

func CreateConfiguration

func CreateConfiguration(configDirPath string, configuration ParticleConfiguration) error

CreateConfiguration creates the particle configuration using sane defaults. It returns the configuration and an error, if found.

Types

type Dependencies

type Dependencies struct {
	RepositoryName string `yaml:"repository-name,omitempty"`
	RepositoryURL  string `yaml:"repository-url,omitempty"`
}

A Dependencies represents the actual list of charts.

type Dependency

type Dependency struct {
	Name   string         `yaml:"name" validate:"eq=helm"`
	Charts []Dependencies `yaml:"charts,omitempty"`
}

A Dependency represents a list of chart's repository install locally.

type Driver

type Driver struct {
	Name              string                 `yaml:"name" validate:"required,eq=kind|eq=minikube"`
	KubernetesVersion string                 `yaml:"kubernetes-version,omitempty"`
	Values            map[string]interface{} `yaml:"values,omitempty"`
}

A Driver represents the driver configuration.

type ParticleConfiguration

type ParticleConfiguration struct {
	Driver      Driver      `yaml:"driver" validate:"required"`
	Provisioner Provisioner `yaml:"provisioner" validate:"required"`
	Linter      string      `yaml:"lint" validate:"required"`
	Verifier    string      `yaml:"verifier" validate:"required"`
	Dependency  Dependency  `yaml:"dependency" validate:"required,eq=helm"`
	Prepare     []Prepare   `yaml:"prepare,omitempty"`
}

A ParticleConfiguration represents the main particle configuration.

func ReadConfiguration

func ReadConfiguration(scenario string) (ParticleConfiguration, error)

ReadConfiguration just reads the configuration. It returns the configuration and an error, if found.

type Prepare

type Prepare struct {
	Name    string                 `yaml:"name"`
	Version string                 `yaml:"version,omitempty"`
	Values  map[string]interface{} `yaml:"values,omitempty"`
}

A Prepare represents the list of dependencies to install.

type Provisioner

type Provisioner struct {
	Name   string                 `yaml:"name" validate:"eq=helm"`
	Values map[string]interface{} `yaml:"values,omitempty"`
}

A Provisioner represents the provisioner configuration.