Skip to content

openstack-resource-controller

Deploy your OpenStack resources in a declarative way, using Kubernetes.

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.

Maturity

While we currently cover a limited subset of OpenStack resources, we focus on making existing controllers as correct and predictable as possible.

ORC is deployed and used in production environments and is notably a dependency of Cluster API's OpenStack provider.

ORC versioning follows semver: there will be no breaking changes within a major release.

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.