Skip to content

Commit

Permalink
Updating the docs for 20.07.1
Browse files Browse the repository at this point in the history
  • Loading branch information
balaramesh authored Sep 22, 2020
1 parent 7d4ee52 commit dc07b16
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 3 deletions.
30 changes: 30 additions & 0 deletions docs/kubernetes/known-issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,36 @@ Known issues

This page contains a list of known issues that may be observed when using Trident.

* An upstream Kubernetes `bug <https://github.com/kubernetes/kubernetes/issues/84226>`_
that could be encountered when rapidly attaching/detaching volumes has been
fixed with Trident `v20.07.1 <https://github.com/NetApp/trident/releases/tag/v20.07.1>`_
and the
`v2.0.1 <https://github.com/kubernetes-csi/external-provisioner/blob/release-2.0/CHANGELOG/CHANGELOG-2.0.md#urgent-upgrade-notes>`_
release of the CSI external-provisioner sidecar. Trident `v20.07.1 <https://github.com/NetApp/trident/releases/tag/v20.07.1>`_
will use the ``2.0.1`` release of the ``external-provisioner`` sidecar for all
Kubernetes clusters running ``1.17`` and above. If using Kubernetes ``1.16``
or below, you must upgrade your Kubernetes cluster to ``1.17`` or above for
Trident v20.07.1 to fix this issue.
* A previously identified `issue <https://github.com/NetApp/trident/issues/430>`_
with updating the storage prefix for a Trident backend has been resolved with
Trident `v20.07.1 <https://github.com/NetApp/trident/releases/tag/v20.07.1>`_.
Users can work with backends that use an empty storage prefix (``""``) or one
that includes ``"-"``.
* With Trident `v20.07.1 <https://github.com/NetApp/trident/releases/tag/v20.07.1>`_
using the `v2.0.1 <https://github.com/kubernetes-csi/external-provisioner/blob/release-2.0/CHANGELOG/CHANGELOG-2.0.md#urgent-upgrade-notes>`_
release of the CSI external-provisioner sidecar, customers can set a blank ``fsType``
on the storageClass. For Kubernetes clusters
running ``1.17`` or above, upgrading to Trident ``20.07.1`` would enable users
to override the default ``ext4`` fsType. Setting the ``fsType`` blank
("") for NAS volumes will make Trident set ``fsType=nas`` on all created volumes.
* Trident has continually improved the resiliency for iSCSI volumes.
The `v20.07.0 <https://github.com/NetApp/trident/releases/tag/v20.07.0>`_
release implements
`multiple additional checks <https://github.com/NetApp/trident/issues/418#issuecomment-666019020>`_
that eliminate accidental deletions from occuring.
* Trident may create multiple unintended secrets when it attempts to patch Trident
service accounts. This is a bug and **is fixed** with
`v20.07.1 <https://github.com/NetApp/trident/releases/tag/v20.07.1>`_.
* When installing Trident (using ``tridentctl`` or the Trident Operator) and
using ``tridentctl`` to manage Trident, you must ensure the
``KUBECONFIG`` environment variable is set. This is necessary to indicate
Expand Down
21 changes: 20 additions & 1 deletion docs/kubernetes/operations/tasks/volumes/snapshots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,25 @@ volumes that have been created by Trident and can also be used to schedule
the creation of additional volumes (clones). This feature is available for
Kubernetes ``1.17`` and above.

Creating volume snapshots requires an external snapshot controller to be created,
as well as some Custom Resource Definitions (CRDs). This is the responsibility of
the Kubernetes orchestrator that is being used (E.g., Kubeadm, GKE, OpenShift).
Check with your Kubernetes orchestrator to confirm these requirements are met.
You can create an external snapshot-controller and snapshot CRDs using the code
snippet below.

.. code-block:: bash
$ cat snapshot-setup.sh
#!/bin/bash
# Create volume snapshot CRDs
kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/release-2.1/config/crd/snapshot.storage.k8s.io_volumesnapshotclasses.yaml
kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/release-2.1/config/crd/snapshot.storage.k8s.io_volumesnapshotcontents.yaml
kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/release-2.1/config/crd/snapshot.storage.k8s.io_volumesnapshots.yaml
# Create the snapshot-controller in the default namespace.
kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/release-2.1/deploy/kubernetes/snapshot-controller/rbac-snapshot-controller.yaml
kubectl apply -f https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/release-2.1/deploy/kubernetes/snapshot-controller/setup-snapshot-controller.yaml
.. note::

Volume snapshot is supported by the ``ontap-nas``, ``ontap-san``,
Expand All @@ -19,7 +38,7 @@ Kubernetes ``1.17`` and above.
Trident handles the creation of VolumeSnapshots for its drivers as explained
below:

* For the ``ontap-nas``, ``ontap-san``, ``aws-cvs`` and ``azure-netapp-files``
* For the ``ontap-nas``, ``ontap-san``, ``aws-cvs``, ``gcp-cvs`` and ``azure-netapp-files``
drivers, each PV maps to a FlexVol. As a result, VolumeSnapshots are created
as NetApp Snapshots. NetApp's Snapshot technology delivers more stability,
scalability, recoverability, and performance than competing snapshot
Expand Down
4 changes: 2 additions & 2 deletions docs/support/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Supported frontends (orchestrators)

Trident supports multiple container engines and orchestrators, including:

* Kubernetes 1.11 or later (latest: 1.18)
* Kubernetes 1.11 or later (latest: 1.19)
* OpenShift 3.11, 4.2, 4.3, 4.4, and 4.5
* Docker Enterprise 2.1, 3.0, and 3.1
* Anthos GKE On-Prem v1.1, v1.2, v1.3, and v1.4 (latest: v1.4)

The Trident Operator is supported with these releases:

* Kubernetes 1.14 or later (latest 1.18)
* Kubernetes 1.14 or later (latest 1.19)
* OpenShift 4.2, 4.3, 4.4, and 4.5
* Anthos GKE On-Prem v1.1, v1.2, v1.3, and v1.4 (latest: v1.4)

Expand Down

0 comments on commit dc07b16

Please sign in to comment.