Doc updates

NetApp · Apr 30, 2021 · 5111e29 · 5111e29
1 parent 0ca0475
commit 5111e29
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 12 deletions.
diff --git a/docs/dag/kubernetes/integrating_trident.rst b/docs/dag/kubernetes/integrating_trident.rst
@@ -147,18 +147,27 @@ Cloud Volumes Service with GCP Backend Driver
 ---------------------------------------------
 
 Trident uses the ``gcp-cvs`` driver to link with the Cloud Volumes Service on the GCP backend. To configure the GCP backend on Trident, you are required specify ``projectNumber``, ``apiRegion``, and ``apiKey`` in the backend file. The project number may be found in the GCP web portal, while the API key must be taken from the service account private key file that you created while setting up API access for Cloud Volumes on GCP.
-Trident can create CVS volumes in one of two service types:
+Trident can create CVS volumes in one of two `service types <https://cloud.google.com/architecture/partners/netapp-cloud-volumes/service-types>`_:
 
-1. The base CVS service type, which provides high zonal availability with
+1. **CVS**: The base CVS service type, which provides high zonal availability with
    limited/moderate performance levels.
-2. The CVS-Performance service type, which is performance optimized and suited
+2. **CVS-Performance**: Performance-optimized service type best suited
    for production workloads that value performance. Choose from three unique service levels
    [`standard`, `premium`, and `extreme`].
 
 More information on this driver may be found in the :ref:`Cloud Volumes Service for GCP Documentation <Cloud Volumes Service for GCP>`.
 Currently, 100 GiB is the minimum CVS-Performance volume size that will be provisioned, while CVS volumes must be at
 least 300 GiB. Future releases of CVS may remove this restriction.
 
+.. warning::
+
+ When deploying backends using the default CVS service type [``storageClass=software``],
+ users **must obtain access** to the sub-1TiB volumes feature on GCP for the Project Number(s)
+ and Project ID(s) in question. This is necessary for Trident to provision sub-1TiB volumes.
+ If not, volume creations **will fail** for PVCs that are <600 GiB. Obtain access to sub-1TiB
+ volumes using `this <https://docs.google.com/forms/d/e/1FAIpQLSc7_euiPtlV8bhsKWvwBl3gm9KUL4kOhD7lnbHC3LlQ7m02Dw/viewform>`_
+ form.
+
 .. table:: Cloud Volume Service driver capabilities
 
    +--------------------+--------------+--------+--------------+------+-------------------+---------------+

diff --git a/docs/docker/install/ndvp_cvs_gcp_config.rst b/docs/docker/install/ndvp_cvs_gcp_config.rst
@@ -8,6 +8,31 @@ Cloud Volumes Service (CVS) on GCP Configuration
    the minimum size if a too-small volume is requested. Future releases of the Cloud Volumes Service may remove this
    restriction.
 
