TVK-Cleanup Plugin

TVK Cleanup Plugin
tvk-cleanup is a kubectl plugin that uninstalls the Triliovault Operator, Application, Custom Resources, and CRDs in a Kubernetes cluster.
Pre-requisites:
1.krew - kubectl-plugin manager. Install from here.
2.kubectl - kubernetes command-line tool. Install from here.
For openshift environments, if kubectl is not installed and oc binary is installed on host machine, then oc binary can be used to perform kubectl operation by creating symlink with -
1
sudo ln -s /usr/local/bin/oc /usr/local/bin/kubectl
Copied!
oc binary path can found by executing which oc
To delete/remove symbolic links use either unlink or rm command:
1
unlink /usr/local/bin/kubectl
Copied!
Supported OS:
Linux
darwin
TVK Cleanup
This plugin cleans up all TVK Custom Resources, CRDs, and TVK application itself from all the namespace. It cleans up TVK installed as operator (on OCP platform) and as helm chart on upstream k8s (Rancher) cluster.
Please note the following:
Ensure kubectl utility is present on system
Ensure kubectl is pointed to k8s cluster (i.e can access the remote target cluster)
Ensure helm utility is present on system and pointed to the cluster
helmVersion=~v3 is needed on the cluster
Ensure minimum Kubernetes version >= 1.18.x
Cleans up all the Triliovault Custom Resources, Triliovault Manager application and CRDs from all the namespaces
User can select to delete any or all of
1.Triliovault Application (Operator or Helm chart)
2.Triliovault CRDs
3.Triliovault Customer Resources as listed here - Restore Backup Backupplan Hook Target Policy License
Installation, Upgrade, Removal of Plugins 
With krew:
Add TVK custom plugin index of krew:
1
kubectl krew index add tvk-plugins https://github.com/trilioData/tvk-plugins.git
Copied!
Installation:
1
kubectl krew install tvk-plugins/tvk-cleanup
Copied!
Upgrade:
1
kubectl krew upgrade tvk-cleanup
Copied!
Removal:
1
kubectl krew uninstall tvk-cleanup
Copied!
Without krew:
1.List of available releases: https://github.com/trilioData/tvk-plugins/releases​
2.Choose a version of preflight plugin to install and check if release assets have preflight plugin's package[cleanup.tar.gz]
3.Set env variable version=v1.x.x [update with your desired version]. If version is not exported, latest tagged version will be considered.
Linux/macOS
Bash or ZSH shells:
1
(
2
  set -ex; cd "$(mktemp -d)" &&
3
  if [[ -z ${version} ]]; then version=$(curl -s https://api.github.com/repos/trilioData/tvk-plugins/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")'); fi &&
4
  echo "Installing version=${version}" &&
5
  curl -fsSLO "https://github.com/trilioData/tvk-plugins/releases/download/"${version}"/cleanup.tar.gz" &&
6
  tar zxvf cleanup.tar.gz && sudo mv cleanup/cleanup /usr/local/bin/kubectl-tvk_cleanup
7
)
Copied!
Verify installation with kubectl tvk-cleanup --help
Windows
NOT SUPPORTED

Usage:
1
kubectl tvk-cleanup [options] [arguments]
2
Options:
3
        -h, --help                show brief help
4
        -n, --noninteractive      run script in non-interactive mode
5
        -c, --crd                 delete Triliovault CRDs
6
        -t, --tvm                 delete Triliovault Manager or Operator
7
        -r, --resources \"resource1 resource2..\"
8
                                  specify list of Triliovault CRs to delete
9
                                  If not provided, all Triliovault CRs (listed below) will be deleted
10
                                  e.g. Restore Backup Backupplan ClusterRestore ClusterBackup
11
                                       ClusterBackupPlan Hook Target Policy License
Copied!
Examples
Interactive, Cleans up all:
1
kubectl tvk-cleanup -t -c -r
Copied!
Non-interactive, Cleans up all:
1
kubectl tvk-cleanup -n -t -c -r
Copied!
Non-interactive, Cleans up only Triliovault Manager or Operator:
1
kubectl tvk-cleanup -n -t
Copied!
Non-interactive, Cleans up only Triliovault CRDs
1
kubectl tvk-cleanup -n -c
Copied!
Non-interactive, Cleans up only specified Triliovault CRs
1
kubectl tvk-cleanup -n -r "Restore Backup Backupplan"
Copied!

Manual Uninstall

Next - Management Console UI

About the UI

Last modified 16d ago

Copy link

Contents

Installation, Upgrade, Removal of Plugins