Doc updates

NetApp · Feb 27, 2020 · 7781c7b · 7781c7b
1 parent 70f0b15
commit 7781c7b
Show file tree

Hide file tree

Showing 16 changed files with 94 additions and 74 deletions.
diff --git a/docs/dag/kubernetes/deploying_trident.rst b/docs/dag/kubernetes/deploying_trident.rst
@@ -77,7 +77,7 @@ To setup Trident as a CSI provisioner, refer to the :ref:`Deployment Guide <depl
 that the required :ref:`Feature Gates <Feature Gates>` are enabled.
 After deploying, you should consider :ref:`Upgrading existing PVs to CSI volumes <Upgrading legacy volumes to CSI volumes>`
 if you would like to
-use new features such as :ref:`On-demand snapshots <Creating Snapshots of Persistent Volumes>`.
+use new features such as :ref:`On-demand snapshots <On-Demand Volume Snapshots>`.
 
 .. _installer bundle: https://github.com/NetApp/trident/releases/latest
 

diff --git a/docs/dag/kubernetes/security_recommendations.rst b/docs/dag/kubernetes/security_recommendations.rst
@@ -12,7 +12,7 @@ management applications from accessing Trident object definitions or the
 pods to ensure reliable storage and block potential malicious activity.
 To separate out the other applications and users from Trident, always
 install Trident in its own Kubernetes namespace. In our
-:ref:`Installing Trident docs <Install Trident>` we call this namespace
+:ref:`Installing Trident docs <3: Install Trident>` we call this namespace
 `trident`. Putting Trident in its own namespace assures that only the
 Kubernetes administrative personnel have access to the Trident pod and
 the artifacts (such as backend and CHAP secrets if applicable) stored

diff --git a/docs/docker/install/ndvp_cvs_aws_config.rst b/docs/docker/install/ndvp_cvs_aws_config.rst
@@ -1,10 +1,11 @@
 Cloud Volumes Service (CVS) on AWS Configuration
 ================================================
 
-.. info::
-  The NetApp Cloud Volumes Service for AWS does not support volumes less than 100 GB in size. To
-  make it easier to deploy applications, Trident automatically creates 100 GB volumes if a
-  smaller volume is requested. Future releases of the Cloud Volumes Service may remove this restriction.
+.. note::
+
+   The NetApp Cloud Volumes Service for AWS does not support volumes less than 100 GB in size. To
+   make it easier to deploy applications, Trident automatically creates 100 GB volumes if a
+   smaller volume is requested. Future releases of the Cloud Volumes Service may remove this restriction.
 
 In addition to the global configuration values above, when using CVS on AWS, these options are available.  The
 required values are all available in the CVS web user interface.

diff --git a/docs/docker/install/ndvp_cvs_gcp_config.rst b/docs/docker/install/ndvp_cvs_gcp_config.rst
@@ -1,10 +1,11 @@
 Cloud Volumes Service (CVS) on GCP Configuration
 ================================================
 
-.. info::
-  The NetApp Cloud Volumes Service for GCP does not support volumes less than 1 TiB in size. To
-  make it easier to deploy applications, Trident automatically creates 1 TiB volumes if a
-  smaller volume is requested. Future releases of the Cloud Volumes Service may remove this restriction.
+.. note::
+
+   The NetApp Cloud Volumes Service for GCP does not support volumes less than 1 TiB in size. To
+   make it easier to deploy applications, Trident automatically creates 1 TiB volumes if a
+   smaller volume is requested. Future releases of the Cloud Volumes Service may remove this restriction.
 
 In addition to the global configuration values above, when using CVS on GCP, these options are available.
 

diff --git a/docs/docker/use/volumes.rst b/docs/docker/use/volumes.rst
@@ -42,6 +42,7 @@ Refer to the documentation below for your configured storage system to determine
    backends/eseries_options
    backends/cvs_aws_options
    backends/cvs_gcp_options
+   backends/anf_options
 
 Destroy a Volume
 ----------------

diff --git a/docs/kubernetes/concepts/objects.rst b/docs/kubernetes/concepts/objects.rst
@@ -299,14 +299,21 @@ Class is created with this definition:
 
 .. code-block:: yaml
 
-   apiVersion: snapshot.storage.k8s.io/v1alpha1
+   apiVersion: snapshot.storage.k8s.io/v1beta1
    kind: VolumeSnapshotClass
    metadata:
-     name: csi-vsc
-   snapshotter: csi.trident.netapp.io
-
-The ``snapshotter`` instructs Kubernetes that requests for Volume Snapshots
-of the ``csi-vsc`` class will be handled by Trident.
+     name: csi-snapclass
+   driver: csi.trident.netapp.io
+   deletionPolicy: Delete
+
+The ``driver`` instructs Kubernetes that requests for Volume Snapshots
+of the ``csi-snapclass`` class will be handled by Trident. The
+``deletionPolicy`` specifies the action to be taken when a snapshot must
+be deleted. When the ``deletionPolicy`` is set to ``Delete``, the
+Volume Snapshot objects as well as the underlying snapshot on the storage
+cluster are removed when a snapshot is deleted. Alternatively, setting it
+to ``Retain`` will mean that the VolumeSnapshotContent and the physical
+snapshot will be kept.
 
 Kubernetes VolumeSnapshot Objects
 ---------------------------------

diff --git a/docs/kubernetes/deploying.rst b/docs/kubernetes/deploying.rst
@@ -69,7 +69,7 @@ you have the necessary privileges to.
     ping <management IP>
 
 Identify your Kubernetes server version. You will be using it when you
-:ref:`Install Trident <Install Trident>`.
+:ref:`Install Trident <3: Install Trident>`.
 
 2: Download & extract the installer
 ===================================

diff --git a/docs/kubernetes/operations/tasks/backends/ontap.rst b/docs/kubernetes/operations/tasks/backends/ontap.rst
@@ -306,12 +306,12 @@ pools are defined in the ``storage`` section. In this example, some of the stora
               "spaceReserve": "none",
               "encryption": "false"
         },
-        "labels":{"store":"nas-store"},
-        "region": "us-east-1",
+        "labels":{"store":"nas_store"},
+        "region": "us_east_1",
         "storage": [
             {
                 "labels":{"app":"msoffice", "cost":"100"},
-                "zone":"us-east-1a",
+                "zone":"us_east_1a",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "true",
@@ -320,7 +320,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"app":"slack", "cost":"75"},
-                "zone":"us-east-1b",
+                "zone":"us_east_1b",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -329,7 +329,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"app":"wordpress", "cost":"50"},
-                "zone":"us-east-1c",
+                "zone":"us_east_1c",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -338,7 +338,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"app":"mysqldb", "cost":"25"},
-                "zone":"us-east-1d",
+                "zone":"us_east_1d",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "false",
@@ -365,12 +365,12 @@ pools are defined in the ``storage`` section. In this example, some of the stora
               "spaceReserve": "none",
               "encryption": "false"
         },
-        "labels":{"store":"flexgroup-store"},
-        "region": "us-east-1",
+        "labels":{"store":"flexgroup_store"},
+        "region": "us_east_1",
         "storage": [
             {
                 "labels":{"protection":"gold", "creditpoints":"50000"},
-                "zone":"us-east-1a",
+                "zone":"us_east_1a",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "true",
@@ -379,7 +379,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"protection":"gold", "creditpoints":"30000"},
-                "zone":"us-east-1b",
+                "zone":"us_east_1b",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -388,7 +388,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"protection":"silver", "creditpoints":"20000"},
-                "zone":"us-east-1c",
+                "zone":"us_east_1c",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -397,7 +397,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"protection":"bronze", "creditpoints":"10000"},
-                "zone":"us-east-1d",
+                "zone":"us_east_1d",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "false",
@@ -426,12 +426,12 @@ pools are defined in the ``storage`` section. In this example, some of the stora
               "spaceReserve": "none",
               "encryption": "false"
         },
-        "labels":{"store":"nas-economy-store"},
-        "region": "us-east-1",
+        "labels":{"store":"nas_economy_store"},
+        "region": "us_east_1",
         "storage": [
             {
                 "labels":{"department":"finance", "creditpoints":"6000"},
-                "zone":"us-east-1a",
+                "zone":"us_east_1a",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "true",
@@ -440,7 +440,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"department":"legal", "creditpoints":"5000"},
-                "zone":"us-east-1b",
+                "zone":"us_east_1b",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -449,7 +449,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"department":"engineering", "creditpoints":"3000"},
-                "zone":"us-east-1c",
+                "zone":"us_east_1c",
                 "defaults": {
                     "spaceReserve": "none",
                     "encryption": "true",
@@ -458,7 +458,7 @@ pools are defined in the ``storage`` section. In this example, some of the stora
             },
             {
                 "labels":{"department":"humanresource", "creditpoints":"2000"},
-                "zone":"us-east-1d",
+                "zone":"us_east_1d",
                 "defaults": {
                     "spaceReserve": "volume",
                     "encryption": "false",
@@ -486,28 +486,28 @@ pools are defined in the ``storage`` section. In this example, some of the stora
               "spaceAllocation": "false",
               "encryption": "false"
         },
-        "labels":{"store":"san-store"},
-        "region": "us-east-1",
+        "labels":{"store":"san_store"},
+        "region": "us_east_1",
         "storage": [
             {
                 "labels":{"protection":"gold", "creditpoints":"40000"},
-                "zone":"us-east-1a",
+                "zone":"us_east_1a",
                 "defaults": {
                     "spaceAllocation": "true",
                     "encryption": "true"
                 }
             },
             {
                 "labels":{"protection":"silver", "creditpoints":"20000"},
-                "zone":"us-east-1b",
+                "zone":"us_east_1b",
                 "defaults": {
                     "spaceAllocation": "false",
                     "encryption": "true"
                 }
             },
             {
                 "labels":{"protection":"bronze", "creditpoints":"5000"},
-                "zone":"us-east-1c",
+                "zone":"us_east_1c",
                 "defaults": {
                     "spaceAllocation": "true",
                     "encryption": "false"
@@ -533,28 +533,28 @@ pools are defined in the ``storage`` section. In this example, some of the stora
               "spaceAllocation": "false",
               "encryption": "false"
         },
-        "labels":{"store":"san-economy-store"},
-        "region": "us-east-1",
+        "labels":{"store":"san_economy_store"},
+        "region": "us_east_1",
         "storage": [
             {
                 "labels":{"app":"oracledb", "cost":"30"},
-                "zone":"us-east-1a",
+                "zone":"us_east_1a",
                 "defaults": {
                     "spaceAllocation": "true",
                     "encryption": "true"
                 }
             },
             {
                 "labels":{"app":"postgresdb", "cost":"20"},
-                "zone":"us-east-1b",
+                "zone":"us_east_1b",
                 "defaults": {
                     "spaceAllocation": "false",
                     "encryption": "true"
                 }
             },
             {
                 "labels":{"app":"mysqldb", "cost":"10"},
-                "zone":"us-east-1c",
+                "zone":"us_east_1c",
                 "defaults": {
                     "spaceAllocation": "true",
                     "encryption": "false"

diff --git a/docs/kubernetes/operations/tasks/managing.rst b/docs/kubernetes/operations/tasks/managing.rst
@@ -25,6 +25,12 @@ them from being reported, you will have to generate custom YAMLs (using the
 ``--generate-custom-yaml`` flag) and edit them to remove the ``--metrics`` flag
 from being invoked for the ``trident-main`` container.
 
+This `blog <https://netapp.io/2020/02/20/prometheus-and-trident/>`_ is a great
+place to start. It explains how Prometheus and Grafana can
+be used with Trident 20.01 and above to retrieve metrics. The blog explains how you
+can run Prometheus as an operator in your Kubernetes cluster and the creation of a
+ServiceMonitor to obtain Trident's metrics.
+
 Uninstalling Trident
 --------------------
 

