From 47e6765ab0ccde3fd1004015bd445f2a377d8734 Mon Sep 17 00:00:00 2001 From: Steven Smith Date: Wed, 8 Dec 2021 11:41:02 -0500 Subject: [PATCH] Removes versioning policy section from 4.7 and adds relevant information to the usage-oc-kubectl module 1 --- _topic_maps/_topic_map.yml | 3 +- .../openshift_cli/usage-oc-kubectl.adoc | 31 +++++++++++ release_notes/ocp-4-7-release-notes.adoc | 2 - release_notes/versioning-policy.adoc | 51 ------------------- 4 files changed, 32 insertions(+), 55 deletions(-) delete mode 100644 release_notes/versioning-policy.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index ca0d504350a0..d82901681544 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -52,8 +52,7 @@ Distros: openshift-enterprise Topics: - Name: OpenShift Container Platform 4.7 release notes File: ocp-4-7-release-notes -- Name: Versioning policy - File: versioning-policy + --- Name: Architecture Dir: architecture diff --git a/cli_reference/openshift_cli/usage-oc-kubectl.adoc b/cli_reference/openshift_cli/usage-oc-kubectl.adoc index c0c0bc751f31..97162946f05a 100644 --- a/cli_reference/openshift_cli/usage-oc-kubectl.adoc +++ b/cli_reference/openshift_cli/usage-oc-kubectl.adoc @@ -21,6 +21,37 @@ The `oc` binary offers a built-in `login` command that allows authentication and + The additional command `oc new-app`, for example, makes it easier to get new applications started using existing source code or pre-built images. Similarly, the additional command `oc new-project` makes it easier to start a project that you can switch to as your default. +[IMPORTANT] +==== +If you installed an earlier version of the `oc` binary, you cannot use it to complete all of the commands in {product-title} {product-version}. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your {product-title} server version. +==== + +Non-security API changes will involve, at minimum, two minor releases (4.1 to 4.2 to 4.3, for example) to allow older `oc` binaries to update. Using new capabilities might require newer `oc` binaries. A 4.3 server might have additional capabilities that a 4.2 `oc` binary cannot use and a 4.3 `oc` binary might have additional capabilities that are unsupported by a 4.2 server. + +.Compatibility Matrix + +[cols="1,1,1"] +|=== + +| +|*X.Y* (`oc` Client) +|*X.Y+N* footnote:versionpolicyn[Where *N* is a number greater than or equal to 1.] (`oc` Client) + +|*X.Y* (Server) +|image:redcircle-1.png[] +|image:redcircle-3.png[] + +|*X.Y+N* footnote:versionpolicyn[] (Server) +|image:redcircle-2.png[] +|image:redcircle-1.png[] + +|=== +image:redcircle-1.png[] Fully compatible. + +image:redcircle-2.png[] `oc` client might be unable to access server features. + +image:redcircle-3.png[] `oc` client might provide options and features that might not be compatible with the accessed server. + == The kubectl binary The `kubectl` binary is provided as a means to support existing workflows and scripts for new {product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster. diff --git a/release_notes/ocp-4-7-release-notes.adoc b/release_notes/ocp-4-7-release-notes.adoc index d02c93ec6f55..79612e4b24ce 100644 --- a/release_notes/ocp-4-7-release-notes.adoc +++ b/release_notes/ocp-4-7-release-notes.adoc @@ -999,8 +999,6 @@ Operator Lifecycle Manager (OLM) strives to keep up to date with Kubernetes rele As of {product-title} 4.7, OLM and its associated components have been updated to use Kubernetes 1.20. Typically, Kubernetes is backwards compatible with a few of its previous versions. Operator authors are encouraged to keep their projects up to date to maintain compatibility and take advantage of updated resources. -See xref:../release_notes/versioning-policy.adoc#ocp-versioning-policy[OpenShift Container Platform Versioning Policy] for more specific details on backwards compatibility guarantees. - See link:https://kubernetes.io/docs/setup/release/version-skew-policy/[Kubernetes documentation] for details about version skew policies in the upstream Kubernetes project. [discrete] diff --git a/release_notes/versioning-policy.adoc b/release_notes/versioning-policy.adoc deleted file mode 100644 index d935e66e01e1..000000000000 --- a/release_notes/versioning-policy.adoc +++ /dev/null @@ -1,51 +0,0 @@ -[id="ocp-versioning-policy"] -= {product-title} Versioning Policy -include::modules/common-attributes.adoc[] -:context: release-notes - -toc::[] - -{product-title} provides strict backwards compatibility guarantees for all -supported APIs, excluding alpha APIs (which may be changed without notice) and -beta APIs (which may occasionally be changed in a non-backwards compatible -manner). - -Red Hat did not publicly release {product-title} 4.0 and, instead, released -{product-title} 4.1 directly after version 3.11. - -The {product-title} version must match between master and node hosts, excluding -temporary mismatches during cluster upgrades. For example, in a -{product-version} cluster, all masters must be {product-version} and all nodes -must be {product-version}. If you installed an earlier version of `oc`, you -cannot use it to complete all of the commands in {product-title} -{product-version}. You must download and install the new version of `oc`. - -Changes of APIs for non-security related reasons will involve, at minimum, two -minor releases (4.1 to 4.2 to 4.3, for example) to allow older `oc` to update. -Using new capabilities may require newer `oc`. A 4.3 server may have additional -capabilities that a 4.2 `oc` cannot use and a 4.3 `oc` may have additional -capabilities that are not supported by a 4.2 server. - -.Compatibility Matrix - -[cols="1,1,1"] -|=== - -| -|*X.Y* (`oc` Client) -|*X.Y+N* footnote:versionpolicyn[Where *N* is a number greater than 1.] (`oc` Client) - -|*X.Y* (Server) -|image:redcircle-1.png[] -|image:redcircle-3.png[] - -|*X.Y+N* footnote:versionpolicyn[] (Server) -|image:redcircle-2.png[] -|image:redcircle-1.png[] - -|=== -image:redcircle-1.png[] Fully compatible. - -image:redcircle-2.png[] `oc` client may not be able to access server features. - -image:redcircle-3.png[] `oc` client may provide options and features that may not be compatible with the accessed server.