metadata

Documentation

Overview

Package metadata contains asset targets that generates the metadata.yaml

Index

• Constants
• type Metadata
  • func (m *Metadata) Dependencies() []asset.Asset
  • func (m *Metadata) Generate(parents map[asset.Asset]*asset.State) (*asset.State, error)
  • func (m *Metadata) Name() string
• type Stock
• type StockImpl
  • func (s *StockImpl) EstablishStock(installConfigStock installconfig.Stock, clusterStock cluster.Stock)
  • func (s *StockImpl) Metadata() asset.Asset

Constants

const (
	// MetadataFilename is name of the file where clustermetadata is stored.
	MetadataFilename = "metadata.json"
)

Types

type Metadata

type Metadata struct {
	// contains filtered or unexported fields
}

Metadata depends on cluster and installconfig,

func (*Metadata) Dependencies

func (m *Metadata) Dependencies() []asset.Asset

Dependencies returns the dependency of the MetaData.

func (*Metadata) Generate

func (m *Metadata) Generate(parents map[asset.Asset]*asset.State) (*asset.State, error)

Generate generates the metadata.yaml file.

func (*Metadata) Name

func (m *Metadata) Name() string

Name returns the human-friendly name of the asset.

type Stock

type Stock interface {
	// Metadata is the asset that generates the metadata.json file
	Metadata() asset.Asset
}

Stock is the stock of the cluster assets that can be generated.

type StockImpl

type StockImpl struct {
	// contains filtered or unexported fields
}

StockImpl is the implementation of the cluster asset stock.

func (*StockImpl) EstablishStock

func (s *StockImpl) EstablishStock(installConfigStock installconfig.Stock, clusterStock cluster.Stock)

EstablishStock establishes the stock of assets in the specified directory.

func (*StockImpl) Metadata

func (s *StockImpl) Metadata() asset.Asset

Metadata returns the terraform tfvar asset.