diff --git a/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst b/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst index fb1ac55b7..1365ed429 100644 --- a/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst +++ b/doc/source/storage/kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend.rst @@ -3,11 +3,11 @@ .. _configure-an-external-netapp-deployment-as-the-storage-backend: ============================================================== -Configure an External Netapp Deployment as the Storage Backend +Configure an External NetApp Deployment as the Storage Backend ============================================================== -Configure an external Netapp Trident deployment as the storage backend, after -system installation using a |prod|-provided ansible playbook. +Configure an external NetApp deployment as the storage backend, after system +installation using a |prod|-provided ansible playbook. .. rubric:: |prereq| @@ -84,11 +84,11 @@ procedure. .. _configuring-an-external-netapp-deployment-as-the-storage-backend-mod-localhost: -#. Configure Netapps configurable parameters and run the provided +#. Configure NetApps configurable parameters and run the provided install_netapp_backend.yml ansible playbook to enable connectivity to - Netapp as a storage backend for |prod|. + NetApp as a storage backend for |prod|. -#. Provide Netapp backend configurable parameters in an overrides yaml +#. Provide NetApp backend configurable parameters in an overrides yaml file. You can make changes-in-place to your existing localhost.yml file @@ -207,15 +207,15 @@ procedure. `__. .. note:: - By default, Netapp is configured to have ``777`` as + By default, NetApp is configured to have ``777`` as unixPermissions. |prod| recommends changing these settings to make it more secure, for example, ``"unixPermissions": "755"``. Ensure that the right permissions are used, and there is no conflict with container security. Do NOT use ``777`` as ``unixPermissions`` to configure an external - Netapp deployment as the Storage backend. For more information, - contact Netapp, at `https://www.netapp.com/ + NetApp deployment as the Storage backend. For more information, + contact NetApp, at `https://www.netapp.com/ `__. #. Run the playbook. @@ -225,7 +225,7 @@ procedure. .. code-block:: none - # ansible-playbook /usr/share/ansible/stx-ansible/playbooks/install_netapp_backend.yml -e "override_files_dir=" + ansible-playbook /usr/share/ansible/stx-ansible/playbooks/install_netapp_backend.yml -e "override_files_dir=" Upon successful launch, there will be one Trident pod running on each node, plus an extra pod for the REST API running on one of the @@ -245,7 +245,7 @@ procedure. .. rubric:: |postreq| -To configure a persistent volume claim for the Netapp backend, add the +To configure a persistent volume claim for the NetApp backend, add the appropriate storage-class name you set up in step :ref:`2 ` \(``netapp-nas-backend`` in this example\) to the persistent volume @@ -256,7 +256,7 @@ claim's yaml configuration file. For more information about this file, see .. _configure-netapps-using-a-private-docker-registry: ------------------------------------------------- -Configure Netapps Using a Private Docker Registry +Configure NetApps Using a Private Docker Registry ------------------------------------------------- Use the ``docker_registries`` parameter to pull from the local registry rather diff --git a/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst b/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst index 0298480a1..b5a6dfffb 100644 --- a/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst +++ b/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst @@ -72,6 +72,7 @@ Storage Backends configure-the-internal-ceph-storage-backend configure-an-external-netapp-deployment-as-the-storage-backend uninstall-the-netapp-backend + upgrade-the-netapp-trident-software-c5ec64d213d3 ---------------- Controller Hosts diff --git a/doc/source/storage/kubernetes/storage-backends.rst b/doc/source/storage/kubernetes/storage-backends.rst index 91ce8e004..e8aeea7af 100644 --- a/doc/source/storage/kubernetes/storage-backends.rst +++ b/doc/source/storage/kubernetes/storage-backends.rst @@ -7,7 +7,7 @@ Storage Backends ================ |prod-long| supports an internal Ceph block storage backend and connecting -to an external Netapp Trident block storage backend. Configuring a storage +to an external NetApp block storage backend. Configuring a storage backend is optional, but it is required if the applications being hosted require persistent volume claims \(PVCs\). @@ -82,13 +82,13 @@ For more information on Ceph storage backend provisioning, see .. _storage-backends-section-N10151-N10028-N10001: ----------------------- -External Netapp Trident +External NetApp Storage ----------------------- -|prod| can be configured to connect to and use an external Netapp Trident +|prod| can be configured to connect to and use an external NetApp storage deployment as its storage backend. -Netapp Trident supports: +NetApp Trident supports: .. _storage-backends-d201e23: @@ -116,7 +116,7 @@ For more information about Trident, see - :ref:`Configure the Internal Ceph Storage Backend ` - - :ref:`Configure an External Netapp Deployment as the Storage Backend + - :ref:`Configure an External NetApp Deployment as the Storage Backend ` - - :ref:`Uninstall the Netapp Backend ` + - :ref:`Uninstall the NetApp Trident Software ` diff --git a/doc/source/storage/kubernetes/storage-configuration-storage-resources.rst b/doc/source/storage/kubernetes/storage-configuration-storage-resources.rst index ef50ac42d..71349466e 100644 --- a/doc/source/storage/kubernetes/storage-configuration-storage-resources.rst +++ b/doc/source/storage/kubernetes/storage-configuration-storage-resources.rst @@ -106,13 +106,13 @@ Storage systems. .. _storage-configuration-storage-resources-section-N1015E-N10031-N1000F-N10001: ----------------------- -External Netapp Trident +External NetApp Storage ----------------------- -|prod| can be configured to connect to and use an external Netapp Trident +|prod| can be configured to connect to and use an external NetApp storage deployment as its storage backend. -Netapp Trident supports: +NetApp Trident supports: .. _storage-configuration-storage-resources-d201e23: diff --git a/doc/source/storage/kubernetes/uninstall-the-netapp-backend.rst b/doc/source/storage/kubernetes/uninstall-the-netapp-backend.rst index 4b137712b..89b2db795 100644 --- a/doc/source/storage/kubernetes/uninstall-the-netapp-backend.rst +++ b/doc/source/storage/kubernetes/uninstall-the-netapp-backend.rst @@ -2,17 +2,18 @@ .. vba1584558499981 .. _uninstall-the-netapp-backend: -============================ -Uninstall the Netapp Backend -============================ +===================================== +Uninstall the NetApp Trident Software +===================================== -Uninstalling the Netapp backend is done using the :command:`tridentctl` command. +Uninstalling the NetApp Trident Software is done using the +:command:`tridentctl` command. Run the following command. .. code-block:: none - # tridentctl -n uninstall + tridentctl -n uninstall Pods and resources created during installation are deleted. diff --git a/doc/source/storage/kubernetes/upgrade-the-netapp-trident-software-c5ec64d213d3.rst b/doc/source/storage/kubernetes/upgrade-the-netapp-trident-software-c5ec64d213d3.rst new file mode 100644 index 000000000..f033a04c1 --- /dev/null +++ b/doc/source/storage/kubernetes/upgrade-the-netapp-trident-software-c5ec64d213d3.rst @@ -0,0 +1,52 @@ +.. _upgrade-the-netapp-trident-software-c5ec64d213d3: + +=================================== +Upgrade the NetApp Trident Software +=================================== + +.. rubric:: |context| + +|prod| |prod-ver| contains the installer for Trident 21.04, but installations +that have been upgraded from the previous |prod| version and were configured +to use a NetApp backend will still be running Trident 20.04 after the upgrade +to |prod| |prod-ver|. + +.. code-block:: none + + [sysadmin@controller-0 trident(keystone_admin)]$ tridentctl -n trident version + +----------------+----------------+ + | SERVER VERSION | CLIENT VERSION | + +----------------+----------------+ + | 20.04.0 | 21.04.1 | + +----------------+----------------+ + +.. rubric:: |proc| + +Before upgrading Kubernetes to version 1.19, the running version of Trident +must be updated to 21.04. This will not disrupt any containers that are already +running, but will cause a brief outage to the NetApp Trident control plane. + +The steps are as follows: + +#. Locate the ``localhost.yaml`` file that was used originally to install + Trident, as described in :ref:`Configure an External NetApp Deployment as + the Storage Backend + `. + +#. Add the line ``trident_force_reinstall: true`` to the file. + +#. Run the ``install_netapp_backend.yml`` playbook again as per Run Playbook + step of section :ref:`Configure an External NetApp Deployment as the + Storage Backend + `. + +#. On completion, verify that the Trident server version has been updated: + + .. code-block:: none + + [sysadmin@controller-0 trident(keystone_admin)]$ tridentctl -n trident version + +----------------+----------------+ + | SERVER VERSION | CLIENT VERSION | + +----------------+----------------+ + | 21.04.1 | 21.04.1 | + +----------------+----------------+ diff --git a/doc/source/updates/kubernetes/about-kubernetes-orchestrated-upgrades.rst b/doc/source/updates/kubernetes/about-kubernetes-orchestrated-upgrades.rst index 857c4539a..5d420d7d5 100644 --- a/doc/source/updates/kubernetes/about-kubernetes-orchestrated-upgrades.rst +++ b/doc/source/updates/kubernetes/about-kubernetes-orchestrated-upgrades.rst @@ -46,6 +46,13 @@ meets the following conditions: openstack-compute \(worker\) capacity to move instances off the openstack-compute \(worker\) host\(s\) being upgraded. +- If you are using NetApp Trident in |prod| |prod-ver| and have upgraded from + the |prod| previous version, ensure that your NetApp backend version is + compatible with Trident 21.04 and follow the steps in :ref:`Upgrade the + NetApp Trident Software ` + to upgrade the Trident drivers to 21.04 before upgrading Kubernetes to + version 1.19. + .. note:: Administrative controller ``swact`` operations should be avoided during Kubernetes version upgrade orchestration. diff --git a/doc/source/updates/kubernetes/manual-kubernetes-components-upgrade.rst b/doc/source/updates/kubernetes/manual-kubernetes-components-upgrade.rst index 2555d82a0..1addba3de 100644 --- a/doc/source/updates/kubernetes/manual-kubernetes-components-upgrade.rst +++ b/doc/source/updates/kubernetes/manual-kubernetes-components-upgrade.rst @@ -43,9 +43,12 @@ and upgrade various systems. - All updates required for the new Kubernetes version must be transferred to the active controller. -- If you are using NetApp Trident, ensure that your NetApp version is - compatible with Trident 21.04 before upgrading Kubernetes to version 1.19 - and after updating |prod| to version |prod-ver|. +- If you are using NetApp Trident in |prod| |prod-ver| and have upgraded from + the |prod| previous version, ensure that your NetApp backend version is + compatible with Trident 21.04 and follow the steps in :ref:`Upgrade the + NetApp Trident Software ` + to upgrade the Trident drivers to 21.04 before upgrading Kubernetes to + version 1.19. .. note:: The default version on a fresh install will be Kubernetes 1.21.3, while