Search…
TVK One-Click Deploy and Configure (WIP)
One click and interactive deployment for TrilioVault for Kubernetes

Overview

tvk-oneclick is a kubectl plugin that installs, configures, and validates a TrilioVault. It installs a TVK operator, a TVK application/manager, configures TVK UI, and executes some sample backups and restore.

Pre-requisites:

    1.
    krew - kubectl-plugin manager.
    2.
    kubectl - kubernetes command-line tool.
    3.
    Perl
    4.
    Helm (version >= 3)
    5.
    yq
    6.
    S3cmd
Supported OS and Architectures:
OS:
    Linux
    darwin
Arch:
    amd64
    x86

Performs below tasks

    Preflight:
    It does preflight checks to ensure that all requirements are satisfied.
    Install TVK:
    Installs TVK operator and manager.
    Configure UI: It configures TVK UI for users. Users have the option to select the way in which the UI should be configured. Users can select one from ['Loadbalancer','Nodeport','PortForwarding']
    Create Target:
    In order to perform a sample test, the user would require to create a target. So this option allows user to create S3 or NFS based target.
    Sample Test: This plugin allows user to run sample tests. This includes ['Label_based','Namespace_based','Operator_based','Helm_based'] backup. By default, 'Label_based' backup tests on Mysql application, 'Namespace_based' tests on WordPress,'Operator_based' tests on Postgress operator,'Helm_based' tests using MongoDB application.

Ways in which the Plugin can be executed

    Interactive: The plugin asks for various inputs that require it to perform the mentioned operations as the plugin proceeds with execution.
    Non-interactive: In this plugin would expect the user to provide a path and the name of a config file at the start of the plugin. A sample config file can be found here

Installation, Upgrade, Removal of Plugins :

    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-oneclick/tvk-oneclick
    Copied!
    Upgrade:
    1
    kubectl krew upgrade tvk-oneclick
    Copied!
    Removal:
    1
    kubectl krew uninstall tvk-oneclick
    Copied!

Usage

tvk-oneclick - Installs, Configures UI, Create sample backup/restore test
Usage:
kubectl tvk-oneclick [options]
Parameter
Description
--noninteractive
run script in non-interactive mode.for this you need to provide config file
--install_tvk
Installs TVK and it's free trial license.
--configure_ui
Configures TVK UI.
--target
Create Target for backup and restore jobs
--sample_test
Create sample backup and restore jobs
--preflight
Checks if all the pre-requisites are satisfied

Examples

    With -n:
1
kubectl tvk-preflight -n
Copied!
    Without -n
1
kubectl tvk-preflight -i -c -t -s
Copied!
Last modified 14d ago