https://github.com/cobaltcore-dev/openstack-hypervisor-operator
Kubernetes operator to manage and automate the lifecycle of KVM hypervisor nodes within an OpenStack environment.
https://github.com/cobaltcore-dev/openstack-hypervisor-operator
Last synced: 9 months ago
JSON representation
Kubernetes operator to manage and automate the lifecycle of KVM hypervisor nodes within an OpenStack environment.
- Host: GitHub
- URL: https://github.com/cobaltcore-dev/openstack-hypervisor-operator
- Owner: cobaltcore-dev
- License: apache-2.0
- Created: 2024-10-17T20:12:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-09T13:46:51.000Z (9 months ago)
- Last Synced: 2025-09-09T16:40:18.939Z (9 months ago)
- Language: Go
- Size: 376 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# openstack-hypervisor-operator
Kubernetes operator to manage and automate the lifecycle of KVM hypervisor nodes within an OpenStack environment.
## Description
The OpenStack Hypervisor Operator is a Kubernetes operator designed to manage and automate
the lifecycle of KVM hypervisor nodes within an OpenStack environment. This operator listens for Eviction requests
within the Kubernetes cluster and initiates the evacuation of virtual machines (VMs) from the specified hypervisor
nodes by interacting with the OpenStack API. By leveraging this operator, administrators can ensure seamless and
automated handling of hypervisor node maintenance, upgrades, and failure recovery, thereby enhancing the overall
reliability and efficiency of the OpenStack infrastructure.
## 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=/openstack-hypervisor-operator: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=/openstack-hypervisor-operator: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 openstack-hypervisor-operator charts/openstack-hypervisor-operator
```
**Create instances of your solution**
You can apply the samples (examples) from the config/sample:
```sh
kubectl apply -k config/samples/
```
>**NOTE**: Ensure that the samples has default values to test it out.
### To Uninstall
#### via *kustomize*
**Delete the instances (CRs) from the cluster:**
```sh
kubectl delete -k config/samples/
```
**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
```
## Project Distribution
Following are the steps to build the installer and distribute this project to users.
1. Build the installer for the image built and published in the registry:
```sh
make build-installer IMG=/openstack-hypervisor-operator:tag
```
NOTE: The makefile target mentioned above generates an 'install.yaml'
file in the dist directory. This file contains all the resources built
with Kustomize, which are necessary to install this project without
its dependencies.
2. Using the installer
Users can just run kubectl apply -f to install the project, i.e.:
```sh
kubectl apply -f https://raw.githubusercontent.com//openstack-hypervisor-operator//dist/install.yaml
```
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/openstack-hypervisor-operator/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/openstack-hypervisor-operator/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.