https://github.com/k-orc/openstack-resource-controller
A set of Kubernetes controllers to manage your OpenStack infrastructure
https://github.com/k-orc/openstack-resource-controller
controller kubernetes openstack orc
Last synced: 6 months ago
JSON representation
A set of Kubernetes controllers to manage your OpenStack infrastructure
- Host: GitHub
- URL: https://github.com/k-orc/openstack-resource-controller
- Owner: k-orc
- License: apache-2.0
- Created: 2023-10-21T04:41:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T14:20:16.000Z (6 months ago)
- Last Synced: 2025-03-28T15:27:43.414Z (6 months ago)
- Topics: controller, kubernetes, openstack, orc
- Language: Go
- Homepage: https://k-orc.cloud/
- Size: 32.5 MB
- Stars: 35
- Watchers: 6
- Forks: 10
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ORC: openstack-resource-controller
## Description
[**openstack-resource-controller**][orc], or **ORC**, is a Kubernetes API for
declarative management of OpenStack resources. By fully controlling the order
of OpenStack operations, it allows consumers to easily create, manage, and
reproduce complex deployments. ORC aims to be easily consumed both directly by
users, and by higher level controllers. ORC aims to cover all OpenStack APIs
which can be expressed declaratively.
ORC is based on [Gophercloud][gophercloud], the OpenStack Go SDK.
[orc]: https://github.com/k-orc/openstack-resource-controller
[gophercloud]: https://github.com/gophercloud/gophercloud
## Disclaimer
This project is in active development, and features, functionality, or APIs may
change frequently. While we strive to make the project stable, you may
encounter bugs, unfinished features, or breaking changes. We encourage you to
contribute, file issues, and help improve the project as we continue to work on
it!
## How You Can Contribute
We welcome contributions of all kinds! Whether you’re fixing bugs, adding new features, or improving documentation, your help is greatly appreciated. To get started:
* Fork the repository.
* Create a new branch for your changes.
* Setup a [local development environment](https://k-orc.cloud/development/quickstart/).
* Read the [developers guide](https://k-orc.cloud/development/).
* Make your changes and test thoroughly.
* Submit a pull request with a clear description of your changes.
If you're unsure where to start, check out the [open issues](https://github.com/k-orc/openstack-resource-controller/issues) and feel free to ask
questions or propose ideas!
Join us on kubernetes slack, on [#gophercloud](https://kubernetes.slack.com/archives/C05G4NJ6P6X). Visit [slack.k8s.io](https://slack.k8s.io) for an invitation.
## Getting Started
### Prerequisites
ORC heavily uses [CEL validations](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation-rules) and thus depends on Kubernetes v1.29 or above.
### Installation
To install a released version of ORC, the simplest is probably to use the provided kustomization file:
```
export ORC_RELEASE="https://github.com/k-orc/openstack-resource-controller/dist?ref=v2.0.0"
kubectl apply --server-side -k $ORC_RELEASE
```
You may later uninstall ORC using the same kustomization file:
```
kubectl delete -k $ORC_RELEASE
```
### Usage
* [Deploy your first OpenStack resource using ORC](https://k-orc.cloud/getting-started/)
## Supported resources
| **controller** | **1.x** | **main** |
|:--------------:|:-------:|:--------:|
| flavor | | ✔ |
| image | ✔ | ✔ |
| network | | ◐ |
| port | | ◐ |
| router | | ◐ |
| security group | | ✔ |
| server | | ◐ |
| subnet | | ◐ |
✔: mostly implemented
◐: partially implemented
## License
Copyright 2024.
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.