PV recycler script

README.md

This script iterates through all released PVs, and does the following:

• add an annotation with today's timestamp if missing
• check if a present annotation indicates a date older than $KEEPDAYS days, and deletes the PV if yes

It's triggered by an ansile-managed cronjob on a bastion host.

cronjob-pv-garbagecollector.yml

---
- name: copy pv-garbagecollection script
  template:
    src: pv-garbagecollector.sh
    dest: /usr/local/sbin/pv-garbagecollector.sh
    mode: 0700

- name: set up cronjob for pv-garbagecollection script
  cron:
    name: Cronjob for the PersistentVolume (PV) Garbagecollector/recycler
    user: root
    cron_file: openshift_pv-garbagecollector
    job: /usr/local/sbin/pv-garbagecollector.sh
    hour: 12
    weekday: 1-5    # mon-fri in order not to create any alerts for storage team when PVs are deleted on weekends

pv-garbagecollector.sh.template

{% raw %}
#!/bin/sh

# This script iterates through all released PVs, and does the following:
#   - add an annotation with today's timestamp if missing
#   - check if a present annotation indicates a date older than $KEEPDAYS days, and deletes the PV if yes

{% endraw %}KEEPDAYS="{{ pv_garbagecollection_keepdays }}"
{% raw %}DAYTODAY="$(date +%Y-%m-%d)"

# get all unbound PVs and add annotation with datestamp(today) if it's not already set
for pv in $(oc get pv -ojsonpath='{range .items[?(@.status.phase=="Released")]}{.metadata.name}{"\n"}')
do
    # do dry-run first in order not to get an error because the annotation already exists
    oc annotate --overwrite=false pv $pv "{% endraw %}{{ clusterid }}.{{ COMPANYTLD }}{% raw %}/pv-release-date"="${DAYTODAY}" --dry-run 2>/dev/null && oc annotate --overwrite=false pv $pv "{% endraw %}{{ clusterid }}.{{ COMPANYTLD }}{% raw %}/pv-release-date"="${DAYTODAY}"

    OLDDATESTAMP="$(oc get pv $pv -o go-template='{{ range $key, $value := .metadata.annotations}}{{if eq $key {% endraw %}"{{ clusterid }}.{{ COMPANYTLD }}{% raw %}/pv-release-date"}}{{$value}}{{"\n"}}{{end}}{{end}}')"
    if [ "$(date -d "${OLDDATESTAMP}" +%s)" -lt "$(date -d "${KEEPDAYS} days ago" +%s)" ]
    then
        oc patch pv $pv -p '{"spec":{"persistentVolumeReclaimPolicy": "Delete"}}'
        oc delete pv $pv
    fi
done
{% endraw %}