README
¶
Cluster API
Please see our Book for more in-depth documentation.
Useful links
What is the Cluster API?
The Cluster API is a Kubernetes project to bring declarative, Kubernetes-style APIs to cluster creation, configuration, and management. It provides optional, additive functionality on top of core Kubernetes.
NB: Cluster API is still in a prototype stage while we get feedback on the API types themselves. All of the code here is to experiment with the API and demo its abilities, in order to drive more technical feedback to the API design. Because of this, all of the codebase is rapidly changing.
Community, discussion, contribution, and support
- Chat with us on Slack in the #cluster-api channel
- Join the SIG Cluster Lifecycle Google Group for access to documents and calendars
- Join our Cluster API working group sessions
- Weekly on Wednesdays @ 10:00 PT on Zoom
- Previous meetings: [ notes | recordings ]
- Provider implementers office hours
Pull Requests are very welcome! See the issue tracker if you're unsure where to start, or feel free to reach out to discuss.
See also: our own contributor guide and the Kubernetes community page.
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
|
|
|
v1alpha2
+k8s:conversion-gen=sigs.k8s.io/cluster-api/pkg/apis/deprecated/v1alpha1 Package v1alpha2 contains API Schema definitions for the cluster v1alpha2 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io
|
+k8s:conversion-gen=sigs.k8s.io/cluster-api/pkg/apis/deprecated/v1alpha1 Package v1alpha2 contains API Schema definitions for the cluster v1alpha2 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io |
|
bootstrap
|
|
|
kubeadm
Module
|
|
|
cmd
|
|
|
clusterctl/clientcmd
Package clientcmd contains convenience methods for working with the kubeconfig and loading specific configurations of api.Config and rest.Config.
|
Package clientcmd contains convenience methods for working with the kubeconfig and loading specific configurations of api.Config and rest.Config. |
|
hack
|
|
|
tools
Module
|
|
|
pkg
|
|
|
apis/deprecated
Package cluster contains cluster API versions
|
Package cluster contains cluster API versions |
|
apis/deprecated/v1alpha1
Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io +groupGoName=ClusterDeprecated Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=sigs.k8s.io/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io +groupGoName=ClusterDeprecated
|
Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io +groupGoName=ClusterDeprecated Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=sigs.k8s.io/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io +groupGoName=ClusterDeprecated |
|
test
module
|
|
|
framework
Module
|
|
|
infrastructure/docker
Module
|
|
|
third_party
|
|