#!/usr/bin/env bash
#
# JbTecWiz Support Centre -- generated fix script
#
# Fault : A PersistentVolumeClaim stays Pending and the pod never starts
# Fix   : Fix the storage class or the access mode
# Source: https://jbtecwiz.com/support/lnx-ctr-pvc-pending
#
# Run as     : Root shell
# Expect     : 30 minutes
# Risk       : medium
# Reversible : yes
#
# WHEN THIS IS THE RIGHT FIX
#   No class, or provisioning fails.
#
# HOW TO UNDO IT
#   Remove the default-class annotation if it was added in error.
#
# Walks the fix one step at a time and asks before each. Steps with no
# command are yours to do -- it prints those and waits. DRYRUN=1 prints
# without executing; UNATTENDED=1 does not ask.
#
# --------------------------------------------------------------------
# NO WARRANTY - USE AT YOUR OWN RISK
#
# This script is provided by JbTecWiz as-is and with no warranty of any
# kind, express or implied. You run it entirely at your own risk.
#
# JbTecWiz accepts no liability for any loss or damage arising from its
# use, including but not limited to data loss, downtime, or configuration
# changes that turn out to be wrong for your system.
#
# You are responsible for reading this script before running it, for
# satisfying yourself that it suits the machine in front of you, and for
# having a working backup first. Some steps cannot be undone.
# --------------------------------------------------------------------

set -uo pipefail
DRYRUN="${DRYRUN:-0}"
UNATTENDED="${UNATTENDED:-0}"
failed=0

if [ "$(id -u)" -ne 0 ]; then
  echo "  This fix is documented as needing root. Re-run with sudo." >&2
  exit 3
fi

rule() { printf "\n%s\n" "$(printf '-%.0s' $(seq 1 70))"; if [ $# -gt 0 ]; then echo "$1"; fi; }
prose() { echo "$1" | fold -s -w 74 | sed "s/^/  /"; }

# Returns 0 when the caller should run the command, 1 when it should not.
# A manual step always returns 1 -- there is nothing for the caller to run.
step() {  # step <n> <do> <why> <manual|cmd> [command lines...]
  local n="$1" dotext="$2" why="$3" mode="$4"; shift 4
  rule "  Step $n of 5"
  prose "$dotext"
  if [ -n "$why" ]; then echo; prose "$why"; fi
  if [ "$mode" = "manual" ]; then
    echo; echo "  -> Do this yourself, then press Enter to carry on."
    if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then read -r _; fi
    return 1
  fi
  echo; printf "    %s\n" "$@"; echo
  if [ "$DRYRUN" = "1" ]; then echo "  (dry run -- not executed)"; return 1; fi
  if [ "$UNATTENDED" = "0" ]; then
    read -r -p "  Run this step? [Y]es / [S]kip / [Q]uit " a
    case "$a" in
      [Qq]*) echo "  Stopped at your request."; exit 0 ;;
      [Ss]*) echo "  Skipped."; return 1 ;;
    esac
  fi
  return 0
}

rule
echo "  A PersistentVolumeClaim stays Pending and the pod never starts"
echo "  Fix the storage class or the access mode"
echo
echo "  Risk: medium   Reversible   30 minutes"
echo
prose 'No warranty. Use at your own risk - JbTecWiz accepts no liability. Read it before you run it, and have a backup.'
rule
echo
if [ "$UNATTENDED" = "0" ] && [ "$DRYRUN" = "0" ]; then
  read -r -p "  Ready? [y/N] " go
  case "$go" in [Yy]*) ;; *) echo "  Nothing was changed."; exit 0;; esac
fi

if step 1 'Check whether a default storage class exists. A claim with no class specified and no default will wait forever.' '' cmd 'kubectl get storageclass' 'kubectl get sc -o jsonpath='\''{range .items[*]}{.metadata.name}{"\t"}{.metadata.annotations.storageclass\.kubernetes\.io/is-default-class}{"\n"}{end}'\'''; then
  kubectl get storageclass
  kubectl get sc -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.metadata.annotations.storageclass\.kubernetes\.io/is-default-class}{"\n"}{end}'
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 1 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 2 'Mark one as default if none is.' '' cmd 'kubectl patch storageclass standard -p '\''{"metadata":{"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'\'''; then
  kubectl patch storageclass standard -p '{"metadata":{"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 2 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 3 'Check the access mode is one the backend supports. Most block storage supports ReadWriteOnce only -- asking for ReadWriteMany fails silently at provisioning.' 'ReadWriteMany requires a shared filesystem such as NFS or CephFS. Requesting it from a cloud block-storage provisioner produces a claim that never binds with an error that does not mention access modes at all.' cmd 'kubectl get pvc myclaim -o jsonpath='\''{.spec.accessModes}'\'''; then
  kubectl get pvc myclaim -o jsonpath='{.spec.accessModes}'
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 3 failed. The rest of the fix may depend on it." >&2
  fi
fi

if step 4 'Read the provisioner'\''s own events, which carry the underlying storage error.' '' cmd 'kubectl describe pvc myclaim | sed -n '\''/Events:/,$p'\''' 'kubectl -n kube-system logs -l app=csi-provisioner --tail=50'; then
  kubectl describe pvc myclaim | sed -n '/Events:/,$p'
  kubectl -n kube-system logs -l app=csi-provisioner --tail=50
  if [ $? -ne 0 ]; then
    failed=$((failed+1))
    echo "  Step 4 failed. The rest of the fix may depend on it." >&2
  fi
fi

step 5 'Check quota at the storage backend -- a cloud account at its volume limit fails here.' '' manual || true

rule "  Confirm it worked"
prose 'The claim binds and the pod starts with the volume mounted.'
if [ "$DRYRUN" = "0" ]; then
  kubectl get pvc,pv; kubectl describe pod mypod | grep -A5 Mounts
fi

rule
if [ "$failed" -gt 0 ]; then
  echo "  Finished with $failed failed step(s)."
  echo "  Read the full write-up at https://jbtecwiz.com/support/lnx-ctr-pvc-pending"
else
  echo "  Finished."
fi
echo
prose 'To undo: Remove the default-class annotation if it was added in error.'
rule