Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vultr/vultr-cloud-controller-manager

Kubernetes Cloud Controller Manager for Vultr
https://github.com/vultr/vultr-cloud-controller-manager

cloud-controller-manager k8s kubernetes vultr vultr-ccm vultr-cloud-controller-manager vultr-kubernetes

Last synced: 2 months ago
JSON representation

Kubernetes Cloud Controller Manager for Vultr

Awesome Lists containing this project

README 

        
![Unit Tests](https://github.com/vultr/vultr-cloud-controller-manager/workflows/Unit%20Tests/badge.svg)

# Kubernetes Cloud Controller Manager for Vultr



The Vultr Cloud Controller Manager (ccm) provides a fully supported experience of Vultr features in your Kubernetes cluster.



- Node resources are assigned their respective Vultr instance hostnames, Region, PlanID and public/private IPs.

- Node resources get put into their proper state if they are shutdown or removed. This allows for Kubernetes to properly reschedule pods

- Vultr LoadBalancers are automatically deployed when a LoadBalancer service is deployed.



This plugin is in active development and you can track progress in the [Milestones](https://github.com/vultr/vultr-cloud-controller-manager/milestone/1).



## Getting Started



More information about running Vultr cloud controller manager can be found [here](docs)



Examples can also be found [here](docs/examples)



### **Note: do not modify vultr load-balancers manually**

When a load-balancer is created through the CCM (Loadbalancer service type), you should not modify the load-balancer. Your changes will eventually get reverted back due to the CCM validating state.



Any changes to the load-balancer should be done through the service object.



## Development 



Go minimum version `1.19.0`



The `vultr-cloud-controller-manager` uses go modules for its dependencies.



### Building the Binary



Since the `vultr-cloud-controller-manager` is meant to run inside a kubernetes cluster you will need to build the binary to be Linux specific.



`GOOS=linux GOARCH=amd64 go build -o dist/vultr-cloud-controller-manager .`



or by using our `Makefile`



`make build-linux`



This will build the binary and output it to a `dist` folder.



**Note** However if you wish to build the binary with the OS you are using you can run `make build`



### Building the Docker Image



To build a docker image of the `vultr-cloud-controller-manager` you can use the `docker-build` entry in the make file. Take note that it requires 2 variables 



- Version 

- REGISTRY (dockerhub registry name)



an example could be 



`VERSION=v0.1.0 REGISTRY=vultr make docker-build`



or if you chose to run it manually



`docker build . -t vultr-cloud-controller-manager`



Running the image



`docker run -ti vultr/vultr-cloud-controller-manager`



### Deploying to a kubernetes cluster



You will need to make sure that your kubernetes cluster is configured to interact with a `external cloud provider`



More can be read about this in the [Running Cloud Controller](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/)



To deploy the versioned CCM that Vultr providers you will need to apply two yaml files to your cluster which can be found [here](https://github.com/vultr/vultr-cloud-controller-manager/tree/master/docs/releases).



- Secret.yml will take in the region ID in which your cluster is deployed in and your API key.



- v0.X.X.yml is a preconfigured set of kubernetes resources which will help get the CCM installed.