configs

Documentation

Overview

Package configs contains the stores for tracking pipeline and chassis configurations and their deployments

Index

• Constants
• type Artifacts
• type ConfigStore
  • func NewAtomixStore(client primitive.Client, artifactsDirPath string) (ConfigStore, error)

Constants

const (
	// PipelineConfigKind represents pipeline configurations
	PipelineConfigKind = "pipeline"
	// ChassisConfigKind represents chassis configurations
	ChassisConfigKind = "chassis"
)

Types

type Artifacts

type Artifacts map[string][]byte

Artifacts is a map of artifact type to artifact content

type ConfigStore

type ConfigStore interface {
	io.Closer

	// Add registers a new configuration in the inventory
	Add(ctx context.Context, record *provisioner.ConfigRecord, artifacts Artifacts) error

	// Delete removes the specified configuration from the inventory
	Delete(ctx context.Context, configID provisioner.ConfigID) error

	// Get returns the specified configuration record
	Get(ctx context.Context, configID provisioner.ConfigID) (*provisioner.ConfigRecord, error)

	// GetArtifacts returns the specified configuration artifacts
	GetArtifacts(ctx context.Context, record *provisioner.ConfigRecord) (Artifacts, error)

	// List streams all registered configuration records of the requested kind (pipeline or chassis)
	List(ctx context.Context, kind string, ch chan *provisioner.ConfigRecord) error
}

ConfigStore is an abstraction for tracking inventory of pipeline and chassis configurations

func NewAtomixStore

func NewAtomixStore(client primitive.Client, artifactsDirPath string) (ConfigStore, error)

NewAtomixStore returns a new persistent store for configuration records whose artifacts are stored in the give artifacts directory