Skip to content

Commit 85ef7f3

Browse files
Update documentation (#98)
* update README with known issue devfile/api#1626 Signed-off-by: Michael Valdron <[email protected]> * update CLUSTER_SUPPORT.md with current cluster support information Signed-off-by: Michael Valdron <[email protected]> * update cluster requirements under README Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]>
1 parent eb1219b commit 85ef7f3

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CLUSTER_SUPPORT.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,11 @@ systems based on which Operator SDK version the registry operator
55
is using as well as the API overlap between OpenShift and
66
Kubernetes.
77

8-
| | OpenShift 4.12.x |
9-
|:-----------------:|:----------------:|
10-
| Kubernetes 1.25.x | X |
11-
| Kubernetes 1.26.x | X |
8+
Operator currently targets Kubernetes 1.29 API and is tested on OpenShift 4.15.
129

1310
## Operator SDK
1411

15-
Current version in use by the Registry Operator is [Operator SDK v1.28.0](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.28.0/).
12+
Current version in use by the Registry Operator is [Operator SDK v1.28.0](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.28.0/), planned to use [Operator SDK v1.36.0](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.36.0/) ([devfile/api#1626](https://github.com/devfile/api/issues/1626)) to be in sync with target Kubernetes 1.29 version.
1613

1714
To update the Operator SDK, refer to [Upgrade SDK Version](https://sdk.operatorframework.io/docs/upgrading-sdk-version/)
1815
and change the following

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@ This repository utilizes Release Notes to track and display changes, a changelog
3535

3636
Deployment cluster must meet one of the following criteria:
3737

38-
- OpenShift Container Platform (OCP) 4.12.x
39-
- Kubernetes 1.25.x-1.26.x
38+
- OpenShift Container Platform (OCP) 4.15.x
39+
- Kubernetes 1.29.x
40+
41+
**Note**: Though full support for OpenShift Container Platform (OCP) 4.16.x is not currently in place, it [includes Kubernetes 1.29.x APIs](https://docs.openshift.com/container-platform/4.16/release_notes/ocp-4-16-release-notes.html#ocp-4-16-admin-ack-updating_release-notes) therefore should work in theory.
4042

4143
More on the support of container orchestration systems can be
4244
found [here](CLUSTER_SUPPORT.md).
@@ -173,4 +175,5 @@ Please see our [CONTRIBUTING.md](./CONTRIBUTING.md).
173175
## Known Issues
174176
- [`make test-integration` times out when running in Minikube](https://github.com/devfile/api/issues/1313)
175177
- [Headless mode field does not update devfile registry state during reconcile](https://github.com/devfile/api/issues/1258)
176-
- [`make bundle` removes `alm-examples` for `DevfileRegistriesList` and `ClusterDevfileRegistriesList` CRDs due to bug with Kustomize](https://github.com/kubernetes-sigs/kustomize/issues/5042)
178+
- [`make bundle` removes `alm-examples` for `DevfileRegistriesList` and `ClusterDevfileRegistriesList` CRDs due to bug with Kustomize](https://github.com/kubernetes-sigs/kustomize/issues/5042)
179+
- [Operator SDK is out of sync, should be upgraded to v1.36.0](https://github.com/devfile/api/issues/1626)

0 commit comments

Comments
 (0)