diff --git a/charts/pravega-operator/README.md b/charts/pravega-operator/README.md index 237bcea..c633d59 100644 --- a/charts/pravega-operator/README.md +++ b/charts/pravega-operator/README.md @@ -32,6 +32,42 @@ This command deploys a pravega-operator on the Kubernetes cluster in its default >Note: If the pravega-operator version is 0.4.5, webhookCert.certName and webhookCert.secretName should not be set. Also in this case, bookkeeper operator, cert-manager and the certificate/issuer do not need to be deployed as prerequisites. +## Version Compatibility + +The following table lists which version of the pravega operator chart would install which version of the pravega operator by default. + +| Chart Version | App Version | +| :-----------: | :---------: | +| 0.4.5 | 0.4.5 | +| 0.5.0 | 0.5.0 | +| 0.5.1 | 0.5.1 | +| 0.5.2 | 0.5.2 | +| 0.5.3 | 0.5.3 | +| 0.6.0 | 0.5.4 | + +The following table captures compatibility between the App Versions i.e. the pravega operator versions vs. the Chart Versions. +> NOTE: From Chart Version 0.6.0 onwards, the App Version and the Chart Version fields have been decoupled. + +| Chart Version \ Operator Version | 0.4.x | 0.5.x | +| :------------------------------: | :---: | :---: | +| 0.4.x | Yes | No | +| 0.5.x | No | Yes | +| 0.6.x | No | Yes | + +The following table captures compatibility between pravega operator charts with pravega charts + +| Pravega Chart \ Pravega Operator Chart Version | 0.4.x | 0.5.x | 0.6.x | +| :----------------------------------------------------: | :---: | :---: | :---: | +| pravega-bk-0.5.x | Yes | No | No | +| pravega-bk-0.6.x | Yes | No | No | +| pravega-bk-0.7.x | Yes | No | No | +| pravega-0.5.x | No | Yes | Yes | +| pravega-0.6.x | No | Yes | Yes | +| pravega-0.7.x | No | Yes | Yes | +| pravega-0.8.x | No | Yes | Yes | +| pravega-0.9.x | No | Yes | Yes | +| pravega-0.10.x | No | Yes | Yes | + ## Upgrading Pravega-Operator For upgrading pravega-operator, please refer [upgrade guide](https://github.com/pravega/pravega-operator/blob/master/doc/operator-upgrade.md) diff --git a/charts/pravega/README.md b/charts/pravega/README.md index 7883bae..2409a15 100644 --- a/charts/pravega/README.md +++ b/charts/pravega/README.md @@ -79,6 +79,38 @@ Check out the documentation on [external access](https://github.com/pravega/prav Check out the section on [exposing Segmentstore service on single IP address](https://github.com/pravega/pravega-operator/blob/master/doc/external-access.md#exposing-segmentstore-service-on-single-ip-address-and-different-ports) if your clients need to connect to all Pravega Segmentstore instances on the same IP address from outside Kubernetes. +## Version Compatibility + +The following table lists which version of the pravega chart would install which version of the pravega by default. + +| Chart Version | App Version | +| :-----------: | :---------: | +| 0.5.0 | 0.5.0 | +| 0.5.1 | 0.5.1 | +| 0.6.0 | 0.6.0 | +| 0.6.1 | 0.6.1 | +| 0.6.2 | 0.6.2 | +| 0.7.0 | 0.7.0 | +| 0.7.1 | 0.7.1 | +| 0.7.2 | 0.7.2 | +| 0.7.3 | 0.7.3 | +| 0.8.0 | 0.8.0 | +| 0.9.0 | 0.9.0 | +| 0.9.1 | 0.9.1 | +| 0.10.0 | 0.9.1 | + +The following table captures any breaking changes between the App Versions i.e. the pravega versions vs. the Chart Versions. +> NOTE: From Chart Version 0.10.0 onwards, the App Version and the Chart Version fields have been decoupled. + +| Chart Version \ Pravega Version | 0.5.x | 0.6.x | 0.7.x | 0.8.x | 0.9.x | +| :-----------------------------: | :---: | :---: | :---: | :---: | :---: | +| 0.5.x | Yes | No | No | No | No | +| 0.6.x | Yes | Yes | No | No | No | +| 0.7.x | Yes | Yes | Yes | No | No | +| 0.8.x | Yes | Yes | Yes | Yes | No | +| 0.9.x | Yes | Yes | Yes | Yes | Yes | +| 0.10.x | Yes | Yes | Yes | Yes | Yes | + ## Updating Pravega Cluster For updating the pravega cluster, use the following command