clusterapi

Documentation

Index

• Variables
• func UnpackClusterAPIBinary(dir string) error
• func UnpackEnvtestBinaries(dir string) error
• type Interface
  • func System() Interface
• type Provider
  • func (p Provider) Extract(dir string) error
• type SystemState

Variables

var (
	// ClusterAPI is the core provider for cluster-api.
	ClusterAPI = Provider{
		Name:    "cluster-api",
		Sources: sets.New("cluster-api"),
	}

	// EnvTest is the provider for the local control plane.
	EnvTest = Provider{
		Name:    "envtest",
		Sources: sets.New("kube-apiserver", "etcd"),
	}

	// AWS is the provider for creating resources in AWS.
	AWS = infrastructureProvider("aws")
	// Azure is the provider for creating resources in Azure.
	Azure = infrastructureProvider("azure")
	// AzureASO is a companion component to Azure that is used to create resources declaratively.
	AzureASO = infrastructureProvider("azureaso")
	// GCP is the provider for creating resources in GCP.
	GCP = infrastructureProvider("gcp")
	// IBMCloud is the provider for creating resources in IBM Cloud and powervs.
	IBMCloud = infrastructureProvider("ibmcloud")
	// Nutanix is the provider for creating resources in Nutanix.
	Nutanix = infrastructureProvider("nutanix")
	// OpenStack is the provider for creating resources in OpenStack.
	OpenStack = infrastructureProvider("openstack")
	// VSphere is the provider for creating resources in vSphere.
	VSphere = infrastructureProvider("vsphere")
)

var Mirror embed.FS

Mirror is the embedded data for the providers.

var (
	// Scheme is the scheme used by the local control plane.
	Scheme = scheme.Scheme
)

Functions

func UnpackClusterAPIBinary

func UnpackClusterAPIBinary(dir string) error

UnpackClusterAPIBinary unpacks the cluster-api binary from the embedded data so that it can be run to create the infrastructure for the cluster.

func UnpackEnvtestBinaries

func UnpackEnvtestBinaries(dir string) error

UnpackEnvtestBinaries unpacks the envtest binaries from the embedded data so that it can be run to create the infrastructure for the cluster.

Types

type Interface

type Interface interface {
	Run(ctx context.Context) error
	State() SystemState
	Client() client.Client
	Teardown()
	CleanEtcd()
}

Interface is the interface for the cluster-api system.

func System

func System() Interface

System returns the cluster-api system.

type Provider

type Provider struct {
	// Name of the provider.
	Name string
	// Sources of the provider.
	Sources sets.Set[string]
}

Provider is a Cluster API provider.

func (Provider) Extract

func (p Provider) Extract(dir string) error

Extract extracts the provider from the embedded data into the specified directory.

type SystemState

type SystemState string

SystemState is the state of the cluster-api system.

const (
	// SystemStateRunning indicates the system is running.
	SystemStateRunning SystemState = "running"
	// SystemStateStopped indicates the system is stopped.
	SystemStateStopped SystemState = "stopped"

	// ArtifactsDir is the directory where output (manifests, kubeconfig, etc.)
	// related to CAPI-based installs are stored.
	ArtifactsDir = ".clusterapi_output"
)