From 6f522958e9267e1af7bbcafc4fc25ed22ece3079 Mon Sep 17 00:00:00 2001 From: Adil Date: Wed, 14 Apr 2021 08:13:04 -0300 Subject: [PATCH] NFS Backend new content in system configuration Created topic - Configure the NFS Backend on Cinder Backup Updated Sys Config Index Patch 2: Acted on comments from gerrit review Patch 3: Acted on comments Patch 4: Acted on comments Patch 5: fixed text for hhtp links Pending comment to be addressed by Ron/Greg Story:(pending) Task: (pending) gerrit link: https://review.opendev.org/c/starlingx/docs/+/786239 Signed-off-by: Adil Change-Id: Ic8a250435758798be406840f1126abff37bd7b9f --- .vscode/settings.json | 6 - doc/source/shared/abbrevs.txt | 1 + ...igure-the-nfs-backend-on-cinder-backup.rst | 115 ++++++++++++++++++ .../system_configuration/openstack/index.rst | 3 +- 4 files changed, 118 insertions(+), 7 deletions(-) create mode 100644 doc/source/system_configuration/openstack/configure-the-nfs-backend-on-cinder-backup.rst diff --git a/.vscode/settings.json b/.vscode/settings.json index 4c665beca..a48a5e9b3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,11 +1,5 @@ { -<<<<<<< HEAD "restructuredtext.languageServer.disabled": true, "restructuredtext.preview.sphinx.disabled": true, "restructuredtext.linter.disabled": true -======= - "restructuredtext.linter.disabled": true, - "restructuredtext.preview.sphinx.disabled": true, - "restructuredtext.languageServer.disabled": true ->>>>>>> 2298678... New content for Metrics Server tutorials (user and admin) } \ No newline at end of file diff --git a/doc/source/shared/abbrevs.txt b/doc/source/shared/abbrevs.txt index f4d6c51ab..05ebee3bb 100755 --- a/doc/source/shared/abbrevs.txt +++ b/doc/source/shared/abbrevs.txt @@ -62,6 +62,7 @@ .. |MOTD| replace:: :abbr:`MOTD (Message of the Day)` .. |MTU| replace:: :abbr:`MTU (Maximum Transmission Unit)` .. |NAT| replace:: :abbr:`NAT (Network Address Translation)` +.. |NFS| replace:: :abbr:`NFS (Network File System)` .. |NIC| replace:: :abbr:`NIC (Network Interface Card)` .. |NICs| replace:: :abbr:`NICs (Network Interface Cards)` .. |NTP| replace:: :abbr:`NTP (Network Time Protocol)` diff --git a/doc/source/system_configuration/openstack/configure-the-nfs-backend-on-cinder-backup.rst b/doc/source/system_configuration/openstack/configure-the-nfs-backend-on-cinder-backup.rst new file mode 100644 index 000000000..cccf1dbe3 --- /dev/null +++ b/doc/source/system_configuration/openstack/configure-the-nfs-backend-on-cinder-backup.rst @@ -0,0 +1,115 @@ +.. +.. _configure-the-nfs-backend-on-cinder-backup: + +========================================== +Configure the NFS Backend on Cinder-Backup +========================================== + +You can configure the cinder-backup service to use a remote external |NFS| server as backend. + +.. rubric:: |prereq| + +Ensure you have the following: + +* the openstack application already applied or uploaded to |prod-os| +* the remote |NFS| server is up and running +* the remote |NFS| server IP address or domain are known +* the remote |NFS| server can be reached from inside the OpenStack cluster where |prod-os| is running + +Follow these steps to perform the configuration. + +.. rubric:: |proc| + +#. Create a Helm user override configuration file for Cinder. + + The following is a sample configuration for |NFS| backend: + + .. code-block:: none + + conf: + cinder: + DEFAULT: + backup_driver: cinder.backup.drivers.nfs.NFSBackupDriver + backup_mount_point_base: /backup/ # NFS volume mount point + backup_share: 10.10.20.2:/exports/backup/ # NFS server IP address and exported directory + pod: + mounts: + cinder_backup: + cinder_backup: + volumeMounts: + - mountPath: /backup + name: nfs-backup + volumes: + - emptyDir: {} + name: nfs-backup + security_context: + cinder_backup: + container: + cinder_backup: + readOnlyRootFilesystem: false + runAsGroup: 65534 # nogroup GID (from NFS server) + runAsUser: 42424 # cinder UID + + For other options for configuring |NFS| backend on cinder-backup, see: + `NFS Backup Driver `__. + +#. The following commands are used for updating the Cinder Helm Chart overrides for |prod-os|: + + #. Update the Helm Chart overrides for Cinder: + + .. parsed-literal:: + + ~(keystone_admin)]$ system helm-override-update |prefix|-openstack cinder openstack --values=\ + + #. Shows the updated Helm Chart overrides for Cinder: + + .. parsed-literal:: + + ~(keystone_admin)$ system helm-override-show |prefix|-openstack cinder openstack + +#. The following commands are used to apply the updated Helm Chart overrides: + + #. Applies updated Helm Chart overrides: + + .. parsed-literal:: + + ~(keystone_admin)$ system application-apply |prefix|-openstack + + #. Wait for the application apply to complete: + + .. parsed-literal:: + + ~(keystone_admin)$ watch system application-show |prefix|-openstack + +#. Verify that the Cinder services are up and running: + + #. Set the |CLI| context to the |prod-os| Cloud Application and set up + OpenStack admin credentials: + + .. code-block:: none + + sed '/export OS_AUTH_URL/c\export OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3' /etc/platform/openrc > ~/openrc.os source ./openrc.os + + #. Shows the OpenStack volume service: + + .. code-block:: none + + ~(keystone_admin)]$ openstack volume service list + + For more information on how to access the OpenStack CLI, see documentation at: + `Access StarlingX Openstack `__. + +.. note:: + + During startup, if the group ID of the mount point is not the same as the + group ID of the exported directory of the |NFS| server, then cinder-backup + will try to update the ownership of the |NFS| share mount point directory. + If the cinder-backup operation is not successful, the deployment will fail + and cinder-backup will stay down. + + Run cinder-backup as a privileged user in order to change the ownership + of the |NFS| share mount point directory. + + + + diff --git a/doc/source/system_configuration/openstack/index.rst b/doc/source/system_configuration/openstack/index.rst index 109500932..d73b9db28 100644 --- a/doc/source/system_configuration/openstack/index.rst +++ b/doc/source/system_configuration/openstack/index.rst @@ -16,9 +16,10 @@ Configure OpenStack Services Using Helm Chart Overrides configuring-a-live-migration-completion-timeout-in-nova configuring-a-pci-alias-in-nova configuring-the-rpc-response-timeout-in-cinder + configure-the-nfs-backend-on-cinder-backup enabling-the-qos-extension-for-neutron enabling-the-trunk-extension-for-neutron using-helm-overrides-to-enable-internal-dns adding-configuration-rpc-response-max-timeout-in-neutron-conf assigning-a-dedicated-vlan-id-to-a-target-project-network - customize-openstack-horizon-and-login-banner-branding + customize-openstack-horizon-and-login-banner-branding \ No newline at end of file