README
¶
machine-controller-manager
Machine Controller Manager (MCM) manages VMs as another kubernetes custom resource. It provides a declarative way to manage VMs. The current implementation supports AWS, GCP, Azure and Openstack. It can easily extended to support other cloud providers as well.
Example of managing machine:
kubectl create/get/delete machine vm1
Cluster-api branch
This branch implements the machine-api aspect of the cluster-api project. Cluster-api is heavily under development, and this branch of MCM will implement the APIs on the best-effort basis.
What does it mean ?
- In layman terms, it means user can expect MCM to process the machine-*.yamls [machine, machineset, machinedeployment] files defined in the cluster-api project.
- Technically it means, mcm-apis are imported from the cluster-api's machine-api.
Key terminologies
Nodes/Machines/VMs are different terminologies used to represent similar things. We use these terms in the following way
- VM: A virtual machine running on any cloud provider.
- Node: Native kubernetes node objects. The objects you get to see when you do a "kubectl get nodes". Although nodes can be either physical/virtual machines, for the purposes of our discussions it refers to a VM.
- Machine: A VM that is provisioned/managed by the Machine Controller Manager.
Design of Machine Controller Manager
See the design documentation in the /docs/design repository, please find the design doc here.
To start using or developing the Machine Controller Manager
See the documentation in the /docs repository, please find the index here.
Cluster-api Implementation
cluster-apibranch of machine-controller-manager implements the machine-api aspect of the cluster-api project.- Link: https://github.com/gardener/machine-controller-manager/tree/cluster-api
- Once cluster-api project gets stable, we may make
masterbranch of MCM as well cluster-api compliant, with well-defined migration notes.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
apis/cluster
Package api is the internal version of the API.
|
Package api is the internal version of the API. |
|
apis/cluster/v1alpha1
+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/gardener/machine-controller-manager/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io
|
+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/gardener/machine-controller-manager/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io |
|
client/clientset/internalversion
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/internalversion/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/internalversion/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/internalversion/typed/cluster/internalversion
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/internalversion/typed/cluster/internalversion/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/cluster/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/cluster/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
controller
Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager
|
Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager Package controller is used to provide the core functionalities of machine-controller-manager |
|
driver
Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines
|
Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines Package driver contains the cloud provider specific implementations to manage machines |
|
features
Package features is reserved for future purposes
|
Package features is reserved for future purposes |
|
openapi
Package openapi exists to hold generated openapi code
|
Package openapi exists to hold generated openapi code |
|
options
Package options is used to specify options to MCM Package options is used to specify options to MCM
|
Package options is used to specify options to MCM Package options is used to specify options to MCM |
|
util/client/metrics/prometheus
Package prometheus creates and registers prometheus metrics with rest clients.
|
Package prometheus creates and registers prometheus metrics with rest clients. |
|
util/reflector/prometheus
Package prometheus sets the cache DefaultMetricsFactory to produce prometheus metrics.
|
Package prometheus sets the cache DefaultMetricsFactory to produce prometheus metrics. |
|
util/taints
Package taints implements utilites for working with taints
|
Package taints implements utilites for working with taints |
Click to show internal directories.
Click to hide internal directories.