README
¶
ORC: openstack-resource-controller
Description
openstack-resource-controller, 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, the OpenStack Go SDK.
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.
- Read the developers guide.
- 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 and feel free to ask questions or propose ideas!
Join us on kubernetes slack, on #gophercloud. Visit slack.k8s.io for an invitation.
Getting Started
Prerequisites
ORC heavily uses CEL validations 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
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the openstack v1alpha1 API group +kubebuilder:object:generate=true +groupName=openstack.k-orc.cloud +k8s:openapi-gen=true
|
Package v1alpha1 contains API Schema definitions for the openstack v1alpha1 API group +kubebuilder:object:generate=true +groupName=openstack.k-orc.cloud +k8s:openapi-gen=true |
|
cmd
|
|
|
manager
command
|
|
|
models-schema
command
|
|
|
resource-generator
command
|
|
|
internal
|
|
|
osclients/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
pkg
|
|
|
clients/clientset/clientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
clients/clientset/clientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
clients/clientset/clientset/typed/api/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
clients/clientset/clientset/typed/api/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
test
|
|