Enable SnapshotViolation plugin for SnapshotPolicy template

[rahulguptajss]

The SnapshotViolation plugin is designed to generate metrics that help identify snapshots not created by a policy, displaying the count and total size of those snapshots. By default, this feature is disabled.

Note: Metrics generated via this plugin are refreshed every 30 minutes by default. These metrics are snapshot_volume_violation_count and snapshot_volume_violation_total_size.

To enable this feature in Harvest, follow the steps below:

Harvest Installation Type: Native/deb/rpm

Rest Collector

Step 1: Create custom.yaml

Let's assume Harvest is installed in /opt/harvest directory. Adjust paths as needed.

HARVEST_DIR="/opt/harvest"
cd "$HARVEST_DIR/conf/rest"

1. Create custom.yaml if not already exists:

vi custom.yaml

Update the file with the following content:

objects:
  SnapshotPolicy:              custom_snapshotpolicy.yaml

2. Create/Update custom_snapshotpolicy.yaml as below in folder $HARVEST_DIR/conf/rest/9.12.0.

cp "$HARVEST_DIR/conf/rest/9.12.0/snapshotpolicy.yaml" "$HARVEST_DIR/conf/rest/9.12.0/custom_snapshotpolicy.yaml"
sed -i 's/^#  - SnapshotViolation/  - SnapshotViolation/' "$HARVEST_DIR/conf/rest/9.12.0/custom_snapshotpolicy.yaml"

Step 2: Restart Harvest pollers

bin/harvest restart

Zapi Collector

Step 1: Create custom.yaml

Let's assume Harvest is installed in /opt/harvest directory. Adjust paths as needed.

Navigate to the zapi directory:

cd /opt/harvest/conf/zapi

1. Create custom.yaml if not already exists:

vi custom.yaml

Update the file with the following content:

objects:
  SnapshotPolicy:              custom_snapshotpolicy.yaml

2. Create a custom_snapshotpolicy.yaml file in the /opt/harvest/conf/zapi/cdot/9.8.0 directory. Update custom_snapshotpolicy.yaml as below.

plugins:
  - SnapshotViolation

Step 2: Restart Harvest pollers

bin/harvest restart

Harvest Installation Type: NABox4

⚠️ Note:
Prerequisite: ssh to NABox via admin
Create relevant directories if they don't exist. You need to run these commands in sudo bash

Rest Collector

Step 1: Create custom.yaml

Navigate to the rest directory:

cd /etc/nabox/harvest/user/rest

Create custom.yaml:

vi custom.yaml

Update the file with the following content:

objects:
  SnapshotPolicy:              custom_snapshotpolicy.yaml

2. Create a custom_snapshotpolicy.yaml file in the /etc/nabox/harvest/user/rest/9.12.0 directory as below.

mkdir -p /etc/nabox/harvest/user/rest/9.12.0
cp /data/packages/harvest/conf/rest/9.12.0/snapshotpolicy.yaml /etc/nabox/harvest/user/rest/9.12.0/custom_snapshotpolicy.yaml
sed -i 's/^#  - SnapshotViolation/  - SnapshotViolation/' /etc/nabox/harvest/user/rest/9.12.0/custom_snapshotpolicy.yaml

Step 2: Restart NABox containers

dc restart

Zapi Collector

Step 1: Create custom.yaml

Navigate to the zapi directory:

cd /etc/nabox/harvest/user/zapi

1. Create custom.yaml if not already exists:

vi custom.yaml

Update the file with the following content:

objects:
  SnapshotPolicy:              custom_snapshotpolicy.yaml

2. Create a custom_snapshotpolicy.yaml file in the /etc/nabox/harvest/user/zapi/cdot/9.8.0 directory. Update custom_snapshotpolicy.yaml as below.

plugins:
  - SnapshotViolation

Step 2: Restart Harvest pollers

dc restart

You can view the metrics generated by this plugin in ONTAP: Data Protection under the Snapshot Policy Violations row.