Skip to content

Commit dd916c9

Browse files
Christoph Glaubitzpierreprinetti
authored andcommitted
Added compatibility information to README.md (openshift#285)
* Added compatibility information to README.md Fixes openshift#251 * Updated NOTE to bold text
1 parent 34cc519 commit dd916c9

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,38 @@ You can reach the maintainers of this project at:
1515

1616
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
1717

18+
------
19+
20+
## Compatibility with Cluster API, Kubernetes and OpenStack Versions
21+
22+
This provider's versions are compatible with the following versions of Cluster API:
23+
24+
||Cluster API v1alpha1 (v0.1)|
25+
|-|-|
26+
|OpenStack Provider v1alpha1 (ea309e7f)||
27+
28+
This provider's versions are able to install and manage the following versions of Kubernetes:
29+
30+
||Kubernetes 1.13.5+|Kubernetes 1.14|
31+
|-|-|-|
32+
|OpenStack Provider v1alpha1 (ea309e7f)|||
33+
34+
**NOTE**: Because the user is able to customize any `user-data`, it is also possible to deploy older versions.
35+
But we won't provide any examples or working templates. See [user-data in the examples](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/tree/master/cmd/clusterctl/examples/openstack/provider-component/user-data).
36+
37+
This provider's versions are able to install kubernetes to the following versions of OpenStack:
38+
39+
||OpenStack Pike|OpenStack Queens|OpenStack Rocky|
40+
|-|-|-|-|
41+
|OpenStack Provider v1alpha1 (ea309e7f)||||
42+
43+
Each version of Cluster API for OpenStack will attempt to support two Kubernetes versions.
44+
45+
**NOTE:** As the versioning for this project is tied to the versioning of Cluster API, future modifications to this
46+
policy may be made to more closely align with other providers in the Cluster API ecosystem.
47+
48+
------
49+
1850
## Getting Started
1951

2052
### Prerequisites
@@ -97,7 +129,7 @@ Additional advanced flags can be found via help.
97129

98130
In `Cluster.spec.ProviderSpec` there is a boolean option called `ManagedSecurityGroups` that, if set to `true`, will create a default set of security groups for the cluster. These are meant for a "standard" setup, and might not be suitable for every environment. Please review the rules below before you use them.
99131

100-
*NOTE*: For now, there is no way to automatically use these rules, which makes them a bit cumbersome to use, this will be possible in the near future.
132+
**NOTE**: For now, there is no way to automatically use these rules, which makes them a bit cumbersome to use, this will be possible in the near future.
101133

102134
The rules created are:
103135

0 commit comments

Comments
 (0)