Skip to content

Commit

Permalink
Update documentation (#98)
Browse files Browse the repository at this point in the history
* update README with known issue devfile/api#1626

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* update CLUSTER_SUPPORT.md with current cluster support information

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* update cluster requirements under README

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

---------

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
  • Loading branch information
michael-valdron authored Aug 22, 2024
1 parent eb1219b commit 85ef7f3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
7 changes: 2 additions & 5 deletions CLUSTER_SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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)
- [`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)

0 comments on commit 85ef7f3

Please sign in to comment.