diff --git a/docs/kubernetes/troubleshooting.rst b/docs/kubernetes/troubleshooting.rst
@@ -15,6 +15,9 @@ Troubleshooting
 * If there's not enough information in the Trident logs, you can try enabling
   the debug mode for Trident by passing the ``-d`` flag to the install
   parameter: ``./tridentctl install -d -n trident``.
+* When using RedHat CoreOS, it is important to make sure that ``iscsid`` is enabled on
+  the worker nodes and started by default. This can be done using OpenShift
+  MachineConfigs or by modifying the ignition templates.
 * If there are problems with mounting a PV to a container, ensure that ``rpcbind`` is
   installed and running. Use the required package manager for the host OS and check if
   ``rpcbind`` is running. You can check the status of the ``rpcbind`` service by running

diff --git a/docs/support/requirements.rst b/docs/support/requirements.rst
@@ -9,7 +9,7 @@ Trident supports multiple container engines and orchestrators, including:
 
 * `NetApp Kubernetes Service <https://cloud.netapp.com/kubernetes-service>`_
 * Kubernetes 1.11 or later (latest: 1.17)
-* OpenShift 3.11 or 4.2
+* OpenShift 3.11, 4.2 and 4.3
 * Docker Enterprise 2.1 or 3.0
 
 In addition, Trident should work with any distribution of Docker or Kubernetes
