Configure the NFS Backend on Cinder-BackupΒΆ

You can configure the cinder-backup service to use a remote external NFS server as backend.


Ensure you have the following:

  • the openstack application already applied or uploaded to StarlingX OpenStack

  • 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 StarlingX OpenStack is running

Follow these steps to perform the configuration.


  1. Create a Helm user override configuration file for Cinder.

    The following is a sample configuration for NFS backend:

          backup_driver: cinder.backup.drivers.nfs.NFSBackupDriver
          backup_mount_point_base: /backup/             # NFS volume mount point
          backup_share:     # NFS server IP address and exported directory
            - mountPath: /backup
              name: nfs-backup
            - emptyDir: {}
              name: nfs-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.

  2. The following commands are used for updating the Cinder Helm Chart overrides for StarlingX OpenStack:

    1. Update the Helm Chart overrides for Cinder:

      ~(keystone_admin)]$ system helm-override-update stx-openstack cinder openstack --values=<path/to/override/file>
    2. Show the updated Helm Chart overrides for Cinder:

      ~(keystone_admin)$ system helm-override-show stx-openstack cinder openstack
  3. The following commands are used to apply the updated Helm Chart overrides:

    1. Apply updated Helm Chart overrides:

      ~(keystone_admin)$ system application-apply stx-openstack
    2. Wait for the application apply to complete:

      ~(keystone_admin)$ watch system application-show stx-openstack
  4. Verify that the Cinder services are up and running:

    1. Set the CLI context to the StarlingX OpenStack Cloud Application and set up OpenStack admin credentials:

      ~(keystone_admin)]$ sed '/export OS_AUTH_URL/c\export OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3' /etc/platform/openrc > ~/openrc.os
      ~(keystone_admin)]$ source ./openrc.os
    2. Show the OpenStack volume service:

      ~(keystone_admin)]$ openstack volume service list

    For more information on how to access the OpenStack CLI, see documentation at: Access StarlingX Openstack.


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.