vm-scheduler-operator

Start / Stop VM on a cloud ( Still In progress. Only start is supported)

Description

Provide specific schedule to start/stop a VM on cloud. Initial version will support AWS. Later on this will be extended for other clouds.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Setup and Development

Note: EC2 with Ubuntu was used for the development purpose.

Dependencies :

1. Install minikube and docker.
2. Install operator sdk and other dependencies.
3. Create git repo github.com/ManojDhanorkar/vm-scheduler-operator with no contents
4. Clone your repo to your folder and create go project.

go mod init github.com/ManojDhanorkar/vm-scheduler-operator
go mod tidy 

Steps:

1. Generate go operator scheleton using operator SDK .

operator-sdk init --domain xyzcompany.com --repo github.com/ManojDhanorkar/vm-scheduler-operator

2. Enable multigroup

operator-sdk edit --multigroup=true

3. Generate API

operator-sdk create api \
    --group=aws \
    --version=v1 \
    --kind=AWSVMScheduler


	operator-sdk create api \
    --group=azure \
    --version=v1 \
    --kind=AzureVMScheduler

	operator-sdk create api \
    --group=gcp \
    --version=v1 \
    --kind=GCPVMScheduler

4. Follow operator tutorials to update the files for your CR and reconciler.

Use "make generate" and "make manifests"

https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/ https://docs.openshift.com/container-platform/4.11/operators/operator_sdk/golang/osdk-golang-tutorial.html

5. export IMG

export IMG=quay.io/manoj_dhanorkar/vm-scheduler-operator:v1.0

6. Build and push your image to the location specified by IMG:

make docker-build docker-push 

7. Running locally ( outside cluster. This will help you identify most of the errors with your code before you deploy to cluster )

make install run  

7. Deploy the controller to the cluster with the image specified by IMG:

make deploy 

Apply CR

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

2. Check if cron is created by controller . The namespace will be automatically created.

kubectl get all -n vm-scheduler-operator-system 

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

make install

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2022.

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.