Skip to content

Commit cb2f712

Browse files
committed
[ISV-4897] update README.md
Signed-off-by: Tomáš Man <[email protected]>
1 parent a598859 commit cb2f712

File tree

1 file changed

+6
-36
lines changed

1 file changed

+6
-36
lines changed

README.md

+6-36
Original file line numberDiff line numberDiff line change
@@ -15,48 +15,18 @@ See our [documentation](https://redhat-openshift-ecosystem.github.io/operator-pi
1515

1616
We would love to see your Operator added to this collection. We currently use automated vetting via continuous integration plus manual review to curate a list of high-quality, well-documented Operators. If you are new to Kubernetes Operators start [here](https://sdk.operatorframework.io/build/).
1717

18-
If you have an existing Operator read our contribution guidelines on how to [package](docs/packaging-operator.md). Then the community operator pipeline will be triggered to test your Operator and merge a Pull Request.
19-
2018
## Contributing Guide
2119

22-
- [Prerequisites](docs/contributing-prerequisites.md)
23-
- [Where to place operator](docs/contributing-where-to.md)
24-
- [Creating pull request (PR)](docs/contributing-via-pr.md)
25-
- [Operator Publishing / Review settings](docs/operator-ci-yaml.md)
26-
- [OKD/OpenShift Catalogs criteria and options](docs/packaging-required-criteria-ocp.md)
27-
28-
## Test and release process for the Operator
29-
30-
Refer to the [Community operator pipeline documentation](docs/community-operator-pipeline.md) .
20+
- [Prerequisites](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/contributing-prerequisites/)
21+
- [Where to place operator](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/contributing-where-to/)
22+
- [Creating pull request (PR)](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/contributing-via-pr/)
23+
- [Operator Publishing / Review settings](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/operator-ci-yaml/)
24+
- [OKD/OpenShift Catalogs criteria and options](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/packaging-required-criteria-ocp/)
3125

3226
## IMPORTANT NOTICE
3327

34-
Some APIs versions are deprecated and are OR will no longer be served on the Kubernetes version
35-
`1.22/1.25/1.26` and consequently on vendors like Openshift `4.9/4.12/4.13`.
36-
37-
**What does it mean for you?**
38-
39-
Operator bundle versions using the removed APIs can not work successfully from the respective releases.
40-
Therefore, it is recommended to check if your solutions are failing in these scenarios to stop using these versions
41-
OR by setting the `"olm.properties": '[{"type": "olm.maxOpenShiftVersion", "value": "<OCP version>"}]'`
42-
to block cluster admins upgrades when they have Operator versions installed that can **not**
43-
work well in OCP versions higher than the value informed. Also, by defining a valid OCP range via the annotation `com.redhat.openshift.versions`
44-
into the `metadata/annotations.yaml` for our solution does **not** end up shipped on OCP/OKD versions where it cannot be installed.
45-
46-
> WARNING: `olm.maxOpenShiftVersion` should ONLY be used if you are 100% sure that your Operator bundle version
47-
> cannot work in upper releases. Otherwise, you might provide a bad user experience. Be aware that cluster admins
48-
> will be unable to upgrade their clusters with your solution installed. Then, suppose you do not provide any upper
49-
> version and a valid upgrade path for those who have your Operator installed be able to upgrade it and consequently
50-
> be allowed to upgrade their cluster version (i.e from OCP 4.10 to 4.11). In that case, cluster admins might
51-
> choose to uninstall your Operator and no longer use it so that they can move forward and upgrade their cluster
52-
> version without it.
53-
54-
Please, make sure you check the following announcements:
55-
- [How to deal with removal of v1beta1 CRD removals in Kubernetes 1.22 / OpenShift 4.9](https://github.com/redhat-openshift-ecosystem/community-operators-prod/discussions/138)
56-
- [Kubernetes API removals on 1.25/1.26 and Openshift 4.12/4.13 might impact your Operator. How to deal with it?](https://github.com/redhat-openshift-ecosystem/community-operators-prod/discussions/1182)
28+
Some APIs versions are deprecated and are OR will no longer be served. See https://redhat-openshift-ecosystem.github.io/operator-pipelines/#important-notice
5729

5830
## Reporting Bugs
5931

6032
Use the issue tracker in this repository to report bugs.
61-
62-
[k8s-deprecated-guide]: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22

0 commit comments

Comments
 (0)