https://github.com/cobaltcore-dev/kvm-node-agent
KVM Node agent controlling Hypervisor objects to Kubernetes API
https://github.com/cobaltcore-dev/kvm-node-agent
Last synced: 10 days ago
JSON representation
KVM Node agent controlling Hypervisor objects to Kubernetes API
- Host: GitHub
- URL: https://github.com/cobaltcore-dev/kvm-node-agent
- Owner: cobaltcore-dev
- License: apache-2.0
- Created: 2024-07-23T18:11:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-15T18:26:03.000Z (3 months ago)
- Last Synced: 2025-08-15T20:37:17.959Z (3 months ago)
- Language: Go
- Size: 234 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# kvm-node-agent
KVM Node agent for controlling Hypervisor objects via Kubernetes API.
## Description
The KVM node agent is a kubernetes operator that runs on every KVM node provides introspection to KVM specif services and status.
## Getting Started
### Prerequisites
- go version v1.22.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**
```sh
make docker-build docker-push IMG=/kvm-node-agent:tag
```
**NOTE:** This image ought to be published in the personal registry you specified.
And it is required to have access to pull the image from the working environment.
Make sure you have the proper permission to the registry if the above commands don’t work.
#### Installation via *kustomize*
**Install the CRDs into the cluster:**
```sh
make install
```
**Deploy the Manager to the cluster with the image specified by `IMG`:**
```sh
make deploy IMG=/kvm-node-agent:tag
```
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.
#### Installation via *Helm*
Install CRDs and Controller
```sh
helm upgrade --install kvm-node-agent charts/kvm-node-agent
```
### To Uninstall
#### via *kustomize*
**Delete the APIs(CRDs) from the cluster:**
```sh
make uninstall
```
**UnDeploy the controller from the cluster:**
```sh
make undeploy
```
#### via *Helm*
```sh
helm delete kvm-node-agent
```
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/kvm-node-agent/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
## Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cobaltcore-dev/kvm-node-agent/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
## Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
## License
Copyright 2024 SAP SE or an SAP affiliate company and cobaltcore-dev contributors.
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.
Please see our [LICENSE](LICENSE) for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cobaltcore-dev/kvm-node-agent).