Skip to content

docs: clarify API maturity and stability #720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mandre merged 1 commit into from
Mar 26, 2026
Merged

docs: clarify API maturity and stability #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@ ORC is based on [Gophercloud][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. We
encourage you to contribute, file issues, and help improve the project as we
continue to work on it!
ORC is deployed and used in production environments and is notably a dependency
of Cluster API's [OpenStack provider](https://github.com/kubernetes-sigs/cluster-api-provider-openstack).

The Kubernetes API is currently `v1alpha1`. The core API patterns are stable and
we do not anticipate major structural changes, but the API is still evolving as
we add new controllers and features. We do not have a timeline for graduation to
`v1beta1`.

ORC versioning follows [semver](https://semver.org/spec/v2.0.0.html): there will be no breaking changes within a major release.

Expand Down
8 changes: 5 additions & 3 deletions website/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,14 @@ You define OpenStack resources as Kubernetes custom resources. ORC watches these

## 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][capo].

The Kubernetes API is currently `v1alpha1`. The core API patterns are stable and
we do not anticipate major structural changes, but the API is still evolving as
we add new controllers and features. We do not have a timeline for graduation to
`v1beta1`.

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

Expand Down
Loading