From 85ef7f324afe3790d0cf43dddaf6f9b0eb2caee3 Mon Sep 17 00:00:00 2001 From: Michael Valdron Date: Thu, 22 Aug 2024 10:19:02 -0300 Subject: [PATCH] Update documentation (#98) * update README with known issue devfile/api#1626 Signed-off-by: Michael Valdron * update CLUSTER_SUPPORT.md with current cluster support information Signed-off-by: Michael Valdron * update cluster requirements under README Signed-off-by: Michael Valdron --------- Signed-off-by: Michael Valdron --- CLUSTER_SUPPORT.md | 7 ++----- README.md | 9 ++++++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CLUSTER_SUPPORT.md b/CLUSTER_SUPPORT.md index b46045a..59b1529 100644 --- a/CLUSTER_SUPPORT.md +++ b/CLUSTER_SUPPORT.md @@ -5,14 +5,11 @@ systems based on which Operator SDK version the registry operator is using as well as the API overlap between OpenShift and Kubernetes. -| | OpenShift 4.12.x | -|:-----------------:|:----------------:| -| Kubernetes 1.25.x | X | -| Kubernetes 1.26.x | X | +Operator currently targets Kubernetes 1.29 API and is tested on OpenShift 4.15. ## Operator SDK -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/). +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. To update the Operator SDK, refer to [Upgrade SDK Version](https://sdk.operatorframework.io/docs/upgrading-sdk-version/) and change the following diff --git a/README.md b/README.md index 3bb9d32..5f7c543 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,10 @@ This repository utilizes Release Notes to track and display changes, a changelog Deployment cluster must meet one of the following criteria: -- OpenShift Container Platform (OCP) 4.12.x -- Kubernetes 1.25.x-1.26.x +- OpenShift Container Platform (OCP) 4.15.x +- Kubernetes 1.29.x + +**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. More on the support of container orchestration systems can be found [here](CLUSTER_SUPPORT.md). @@ -173,4 +175,5 @@ Please see our [CONTRIBUTING.md](./CONTRIBUTING.md). ## Known Issues - [`make test-integration` times out when running in Minikube](https://github.com/devfile/api/issues/1313) - [Headless mode field does not update devfile registry state during reconcile](https://github.com/devfile/api/issues/1258) -- [`make bundle` removes `alm-examples` for `DevfileRegistriesList` and `ClusterDevfileRegistriesList` CRDs due to bug with Kustomize](https://github.com/kubernetes-sigs/kustomize/issues/5042) \ No newline at end of file +- [`make bundle` removes `alm-examples` for `DevfileRegistriesList` and `ClusterDevfileRegistriesList` CRDs due to bug with Kustomize](https://github.com/kubernetes-sigs/kustomize/issues/5042) +- [Operator SDK is out of sync, should be upgraded to v1.36.0](https://github.com/devfile/api/issues/1626)