clusterctl

command

v1.9.6 Latest Latest Go to latest Published: Mar 17, 2025 License: Apache-2.0 Imports: 2 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes-sigs/cluster-api

Links

Open Source Insights

README ¶

Clusterctl

Compatibility notice

The clusterctl CLI is developed in lock-step with Cluster API. We strongly recommend using the latest released version for the series you're using. For example, if you're managing clusters with Cluster API v0.3.7, the clusterctl version should be >= v0.3.7.

When this package is used as a library, we do not currently provide any compatibility guarantees. We will make reasonable efforts to follow a typical deprecation period prior to removal, but breaking changes can happen when necessary.

Documentation ¶

Overview ¶

main is the main package for clusterctl.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api
v1alpha3 Package v1alpha3 contains API Schema definitions for the clusterctl v1alpha3 API group +kubebuilder:object:generate=true +groupName=clusterctl.cluster.x-k8s.io	Package v1alpha3 contains API Schema definitions for the clusterctl v1alpha3 API group +kubebuilder:object:generate=true +groupName=clusterctl.cluster.x-k8s.io
client Package client implements clusterctl client functionality.	Package client implements clusterctl client functionality.
alpha Package alpha implements clusterctl alpha functionality.	Package alpha implements clusterctl alpha functionality.
cluster Package cluster implements clusterctl cluster functionality.	Package cluster implements clusterctl cluster functionality.
cluster/internal/dryrun Package dryrun implements clusterctl dryrun functionality.	Package dryrun implements clusterctl dryrun functionality.
config Package config implements clusterctl config functionality.	Package config implements clusterctl config functionality.
repository Package repository implements clusterctl repository functionality.	Package repository implements clusterctl repository functionality.
tree 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 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.
yamlprocessor Package yamlprocessor implements YAML processing.	Package yamlprocessor implements YAML processing.
cmd Package cmd implements clusterctl commands.	Package cmd implements clusterctl commands.
internal/templates Package templates provides templates for descriptions and examples.	Package templates provides templates for descriptions and examples.
rollout Package rollout implements the clusterctl rollout command.	Package rollout implements the clusterctl rollout command.
config Package config implements clusterctl config functionality.	Package config implements clusterctl config functionality.
internal
scheme Package scheme implements clusterctl scheme functionality.	Package scheme implements clusterctl scheme functionality.
test Package test implements test functionality.	Package test implements test functionality.
test/providers/bootstrap Package bootstrap defines the types for a generic bootstrap provider used for tests.	Package bootstrap defines the types for a generic bootstrap provider used for tests.
test/providers/controlplane Package controlplane defines the types for a generic control plane provider used for tests.	Package controlplane defines the types for a generic control plane provider used for tests.
test/providers/external Package external defines the types for a generic external provider used for tests.	Package external defines the types for a generic external provider used for tests.
test/providers/infrastructure Package infrastructure defines the types for a generic infrastructure provider used for tests.	Package infrastructure defines the types for a generic infrastructure provider used for tests.
util Package util implements clusterctl utilty functions.	Package util implements clusterctl utilty functions.
log Package log mirrors the controller runtime approach to logging, by defining a global logger that defaults to NullLogger.	Package log mirrors the controller runtime approach to logging, by defining a global logger that defaults to NullLogger.