README
¶
Cluster API
👋 Welcome to our project! Our Book can help you get started and provides lots of in-depth information.
Useful links
✨ What is the Cluster API?
Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
Started by the Kubernetes Special Interest Group (SIG) Cluster Lifecycle, the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.
⚙️ Providers
Cluster API can be extended to support any infrastructure (AWS, Azure, vSphere, etc.), bootstrap or control plane (kubeadm is built-in) provider. There is a growing list of supported providers available.
🤗 Community, discussion, contribution, and support
Cluster API is developed in the open, and is constantly being improved by our users, contributors, and maintainers. It is because of you that we are able to automate cluster lifecycle management for the community. Join us!
If you have questions or want to get the latest project news, you can connect with us in the following ways:
- Chat with us on the Kubernetes Slack in the #cluster-api channel
- Subscribe to the SIG Cluster Lifecycle Google Group for access to documents and calendars
- Join our Cluster API working group sessions where we share the latest project news, demos, answer questions, and triage issues
- Weekly on Wednesdays @ 10:00 PT on Zoom
- Previous meetings: [ notes | recordings ]
Pull Requests and feedback on issues are very welcome! See the issue tracker if you're unsure where to start, especially the Good first issue and Help wanted tags, and also feel free to reach out to discuss.
See also our contributor guide and the Kubernetes community page for more details on how to get involved.
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Documentation
¶
Overview ¶
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
|
Package v1alpha3 contains the v1alpha3 API implementation. |
|
v1alpha4
Package v1alpha4 contains the v1alpha4 API implementation.
|
Package v1alpha4 contains the v1alpha4 API implementation. |
|
v1beta1
Package v1beta1 contains the v1beta1 API implementation.
|
Package v1beta1 contains the v1beta1 API implementation. |
|
v1beta1/index
Package index provides indexes for the api.
|
Package index provides indexes for the api. |
|
bootstrap
|
|
|
kubeadm/api/v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
|
Package v1alpha3 contains the v1alpha3 API implementation. |
|
kubeadm/api/v1alpha4
Package v1alpha4 contains the v1alpha4 API implementation.
|
Package v1alpha4 contains the v1alpha4 API implementation. |
|
kubeadm/api/v1beta1
Package v1beta1 contains API Schema definitions for the kubeadm v1beta1 API group +kubebuilder:object:generate=true +groupName=bootstrap.cluster.x-k8s.io
|
Package v1beta1 contains API Schema definitions for the kubeadm v1beta1 API group +kubebuilder:object:generate=true +groupName=bootstrap.cluster.x-k8s.io |
|
kubeadm/controllers
Package controllers implements the Kubeadm controllers.
|
Package controllers implements the Kubeadm controllers. |
|
kubeadm/types
Package utils contains Kubeadm utility types.
|
Package utils contains Kubeadm utility types. |
|
kubeadm/types/upstreamv1beta1
Package upstreamv1beta1 contains a mirror of kubeadm API v1beta1 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes.
|
Package upstreamv1beta1 contains a mirror of kubeadm API v1beta1 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes. |
|
kubeadm/types/upstreamv1beta2
Package upstreamv1beta2 contains a mirror of kubeadm API v1beta2 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes.
|
Package upstreamv1beta2 contains a mirror of kubeadm API v1beta2 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes. |
|
kubeadm/types/upstreamv1beta3
Package upstreamv1beta3 contains a mirror of kubeadm API v1beta3 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes.
|
Package upstreamv1beta3 contains a mirror of kubeadm API v1beta3 API, required because it is not possible to import k/K. IMPORTANT: Do not change these files! IMPORTANT: only for KubeadmConfig serialization/deserialization, and should not be used for other purposes. |
|
util
Package util implements kubeadm utility functionality.
|
Package util implements kubeadm utility functionality. |
|
cmd
|
|
|
clusterctl/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 |
|
clusterctl/client
Package client implements clusterctl client functionality.
|
Package client implements clusterctl client functionality. |
|
clusterctl/client/alpha
Package alpha implements clusterctl alpha functionality.
|
Package alpha implements clusterctl alpha functionality. |
|
clusterctl/client/cluster
Package cluster implements clusterctl cluster functionality.
|
Package cluster implements clusterctl cluster functionality. |
|
clusterctl/client/config
Package config implements clusterctl config functionality.
|
Package config implements clusterctl config functionality. |
|
clusterctl/client/repository
Package repository implements clusterctl repository functionality.
|
Package repository implements clusterctl repository functionality. |
|
clusterctl/client/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. |
|
clusterctl/client/yamlprocessor
Package yamlprocessor implements YAML processing.
|
Package yamlprocessor implements YAML processing. |
|
clusterctl/cmd
Package cmd implements clusterctl commands.
|
Package cmd implements clusterctl commands. |
|
clusterctl/cmd/rollout
Package rollout implements the clusterctl rollout command.
|
Package rollout implements the clusterctl rollout command. |
|
clusterctl/config
Package config implements clusterctl config functionality.
|
Package config implements clusterctl config functionality. |
|
clusterctl/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. |
|
Package controllers implements controllers.
|
Package controllers implements controllers. |
|
external
Package external implements external controller types.
|
Package external implements external controller types. |
|
noderefutil
Package noderefutil implements NodeRef utils.
|
Package noderefutil implements NodeRef utils. |
|
remote
Package remote implements remote controllers.
|
Package remote implements remote controllers. |
|
remote/fake
Package fake implements testing fakes.
|
Package fake implements testing fakes. |
|
controlplane
|
|
|
kubeadm/api/v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
|
Package v1alpha3 contains the v1alpha3 API implementation. |
|
kubeadm/api/v1alpha4
Package v1alpha4 contains the v1alpha4 API implementation.
|
Package v1alpha4 contains the v1alpha4 API implementation. |
|
kubeadm/api/v1beta1
Package v1beta1 contains API Schema definitions for the kubeadm v1beta1 API group +kubebuilder:object:generate=true +groupName=controlplane.cluster.x-k8s.io
|
Package v1beta1 contains API Schema definitions for the kubeadm v1beta1 API group +kubebuilder:object:generate=true +groupName=controlplane.cluster.x-k8s.io |
|
kubeadm/controllers
Package controllers implements the Kubeadm controllers.
|
Package controllers implements the Kubeadm controllers. |
|
kubeadm/webhooks
Package webhooks provides the validating webhook for KubeadmControlPlane scale subresource.
|
Package webhooks provides the validating webhook for KubeadmControlPlane scale subresource. |
|
Package errors makes a set of error message handlers available for use by Cluster API Providers.
|
Package errors makes a set of error message handlers available for use by Cluster API Providers. |
|
Package exp implements experimental code.
|
Package exp implements experimental code. |
|
addons/api/v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
|
Package v1alpha3 contains the v1alpha3 API implementation. |
|
addons/api/v1alpha4
Package v1alpha4 contains the v1alpha4 API implementation.
|
Package v1alpha4 contains the v1alpha4 API implementation. |
|
addons/api/v1beta1
Package v1beta1 contains API Schema definitions for the addons v1beta1 API group +kubebuilder:object:generate=true +groupName=addons.cluster.x-k8s.io
|
Package v1beta1 contains API Schema definitions for the addons v1beta1 API group +kubebuilder:object:generate=true +groupName=addons.cluster.x-k8s.io |
|
addons/controllers
Package controllers implements the exp/addons controllers.
|
Package controllers implements the exp/addons controllers. |
|
api/v1alpha3
Package v1alpha3 contains the v1alpha3 API implementation.
|
Package v1alpha3 contains the v1alpha3 API implementation. |
|
api/v1alpha4
Package v1alpha4 contains the v1alpha4 API implementation.
|
Package v1alpha4 contains the v1alpha4 API implementation. |
|
api/v1beta1
Package v1beta1 contains API Schema definitions for the exp v1beta1 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io
|
Package v1beta1 contains API Schema definitions for the exp v1beta1 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io |
|
controllers
Package controllers implements experimental controllers.
|
Package controllers implements experimental controllers. |
|
util
Package util implements utility functions.
|
Package util implements utility functions. |
|
Package feature implements feature functionality.
|
Package feature implements feature functionality. |
|
hack
|
|
|
boilerplate/test
Package test contains test boilerplate.
|
Package test contains test boilerplate. |
|
tools
Module
|
|
|
test
module
|
|
|
framework
Module
|
|
|
infrastructure/docker
Module
|
|
|
third_party
|
|
|
Package util implements utilities.
|
Package util implements utilities. |
|
annotations
Package annotations implements annotation helper functions.
|
Package annotations implements annotation helper functions. |
|
certs
Package certs implements cert handling utilities.
|
Package certs implements cert handling utilities. |
|
collections
Package collections implements collection utilities.
|
Package collections implements collection utilities. |
|
conditions
Package conditions implements condition utilities.
|
Package conditions implements condition utilities. |
|
container
Package container implements container utility functionality.
|
Package container implements container utility functionality. |
|
conversion
Package conversion implements conversion utilities.
|
Package conversion implements conversion utilities. |
|
defaulting
Package defaulting implements defaulting webhook functionality.
|
Package defaulting implements defaulting webhook functionality. |
|
failuredomains
Package failuredomains implements FailureDomain utility functions.
|
Package failuredomains implements FailureDomain utility functions. |
|
kubeconfig
Package kubeconfig implements utilities for working with kubeconfigs.
|
Package kubeconfig implements utilities for working with kubeconfigs. |
|
labels
Package labels implements label utility functions.
|
Package labels implements label utility functions. |
|
patch
Package patch implements patch utilities.
|
Package patch implements patch utilities. |
|
predicates
Package predicates implements predicate utilities.
|
Package predicates implements predicate utilities. |
|
record
Package record implements recording functionality.
|
Package record implements recording functionality. |
|
resource
Package resource implements resource utilites.
|
Package resource implements resource utilites. |
|
secret
Package secret implements utilities for secret handling.
|
Package secret implements utilities for secret handling. |
|
version
Package version implements version handling.
|
Package version implements version handling. |
|
yaml
Package yaml implements yaml utility functions.
|
Package yaml implements yaml utility functions. |
|
Package version implements version handling code.
|
Package version implements version handling code. |
|
Package webhooks contains external webhook implementations for some of our API types.
|
Package webhooks contains external webhook implementations for some of our API types. |
|
internal
|
|
|
contract
Package contract provides support for the ClusterReconciler to handle with providers objects according to the Cluster API contract.
|
Package contract provides support for the ClusterReconciler to handle with providers objects according to the Cluster API contract. |
|
controllers/cluster
Package cluster implements cluster controller.
|
Package cluster implements cluster controller. |
|
controllers/clusterclass
Package clusterclass implements the clusterclass controller.
|
Package clusterclass implements the clusterclass controller. |
|
controllers/machine
Package machine implements machine controller.
|
Package machine implements machine controller. |
|
controllers/machinedeployment
Package machinedeployment implements machinedeployment controller.
|
Package machinedeployment implements machinedeployment controller. |
|
controllers/machinedeployment/mdutil
Package mdutil implements MachineDeployment utilities meant to be consumed internally by the controller.
|
Package mdutil implements MachineDeployment utilities meant to be consumed internally by the controller. |
|
controllers/machinehealthcheck
Package machinehealthcheck implements machinehealthcheck controller.
|
Package machinehealthcheck implements machinehealthcheck controller. |
|
controllers/machineset
Package machineset implements machineset controller.
|
Package machineset implements machineset controller. |
|
controllers/topology/cluster
Package cluster implements the cluster topology controller.
|
Package cluster implements the cluster topology controller. |
|
controllers/topology/cluster/mergepatch
Package mergepatch implements merge patch support for managed topology.
|
Package mergepatch implements merge patch support for managed topology. |
|
controllers/topology/cluster/patches
Package patches implement the patch engine.
|
Package patches implement the patch engine. |
|
controllers/topology/cluster/patches/api
Package api contains the API definition for the patch engine.
|
Package api contains the API definition for the patch engine. |
|
controllers/topology/cluster/patches/inline
Package inline implements the inline JSON patch generator.
|
Package inline implements the inline JSON patch generator. |
|
controllers/topology/cluster/patches/variables
Package variables calculates variables for patching.
|
Package variables calculates variables for patching. |
|
controllers/topology/cluster/scope
Package scope provides types for handling all the information to process a request in the topology/ClusterReconciler controller.
|
Package scope provides types for handling all the information to process a request in the topology/ClusterReconciler controller. |
|
controllers/topology/machinedeployment
Package machinedeployment implements the machinedeployment topology controller.
|
Package machinedeployment implements the machinedeployment topology controller. |
|
controllers/topology/machineset
Package machineset implements the machineset topology controller.
|
Package machineset implements the machineset topology controller. |
|
log
Package log provides log utilities for the topology package.
|
Package log provides log utilities for the topology package. |
|
test/builder
Package builder implements builder and CRDs for creating API objects for testing.
|
Package builder implements builder and CRDs for creating API objects for testing. |
|
test/envtest
Package envtest contains the test environment to run integration tests.
|
Package envtest contains the test environment to run integration tests. |
|
test/matchers
Package matchers contains the functionality to match two Kubernetes runtime.Objects.
|
Package matchers contains the functionality to match two Kubernetes runtime.Objects. |
|
topology/check
Package check implements checks for managed topology.
|
Package check implements checks for managed topology. |
|
topology/variables
Package variables implements validation and defaulting for ClusterClass variables.
|
Package variables implements validation and defaulting for ClusterClass variables. |
|
webhooks
Package webhooks contains external webhook implementations for some of our API types.
|
Package webhooks contains external webhook implementations for some of our API types. |
|
webhooks/test
Package test contains integration tests for webhooks.
|
Package test contains integration tests for webhooks. |