README.md

# Kubevirt
[KubeVirt](https://kubevirt.io) is a CNCF incubating project hosted on [github](https://github.com/kubevirt/kubevirt) to run virtual machines in Kubernetes.

## Description
 Run virtual machines in Kubernetes, full integration with Big Bang is in progress.

## Badges
*coming soon...*

## Visuals
*coming soon...*

## Installation
*coming soon...*

## Usage
### Helm
#### Installing
```shell
helm install kv ./chart --create-namespace --namespace=kubevirt
```
With default values, Kubevirt will deploy the following:
- 2 virt-operators pods
- 2 virt-api pods
- 2 virt-controllers pods
- 3 virt-handlers pods
- 13 custom resource definitions

#### Removing
Per KubeVirt documentation the kubevirt custom resource should be deleted prior to removal of the operator.
```shell
kubectl delete -n kubevirt kubevirt kubevirt --wait=true
helm uninstall kubevirt --namespace=kubevirt
kubectl delete ns kubevirt
kubectl delete crd kubevirts.kubevirt.io
```

### Updating the KubeVirt Big Bang Chart
The helm chart needs to be created from raw manifests, as no equivalent alternative is publicly supported.
1. Generate the chart manifests
```shell
export VERSION=x.y.z # must manually set version 
make update-chart 
make clean
```
2. Review changes, update, and commit

## Support
*coming soon...*

## Roadmap
*coming soon...*

## Contributing
The KubeVirt package is open to contribution, view our [CONTRIBUTING.md](CONTRIBUTING.MD) guide for details.

## License
This project uses the [Apache License version 2.0](LICENSE)

## Project status
Active Development