# Packages
Package alpha implements clusterctl alpha functionality.
Package cluster implements clusterctl cluster functionality.
Package config implements clusterctl config functionality.
Package repository implements clusterctl repository functionality.
Package tree supports the generation of an "at glance" view of a Cluster API cluster designed to help the user in quickly
understanding if there are problems and where.
Package yamlprocessor implements YAML processing.
# Functions
InjectClusterClientFactory allows to override the default factory used for creating ClusterClient objects.
InjectConfig allows to override the default configuration client used by clusterctl.
InjectRepositoryFactory allows to override the default factory used for creating RepositoryClient objects.
New returns a configClient.
# Constants
DefaultCustomTemplateConfigMapKey where the workload cluster template is hosted.
NoopProvider determines if a provider passed in should behave as a no-op.
# Structs
ApplyUpgradeOptions carries the options supported by upgrade apply.
ClusterClientFactoryInput represents the inputs required by the factory.
ConfigMapSourceOptions defines the options to be used when reading a workload cluster template from a ConfigMap.
DeleteOptions carries the options supported by Delete.
DescribeClusterOptions carries the options supported by DescribeCluster.
GetClusterTemplateOptions carries the options supported by GetClusterTemplate.
GetKubeconfigOptions carries all the options supported by GetKubeconfig.
InitOptions carries the options supported by Init.
MoveOptions carries the options supported by move.
PlanUpgradeOptions carries the options supported by upgrade plan.
ProcessYAMLOptions are the options supported by ProcessYAML.
ProviderRepositorySourceOptions defines the options to be used when reading a workload cluster template from a provider repository.
ReaderSourceOptions define the options to be used when reading a template from an arbitrary reader.
RepositoryClientFactoryInput represents the inputs required by the factory.
RolloutPauseOptions carries the options supported by RolloutPause.
RolloutRestartOptions carries the options supported by RolloutRestart.
RolloutResumeOptions carries the options supported by RolloutResume.
RolloutUndoOptions carries the options supported by RolloutUndo.
TopologyPlanOptions define options for TopologyPlan.
URLSourceOptions defines the options to be used when reading a workload cluster template from an URL.
# Interfaces
AlphaClient exposes the alpha features in clusterctl high-level client library.
Client is exposes the clusterctl high-level client library.
YamlPrinter exposes methods that prints the processed template and variables.
# Type aliases
CertManagerUpgradePlan defines the upgrade plan if cert-manager needs to be upgraded to a different version.
ClusterClientFactory is a factory of cluster.Client from a given input.
Components wraps a YAML file that defines the provider's components (CRDs, controller, RBAC rules etc.).
ComponentsOptions wraps inputs to get provider's components.
Kubeconfig is a type that specifies inputs related to the actual kubeconfig.
Option is a configuration option supplied to New.
Processor defines the methods necessary for creating a specific yaml processor.
Provider defines a provider configuration.
RepositoryClientFactory is a factory of repository.Client from a given input.
Template wraps a YAML file that defines the cluster objects (Cluster, Machines etc.).
TopologyPlanOutput defines the output of the topology plan operation.
UpgradePlan defines a list of possible upgrade targets for a management cluster.