Skip to content

A set of Kubernetes controllers to manage your OpenStack infrastructure

License

Notifications You must be signed in to change notification settings

k-orc/openstack-resource-controller

Repository files navigation

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.

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 kubenetes 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=v1.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.