installconfig

Documentation

Overview

Package installconfig generates the install config assets based on its dependencies. The type itself is defined in ../pkg/types.

Index

• type AssetBase
  • func (a *AssetBase) Files() []*asset.File
  • func (a *AssetBase) LoadFromFile(f asset.FileFetcher) (found bool, err error)
  • func (a *AssetBase) Name() string
  • func (a *AssetBase) RecordFile() error
• type ClusterID
  • func (a *ClusterID) Dependencies() []asset.Asset
  • func (a *ClusterID) Generate(_ context.Context, dep asset.Parents) error
  • func (a *ClusterID) Name() string
• type InstallConfig
  • func MakeAsset(config *types.InstallConfig) *InstallConfig
  • func (a *InstallConfig) Dependencies() []asset.Asset
  • func (a *InstallConfig) Generate(ctx context.Context, parents asset.Parents) error
  • func (a *InstallConfig) Load(f asset.FileFetcher) (found bool, err error)
• type PlatformCredsCheck
  • func (a *PlatformCredsCheck) Dependencies() []asset.Asset
  • func (a *PlatformCredsCheck) Generate(ctx context.Context, dependencies asset.Parents) error
  • func (a *PlatformCredsCheck) Name() string
• type PlatformPermsCheck
  • func (a *PlatformPermsCheck) Dependencies() []asset.Asset
  • func (a *PlatformPermsCheck) Generate(ctx context.Context, dependencies asset.Parents) error
  • func (a *PlatformPermsCheck) Name() string
• type PlatformProvisionCheck
  • func (a *PlatformProvisionCheck) Dependencies() []asset.Asset
  • func (a *PlatformProvisionCheck) Generate(ctx context.Context, dependencies asset.Parents) error
  • func (a *PlatformProvisionCheck) Name() string

Types

type AssetBase

type AssetBase struct {
	Config *types.InstallConfig `json:"config"`
	File   *asset.File          `json:"file"`
}

AssetBase is the base structure for the separate InstallConfig assets used in the agent-based and IPI/UPI installation methods.

func (*AssetBase) Files

func (a *AssetBase) Files() []*asset.File

Files returns the files generated by the asset.

func (*AssetBase) LoadFromFile

func (a *AssetBase) LoadFromFile(f asset.FileFetcher) (found bool, err error)

LoadFromFile returns the installconfig from disk.

func (*AssetBase) Name

func (a *AssetBase) Name() string

Name returns the human-friendly name of the asset.

func (*AssetBase) RecordFile

func (a *AssetBase) RecordFile() error

RecordFile generates the asset manifest file from the config CR.

type ClusterID

type ClusterID struct {
	// UUID is a globally unique identifier.
	UUID string

	// InfraID is an identifier for the cluster that is more human friendly.
	// This does not have
	InfraID string
}

ClusterID is the unique ID of the cluster, immutable during the cluster's life

func (*ClusterID) Dependencies

func (a *ClusterID) Dependencies() []asset.Asset

Dependencies returns install-config.

func (*ClusterID) Generate

func (a *ClusterID) Generate(_ context.Context, dep asset.Parents) error

Generate generates a new ClusterID

func (*ClusterID) Name

func (a *ClusterID) Name() string

Name returns the human-friendly name of the asset.

type InstallConfig

type InstallConfig struct {
	AssetBase
	AWS      *aws.Metadata        `json:"aws,omitempty"`
	Azure    *icazure.Metadata    `json:"azure,omitempty"`
	IBMCloud *icibmcloud.Metadata `json:"ibmcloud,omitempty"`
	PowerVS  *icpowervs.Metadata  `json:"powervs,omitempty"`
	VSphere  *icvsphere.Metadata  `json:"vsphere,omitempty"`
}

InstallConfig generates the install-config.yaml file.

func MakeAsset

func MakeAsset(config *types.InstallConfig) *InstallConfig

MakeAsset returns an InstallConfig asset containing a given InstallConfig CR.

func (*InstallConfig) Dependencies

func (a *InstallConfig) Dependencies() []asset.Asset

Dependencies returns all of the dependencies directly needed by an InstallConfig asset.

func (*InstallConfig) Generate

func (a *InstallConfig) Generate(ctx context.Context, parents asset.Parents) error

Generate the install-config.yaml file.

func (*InstallConfig) Load

func (a *InstallConfig) Load(f asset.FileFetcher) (found bool, err error)

Load returns the installconfig from disk.

type PlatformCredsCheck

type PlatformCredsCheck struct {
}

PlatformCredsCheck is an asset that checks the platform credentials, asks for them or errors out if invalid the cluster.

func (*PlatformCredsCheck) Dependencies

func (a *PlatformCredsCheck) Dependencies() []asset.Asset

Dependencies returns the dependencies for PlatformCredsCheck

func (*PlatformCredsCheck) Generate

func (a *PlatformCredsCheck) Generate(ctx context.Context, dependencies asset.Parents) error

Generate queries for input from the user.

func (*PlatformCredsCheck) Name

func (a *PlatformCredsCheck) Name() string

Name returns the human-friendly name of the asset.

type PlatformPermsCheck

type PlatformPermsCheck struct {
}

PlatformPermsCheck is an asset that checks platform credentials for the necessary permissions to create a cluster.

func (*PlatformPermsCheck) Dependencies

func (a *PlatformPermsCheck) Dependencies() []asset.Asset

Dependencies returns the dependencies for PlatformPermsCheck

func (*PlatformPermsCheck) Generate

func (a *PlatformPermsCheck) Generate(ctx context.Context, dependencies asset.Parents) error

Generate queries for input from the user.

func (*PlatformPermsCheck) Name

func (a *PlatformPermsCheck) Name() string

Name returns the human-friendly name of the asset.

type PlatformProvisionCheck

type PlatformProvisionCheck struct {
}

PlatformProvisionCheck is an asset that validates the install-config platform for any requirements specific for provisioning infrastructure.

func (*PlatformProvisionCheck) Dependencies

func (a *PlatformProvisionCheck) Dependencies() []asset.Asset

Dependencies returns the dependencies for PlatformProvisionCheck

func (*PlatformProvisionCheck) Generate

func (a *PlatformProvisionCheck) Generate(ctx context.Context, dependencies asset.Parents) error

Generate queries for input from the user.

func (*PlatformProvisionCheck) Name

func (a *PlatformProvisionCheck) Name() string

Name returns the human-friendly name of the asset.