cluster-api

module

v0.0.0-...-8b6a416 Latest Latest Go to latest Published: Mar 15, 2019 License: Apache-2.0

Details

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

Repository

github.com/mgugino-upstream-stage/cluster-api

Links

Open Source Insights

README ¶

Cluster API

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.

Note that Cluster API effort is still in the 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 prototype code is rapidly changing.

Cluster API Architecture

To learn more, see the Cluster API KEP.

Get involved!

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 implementer office hours
- Weekly on Tuesdays @ 12:00 PT (Zoom) and Wednesdays @ 15:00 CET (Zoom)
- Previous meetings: [ notes ]
Chat with us on Slack: #cluster-api

Provider Implementations

The code in this repository is independent of any specific deployment environment. Provider specific code is being developed in separate repositories, some of which are also sponsored by SIG-cluster-lifecycle:

AWS, https://github.com/kubernetes-sigs/cluster-api-provider-aws
AWS/Openshift, https://github.com/openshift/cluster-operator
Azure, https://github.com/kubernetes-sigs/cluster-api-provider-azure
Baidu Cloud, https://github.com/baidu/cluster-api-provider-baiducloud
DigitalOcean, https://github.com/kubernetes-sigs/cluster-api-provider-digitalocean
GCE, https://github.com/kubernetes-sigs/cluster-api-provider-gcp
OpenStack, https://github.com/kubernetes-sigs/cluster-api-provider-openstack
Tencent Cloud, https://github.com/TencentCloud/cluster-api-provider-tencent
vSphere, https://github.com/kubernetes-sigs/cluster-api-provider-vsphere

API Adoption

Following are the implementations managed by third-parties adopting the standard cluster-api and/or machine-api being developed here.

Kubermatic machine-controller, https://github.com/kubermatic/machine-controller/tree/master
Machine API Operator, https://github.com/openshift/machine-api-operator/tree/master
Machine-controller-manager, https://github.com/gardener/machine-controller-manager/tree/cluster-api

Getting Started

Prerequisites

kubectl is required, see here.
clusterctl is a SIG-cluster-lifecycle sponsored tool to manage Cluster API clusters. See here

Directories ¶

Path	Synopsis
cmd
clusterctl
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.
clusterctl/clusterdeployer
clusterctl/clusterdeployer/bootstrap
clusterctl/clusterdeployer/bootstrap/existing
clusterctl/clusterdeployer/bootstrap/kind
clusterctl/clusterdeployer/bootstrap/minikube
clusterctl/clusterdeployer/clusterclient
clusterctl/cmd
clusterctl/phases
clusterctl/providercomponents
clusterctl/validation
manager
pkg
apis Package apis contains Kubernetes API groups.	Package apis contains Kubernetes API groups.
apis/cluster Package cluster contains cluster API versions	Package cluster contains cluster API versions
apis/cluster/common
apis/cluster/v1alpha1 Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io	Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io
apis/cluster/v1alpha1/testutil
apis/machine Package machine contains machine API versions	Package machine contains machine API versions
apis/machine/common
apis/machine/v1beta1 Package v1beta1 contains API Schema definitions for the machine v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/machine +k8s:defaulter-gen=TypeMeta +groupName=machine.openshift.io Package v1beta1 contains API Schema definitions for the machine v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/machine +k8s:defaulter-gen=TypeMeta +groupName=machine.openshift.io	Package v1beta1 contains API Schema definitions for the machine v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/machine +k8s:defaulter-gen=TypeMeta +groupName=machine.openshift.io Package v1beta1 contains API Schema definitions for the machine v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/machine +k8s:defaulter-gen=TypeMeta +groupName=machine.openshift.io
apis/machine/v1beta1/testutil
cert
client/clientset_generated/clientset This package has the automatically generated clientset.	This package has the automatically generated clientset.
client/clientset_generated/clientset/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
client/clientset_generated/clientset/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
client/clientset_generated/clientset/typed/cluster/v1alpha1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset_generated/clientset/typed/cluster/v1alpha1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/clientset_generated/clientset/typed/machine/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset_generated/clientset/typed/machine/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/informers_generated/externalversions
client/informers_generated/externalversions/cluster
client/informers_generated/externalversions/cluster/v1alpha1
client/informers_generated/externalversions/internalinterfaces
client/informers_generated/externalversions/machine
client/informers_generated/externalversions/machine/v1beta1
client/listers_generated/cluster/v1alpha1
client/listers_generated/machine/v1beta1
cmdrunner
controller
controller/cluster
controller/config
controller/error
controller/machine
controller/machinedeployment
controller/machinedeployment/util
controller/machineset
controller/node
controller/noderefutil
errors
kubeadm
testcmdrunner
util

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