Skip to content
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

Update documentation #98

Merged
merged 3 commits into from
Aug 22, 2024
+8 −8
Merged

Update documentation #98

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12b5285
update README with known issue devfile/api#1626
michael-valdron Aug 21, 2024
306fdc1
update CLUSTER_SUPPORT.md with current cluster support information
michael-valdron Aug 21, 2024
db57858
update cluster requirements under README
michael-valdron Aug 21, 2024
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
7 changes: 2 additions & 5 deletions CLUSTER_SUPPORT.md
View file
Original file line number Diff line number Diff line change
@@ -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
9 changes: 6 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -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)
- [`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)