Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added release_notes/images/redcircle-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added release_notes/images/redcircle-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added release_notes/images/redcircle-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 21 additions & 17 deletions release_notes/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,36 +24,40 @@ endif::[]
== Versioning Policy

{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). {product-title} will continue to support older clients against newer
servers. For example, a 3.4 client will work against 3.3, 3.4, and 3.5 servers.
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).

The {product-title} version must match between master and node hosts, excluding
temporary mismatches during cluster upgrades. For example, in a 3.5 cluster, all
masters must be 3.5 and all nodes must be 3.5. However, {product-title} will
continue to support older `oc` clients against newer servers. For example, a 3.4
`oc` will work against 3.3, 3.4, and 3.5 servers.

Changes of APIs for non-security related reasons will involve, at minimum, two
minor releases (3.1 to 3.2 to 3.3, for example) to allow older clients to
update. Using new capabilities may require newer clients. A 3.2 server may have
additional capabilities that a 3.1 client cannot use and a 3.2 client may have
additional capabilities that are not supported by a 3.1 server.
minor releases (3.1 to 3.2 to 3.3, for example) to allow older `oc` to update.
Using new capabilities may require newer `oc`. A 3.2 server may have additional
capabilities that a 3.1 `oc` cannot use and a 3.2 `oc` may have additional
capabilities that are not supported by a 3.1 server.

.Compatibility Matrix

[cols="1,1,1"]
|===

|
|*X.Y* (Client)
|*X.Y+N* footnoteref:[versionpolicyn,Where *N* is a number greater than 1.] (Client)
|*X.Y* (`oc` Client)
|*X.Y+N* footnoteref:[versionpolicyn,Where *N* is a number greater than 1.] (`oc` Client)

|*X.Y* (Server)
|1
|3
|image:redcircle-1.png[]
|image:redcircle-3.png[]

|*X.Y+N* footnoteref:[versionpolicyn] (Server)
|2
|1
|image:redcircle-2.png[]
|image:redcircle-1.png[]

|===

<1> Fully compatible.
<2> Client may not be able to access server features.
<3> Client may provide options and features that may not be compatible with the accessed server.
<2> `oc` client may not be able to access server features.
<3> `oc` client may provide options and features that may not be compatible with the accessed server.