+Trident now includes support for smaller volumes with the default CVS service type on
+GCP (https://cloud.google.com/architecture/partners/netapp-cloud-volumes/service-types).
+For backends created with ``storageClass=software``, volumes will now have a
+minimum provisioning size of 300 GiB. CVS currently provides this feature under
+Controlled Availability and does **not provide** technical support.
+Users must sign up for access to sub-1TiB
+volumes `here <https://docs.google.com/forms/d/e/1FAIpQLSc7_euiPtlV8bhsKWvwBl3gm9KUL4kOhD7lnbHC3LlQ7m02Dw/viewform>`_.
+NetApp recommends customers consume sub-1TiB volumes for **non-production** workloads.
+
+.. warning::
+
+ When deploying backends using the default CVS service type [``storageClass=software``],
+ users **must obtain access** to the sub-1TiB volumes feature on GCP for the Project Number(s)
+ and Project ID(s) in question. This is necessary for Trident to provision sub-1TiB volumes.
+ If not, volume creations **will fail** for PVCs that are <600 GiB. Obtain access to sub-1TiB
+ volumes using `this <https://docs.google.com/forms/d/e/1FAIpQLSc7_euiPtlV8bhsKWvwBl3gm9KUL4kOhD7lnbHC3LlQ7m02Dw/viewform>`_
+ form.
+
+Volumes created by Trident for the default CVS service level will be provisioned as follows:
+
+1. PVCs that are smaller than 300 GiB will result in Trident creating a 300 GiB CVS volume.
+2. PVCs that are between 300 GiB to 600 GiB will result in Trident creating a CVS volume of the requested size.
+3. PVCs that are between 600 GiB and 1 TiB will result in Trident creating a 1TiB CVS volume.
+4. PVCs that are greater than 1 TiB will result in Trident creating a CVS volume of the requested size.
+
 In addition to the global configuration values above, when using CVS on GCP, these options are available.
 
 +-----------------------+--------------------------------------------------------------------------+----------------------------------------------+

diff --git a/docs/kubernetes/operations/tasks/backends/cvs_gcp.rst b/docs/kubernetes/operations/tasks/backends/cvs_gcp.rst
@@ -19,6 +19,31 @@ To create and use a Cloud Volumes Service (CVS) for GCP backend, you will need:
 * GCP service account with the ``netappcloudvolumes.admin`` role
 * API key file for your CVS service account
 
+Trident now includes support for smaller volumes with the default CVS service type on
+GCP (https://cloud.google.com/architecture/partners/netapp-cloud-volumes/service-types).
+For backends created with ``storageClass=software``, volumes will now have a
+minimum provisioning size of 300 GiB. CVS currently provides this feature under
+Controlled Availability and does **not provide** technical support.
+Users must sign up for access to sub-1TiB
+volumes `here <https://docs.google.com/forms/d/e/1FAIpQLSc7_euiPtlV8bhsKWvwBl3gm9KUL4kOhD7lnbHC3LlQ7m02Dw/viewform>`_.
+NetApp recommends customers consume sub-1TiB volumes for **non-production** workloads.
+
+.. warning::
+
+ When deploying backends using the default CVS service type [``storageClass=software``],
+ users **must obtain access** to the sub-1TiB volumes feature on GCP for the Project Number(s)
+ and Project ID(s) in question. This is necessary for Trident to provision sub-1TiB volumes.
+ If not, volume creations **will fail** for PVCs that are <600 GiB. Obtain access to sub-1TiB
+ volumes using `this <https://docs.google.com/forms/d/e/1FAIpQLSc7_euiPtlV8bhsKWvwBl3gm9KUL4kOhD7lnbHC3LlQ7m02Dw/viewform>`_
+ form.
+
+Volumes created by Trident for the default CVS service level will be provisioned as follows:
+
+1. PVCs that are smaller than 300 GiB will result in Trident creating a 300 GiB CVS volume.
+2. PVCs that are between 300 GiB to 600 GiB will result in Trident creating a CVS volume of the requested size.
+3. PVCs that are between 600 GiB and 1 TiB will result in Trident creating a 1TiB CVS volume.
+4. PVCs that are greater than 1 TiB will result in Trident creating a CVS volume of the requested size.
+
 Backend configuration options
 -----------------------------
 
@@ -28,8 +53,8 @@ Parameter                 Description
 version                   Always 1
 storageDriverName         "gcp-cvs"
 backendName               Custom name for the storage backend                               Driver name + "_" + part of API key
-storageClass              Type of storage. Choose from ``hardware`` [Performance Optimized] "hardware"
-                          or ``software`` [Scale Optimized]
+storageClass              Type of storage. Choose from ``hardware`` [CVS-Performance        "hardware"
+                          service type] or ``software`` [CVS service type]
 projectNumber             GCP account project number
 hostProjectNumber         GCP shared VPC host project number
 apiRegion                 CVS account region

diff --git a/docs/support/requirements.rst b/docs/support/requirements.rst
@@ -7,20 +7,18 @@ Supported frontends (orchestrators)
 
 Trident supports multiple container engines and orchestrators, including:
 
-* Anthos GKE On-Prem v1.5
-* Mirantis Container Runtime (formerly Docker Engine - Enterprise) 2.1, 3.0, and 3.1
+* Mirantis Container Runtime (formerly Docker Engine - Enterprise) 2.1, 3.0, 3.1, and 3.2.11
 * Kubernetes 1.11 or later (latest: 1.21)
-* OpenShift 3.11, 4.2, 4.3, 4.4, 4.5, 4.6.8, and later
+* OpenShift 3.11, 4.2, 4.3, 4.4, 4.5, 4.6 [4.6.8+], 4.7 (latest 4.7)
 
 The Trident Operator is supported with these releases:
 
-* Anthos GKE On-Prem v1.5
 * Kubernetes 1.14 or later (latest: 1.21)
-* OpenShift 4.2, 4.3, 4.4, 4.5, 4.6.8, and later
+* OpenShift 4.2, 4.3, 4.4, 4.5, 4.6 [4.6.8+], 4.7 (latest 4.7)
 
 .. important::
 
-  Red Hat OpenShift Container Platform users might observe their ``initiatorname.iscsi`` file to be blank if using any version below 4.6.8. This is a bug that has been identified by RedHat to be fixed with OpenShift 4.6.8. See `this bug fix announcement <https://access.redhat.com/errata/RHSA-2020:5259/>`_. NetApp recommends that you use Trident 21.01 on OpenShift 4.6.8 and later.
+  Red Hat OpenShift Container Platform users might observe their ``initiatorname.iscsi`` file to be blank if using any version below 4.6.8. This is a bug that has been identified by RedHat to be fixed with OpenShift 4.6.8. See `this bug fix announcement <https://access.redhat.com/errata/RHSA-2020:5259/>`_. NetApp recommends that you use Trident on OpenShift 4.6.8 and later.
 
 Trident also works with a host of other fully managed and self-managed Kubernetes offerings, including Google Cloud’s Google Kubernetes Engine (GKE), AWS’s Elastic Kubernetes Services (EKS), Azure’s Azure Kubernetes Service (AKS), and Rancher.
 
@@ -103,7 +101,7 @@ configuration can use it. See the
 Container images and corresponding Kubernetes versions
 ======================================================
 
-For air-gapped installations, see the following table for what container images are needed to install 
+For air-gapped installations, see the following table for what container images are needed to install
 Trident:
 
 +------------------------+-------------------------------------------------------------+