diff --git a/docs/kubernetes/deploying/deploying.rst b/docs/kubernetes/deploying/deploying.rst index ee94b0e18..f873aa4d7 100644 --- a/docs/kubernetes/deploying/deploying.rst +++ b/docs/kubernetes/deploying/deploying.rst @@ -104,6 +104,14 @@ If the cluster is upgraded to an unsupported version: displayed to indicate that Trident is installed on an unsupported Kubernetes version. +.. warning:: + + If you are looking to install Trident using the operator/Helm Chart on + OpenShift Container Platform, it is recommended that you install Trident v21.01.1 + or later. The Trident operator released with v21.01.0 contains a + `known issue `_ that has been + fixed with v21.01.1. For more details take a look at :ref:`Known Issues <2101-operator-bug>`. + When should I use tridentctl? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/kubernetes/deploying/operator-deploy.rst b/docs/kubernetes/deploying/operator-deploy.rst index 64278de52..0a4ad6e7e 100644 --- a/docs/kubernetes/deploying/operator-deploy.rst +++ b/docs/kubernetes/deploying/operator-deploy.rst @@ -44,6 +44,14 @@ Got all that? Great! Let's get started. You can choose to either :ref:`Deploy using Helm ` or :ref:`Using the Trident Operator `. +.. warning:: + + If you are looking to install Trident using the operator/Helm Chart on + OpenShift Container Platform, it is recommended that you install Trident v21.01.1 + or later. The Trident operator released with v21.01.0 contains a + `known issue `_ that has been + fixed with v21.01.1. For more details take a look at :ref:`Known Issues <2101-operator-bug>`. + Deploy Trident Operator by using Helm ===================================== diff --git a/docs/kubernetes/known-issues.rst b/docs/kubernetes/known-issues.rst index 82cebd1fc..08ee0b4b6 100644 --- a/docs/kubernetes/known-issues.rst +++ b/docs/kubernetes/known-issues.rst @@ -3,6 +3,37 @@ Known issues This page contains a list of known issues that may be observed when using Trident. +.. _2101-operator-bug: + +* The Trident operator released with v21.01.0 contains an `issue `_ + that has been identified with OpenShift Container Platform (OCP 4.x). + Installations that are impacted by this issue will report this error: + + .. code-block:: console + + no kind ‘ClusterRole’ is registered for version ‘authorization.openshift.io/v1\’ in scheme ’k8s.io/kubernetes/pkg/api/legacyscheme/scheme.go:30.``. + + This issue does not + affect the normal functioning of Trident, only the Trident Operator. This + prevents changes made to the TridentOrchestrator custom resource (CR) after + the install/upgrade from taking effect. **This has been fixed with** + `v21.01.1 `_. Users + are advised to bypass v21.01.0 and upgrade directly to v21.01.1 or later. + +* A previously identified issue where iSCSI target portals with a + negative group tag were ignored by Trident has been fixed with + `v21.01.1 `_. This + issue may be observed when ``iscsiadm`` reports target portals with a negative + group tag such as ``-1``, as shown in the example below: + + .. code-block:: bash + + #List iscsi node records + $iscsiadm -m node + 192.168.0.134:3260,-1 iqn.1992-08.com.netapp:sn.6cffffffffffffffff5056b03185:vs.3 + + Upgrading to v21.01.1 or later will fix this issue. + .. _igroup-bug: * When using Trident `v20.07.1 `_ diff --git a/docs/kubernetes/upgrades/operator-upgrade.rst b/docs/kubernetes/upgrades/operator-upgrade.rst index 77bb211ff..1571997da 100644 --- a/docs/kubernetes/upgrades/operator-upgrade.rst +++ b/docs/kubernetes/upgrades/operator-upgrade.rst @@ -33,6 +33,14 @@ To upgrade using the Trident operator: the CRDs for the alpha snapshot spec. For existing snapshots that should be deleted/migrated, please read `this blog`_. +.. warning:: + + When upgrading Trident using the operator on OpenShift Container Platform, users + are recommended to upgrade to v21.01.1 or later. The Trident operator + released with v21.01.0 contains a `known issue `_ + that has been fixed with v21.01.1. For more details take a look at + :ref:`Known Issues <2101-operator-bug>`. + Initiating the upgrade ---------------------- diff --git a/docs/kubernetes/upgrades/upgrading.rst b/docs/kubernetes/upgrades/upgrading.rst index c43924c93..56a7b33e3 100644 --- a/docs/kubernetes/upgrades/upgrading.rst +++ b/docs/kubernetes/upgrades/upgrading.rst @@ -49,6 +49,14 @@ If you are running ``18.07`` and seek to upgrade to the ``20.07`` release, then: and `storage-class-bronze-default.yaml `_. For more information, take a look at the :ref:`Known issues ` tab. +.. warning:: + + When upgrading Trident using the operator on OpenShift Container Platform, users + are recommended to upgrade to v21.01.1 or later. The Trident operator + released with v21.01.0 contains a `known issue `_ + that has been fixed with v21.01.1. For more details take a look at + :ref:`Known Issues <2101-operator-bug>`. + Understanding your upgrade paths --------------------------------