@@ -72,6 +72,7 @@ These are the Linux distributions that are known to work:
 * CentOS 7.0 or later
 * RHEL 7.0 or later
 * CoreOS 1353.8.0 or later
+* RedHat CoreOS 4.2 and 4.3
 
 The ``tridentctl`` utility also runs on any of these distributions of Linux.
 

diff --git a/trident-installer/sample-input/backend-ontap-nas-economy-virtual-pools.json b/trident-installer/sample-input/backend-ontap-nas-economy-virtual-pools.json
@@ -11,12 +11,12 @@
         "spaceReserve": "none",
         "encryption": "false"
     },
-    "labels":{"store":"nas-economy-store"},
-    "region": "us-east-1",
+    "labels":{"store":"nas_economy_store"},
+    "region": "us_east_1",
     "storage": [
         {
             "labels":{"department":"finance", "points":"6000"},
-            "zone":"us-east-1a",
+            "zone":"us_east_1a",
             "defaults": {
                 "spaceReserve": "volume",
                 "encryption": "true",
@@ -25,7 +25,7 @@
         },
         {
             "labels":{"department":"legal", "points":"5000"},
-            "zone":"us-east-1b",
+            "zone":"us_east_1b",
             "defaults": {
                 "spaceReserve": "none",
                 "encryption": "true",
@@ -34,7 +34,7 @@
         },
         {
             "labels":{"department":"engineering", "points":"3000"},
-            "zone":"us-east-1c",
+            "zone":"us_east_1c",
             "defaults": {
                 "spaceReserve": "none",
                 "encryption": "true",
@@ -43,7 +43,7 @@
         },
         {
             "labels":{"department":"humanresource", "points":"2000"},
-            "zone":"us-east-1d",
+            "zone":"us_east_1d",
             "defaults": {
                 "spaceReserve": "volume",
                 "encryption": "false",