Create and Manage Volume Resource-Only Policies

Applicable to both Classic and Federated modes

A Volume Resource-Only Policy (VROP) enables you to back up Kubernetes volume resource specifications (PersistentVolumeClaim/PersistentVolume), which does not include the actual volume data. This exclusion-based approach is useful when volume data is protected externally or when you need to restore only the volume configuration to rebind to existing storage.

Understanding exclusion logic

VROP functions as an exclusion policy. When you configure a VROP, you are defining rules for volumes that should not be included during the data backup process.

For example, if you select a volume type in the policy (for example, NFS), Portworx Backup does not include data backup for the matching NFS volumes. It backs up only their metadata (PVC/PV specs). Any volume type not specified in the policy undergoes a full data backup.

Manage policies

Portworx Backup provides options to create, view, edit, share, and delete VRO policies from the Policies page.

Create a policy

You can create VRO policies directly from the Portworx Backup web console.

1. Log in to the Portworx Backup web console.

2. From the left navigation pane, select Policies.

3. Click the Volume Resources-Only Policies tab.

4. Click Create VRO Policy.

5. In the Create Volume Resource-Only Policy (VROP) window, configure the following fields:

   • VROP Name: Enter a descriptive name for the policy. Name cannot be changed later.
   • VROP Labels: (Optional) Add labels as key-value pairs.
   • Volume Types: Select the check boxes for the volume types you want to exclude from data backup. You can select one or more volume types:
     • NFS: Select this to skip data backup for NFS volumes. Provide the NFS Server Details (name or IP address) to identify specific servers to skip. If no server details are provided, all NFS volumes are excluded from data backup.
     • CSI: Select this to skip data backup for CSI-provisioned volumes. Provide the CSI Provisioner Name. If no provisioner name is provided, all CSI-provisioned volumes are excluded from data backup. This volume type option is for modern Portworx CSI volumes (driver: pxd.portworx.com).
     • Portworx Volumes: Select this to skip data backup for legacy in-tree Portworx volumes. This volume type option applies to the legacy in-tree driver (kubernetes.io/portworx-volume).

6. Click Create Policy.

Using REST API, Ansible, or Portworx CLI

For automation scenarios, you can create a VolumeResourceOnlyPolicy object using:

• REST API
• Ansible Integration for VROP
• Portworx CLI Reference

View policy JSON

To view the JSON definition of a policy:

1. Navigate to Policies > Volume Resource-Only Policies.
2. Locate the policy you want to view.
3. Click the vertical ellipsis (three dots) icon on the right side of the policy row.
4. Select View JSON.
5. Review the policy JSON in the dialog box and click OK.

Edit a policy

To modify an existing policy:

1. Navigate to Policies > Volume Resource-Only Policies.
2. Click the vertical ellipsis (three dots) icon for the target policy.
3. Select Edit.
4. In the Edit Volume Resource-Only Policy window, modify the VROP Labels, or Volume Types as required. Depending on the Volume Type selected, you may need to provide additional information.
   • NFS: Update existing NFS server details or add new NFS server details.
   • CSI: Update existing CSI provisioner name or add new CSI provisioner name.
   • Portworx Volumes: No configuration is required.
5. Click Update Policy to save your changes.

Share a policy

To share a policy with other users or groups:

1. Navigate to Policies > Volume Resource-Only Policies.
2. Click the vertical ellipsis (three dots) icon for the target policy.
3. Select Share.
4. In the Share VROPolicy window:
   • Groups: Search for and select user groups to share the policy with.
   • Users: Search for and select individual users.
   • Select the Do you want to share this policy to everyone? checkbox to share the policy with all users.
5. Click Share.

Remove a policy

note

You cannot delete a policy if it is currently associated with an active backup schedule. You must first update or remove the schedule.

1. Navigate to Policies > Volume Resource-Only Policies.
2. Click the vertical ellipsis (three dots) icon for the target policy.
3. Select Remove.
4. In the Remove VRO Policy confirmation modal:
   • Select the Confirm Deletion checkbox.
5. Click Delete.