Skip to content

Latest commit

 

History

History
205 lines (168 loc) · 11.1 KB

README.md

File metadata and controls

205 lines (168 loc) · 11.1 KB
Raw

TVK Oneclick Plugin

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

Pre-requisites:

  1. krew - kubectl-plugin manager. Install from here
  2. kubectl - kubernetes command-line tool. Install from here
  3. Helm (version >= 3)
  4. Python3(version >= 3.9, with requests package installed - pip3 install requests)
  5. S3cmd. Install s3cmd from here
  6. yq(version >= 4). Information can be found @here

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: It installs TVK operator and manager.
  • Configure UI: It configures TVK UI for user.User has option to select the way in which UI should be configured.User can select one from ['Loadbalancer','Nodeport','PortForwarding']
  • Create Traget: In order to perform sample test, user would require to create target. So this option allows user to create S3 or NFS based target.
  • Sample Test: Plugin allow user to run some sample test. 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 plugin can be executed

'input_config'/input parameter details

  • PREFLIGHT: This parameter is to check whether or not preflight should be executed.It accepts one of the value from [True, False] More info around this can be found @here
  • proceed_even_PREFLIGHT_fail: This option is dependent of PREFLIGHT execution.If a user wish to proceed even if few checks failed in preflight execution, user need to set this variable to y/Y. This variable accepts one of the value from [Y,y,n,N].
  • TVK_INSTALL: This parameter is to check whether or not TVK should be installed.It accepts one of the value from [True, False]
  • CONFIGURE_UI: This parameter is to check whether or not TVK UI should be configured.It accepts one of the value from [True, False]
  • TARGET: This parameter is to check whether or not TVK Target should be created.It accepts one of the value from [True, False]
  • SAMPLE_TEST: This parameter is to check whether or not sample test should be executed.It accepts one of the value from [True, False]
  • storage_class: This parameter expects storage_class name which should be used across plugin execution. If kept empty, the storage_class annoted with 'default' label would be considered. If there is no such class, the plugin would likely fail.
  • operator_version: This parameter expects user to specify the TVK operator version to install as a part of tvk installation process. The compatibility/bersion can be found @here. If this parameter is empty, by default TrilioVault operator version 2.1.0 will get installed.
  • triliovault_manager_version: This parameter expects user to specify the TVK manager version to install as a part of tvk installation process. The compatibility/bersion can be found @here. If this parameter is empty, by default TrilioVault operator version 2.1.0 will get installed.
  • tvk_ns: This parameter expects user to specify the namespace in which user wish tvk to get installed in.
  • if_resource_exists_still_proceed: This parameter is to check whether plugin should proceed for other operationseven if resources exists.It accepts one of the value from [Y,y,n,N]
  • ui_access_type: Specify the way in which TVK UI should be configured. It accepts one of the value from ['Loadbalancer','Nodeport','PortForwarding']
  • domain: The value of this parameter is required when 'ui_access_type == Loadbalancer'.Specify the domain name which has been registered with a registrar and under which you wish to create record in. More info around this parameter can be found @here
  • tvkhost_name: The value of this parameter is required when 'ui_access_type == Loadbalancer OR ui_access_type == Nodeport'. The value of this parameter will be the hostname by which the TVK management console will be accessible through a web browser.
  • cluster_name: The value of this parameter is required when 'ui_access_type == Loadbalancer OR ui_access_type == Nodeport'. If kept blank, the active cluster name will be taken.
  • vendor_type: The value of this parameter is required to create target. Specify the vendor name under which target needs to be created. Currently supported value is one for the ['Digital_Ocean','Amazon_AWS']
  • doctl_token: The value of this parameter is required to create target. Specify the token name to authorize user.A token that allows it to query and manage DO account details and resources for user.
  • target_type: Target is a location where TrilioVault stores backup.Specify type of target to create.It accepts one of the value from ['NFS','S3']. More information can be found @here
  • access_key: This parameter is required when 'target_type == S3'.This is used for bucket S3 access/creation. The value should be consistent with the vendor_type yo select.
  • secret_key: This parameter is required when 'target_type == S3'.This is used for bucket S3 access/creation. The value should be consistent with the vendor_type yo select.
  • host_base: This parameter is required when 'target_type == S3'.specify the s3 endpoint for the region your Spaces/Buckets are in. More information can be found @here
  • host_bucket: The value of this parameter should be URL template to access s3 bucket/spaces.This parameter is required when 'target_type == S3'. Generally it's value is '%(bucket)s.' . This is the URL to access the bucket/space.
  • gpg_passphrase This parameter is for an optional encryption password. Unlike HTTPS, which protects files only while in transit, GPG encryption prevents others from reading files both in transit and while they are stored. More information can be found @here
  • bucket_location: Specify the location where the s3 bucket for target should be created. This parameter is specific to AWS vendor_type.The value can be one from ['us-east-1', 'us-west-1', 'us-west-2', 'eu-west-1', 'eu-central-1', 'ap-northeast-1', 'ap-southeast-1', 'ap-southeast-2', 'sa-east-1'].
  • bucket_name: Specify the name for the bucket to be created or looked for target creation.
  • target_name: Specify the name for the target that needs to be created.
  • target_namespace: Specify the namespace name in which target should be created in. User should have permission to create/modify/access the namespace.
  • nfs_serve: The server Ip address or the fully qualified nfs server name. This paramere is required when 'target_type == NFS'
  • nfs_path: Specify the exported path which can be mounted for target creation. This paramere is required when 'target_type == NFS'
  • nfs_options: Specify if any other NFS option needs to be set. Additional values for the nfsOptions field can be found @here
  • thresholdCapacity: Capacity at which the IO operations are performed on the target.Units supported - [Mi,Gi,Ti]
  • bk_plan_name: Specify the name for backup plan creation for the sample application. Default value is 'trilio-test-backup'.
  • bk_plan_namespace: Specify the namespace in which the application should get installed and the backup plan will get created. Default value is 'trilio-test-backup'.
  • backup_name: Specify the name for backup to be created for the sample application. Default value is 'trilio-test-backup'.
  • backup_namespace: Specify the namespace in which backup should get created. Default value is 'trilio-test-backup'.
  • backup_way: Specify the way in which backup should be taken.Supported values ['Label_based','Namespace_based','Operator_based','Helm_based']. For Label_based, MySQL application would be installed and sample backup/restore will be showcased. For Namespace_based, Wordpress application would be installed and sample backup/restore will be showcased. For Operator_based, MySQL operator would be installed and sample backup/restore will be showcased. For Helm_based, Mongodb application would be installed and sample backup/restore will be showcased.
  • restore: SPecify whether or not restore should be executed. Allowed values are one from the [True, False] list.
  • restore_name: Specify the name for the restore. Default value is 'tvk-restore'.
  • restore_namespace: Specify the namespace in which backup should be restored. Default value is 'tvk-restore'.

Installation, Upgrade, Removal of Plugins :

  • Add TVK custom plugin index of krew:

    kubectl krew index add tvk-plugins https://github.com/trilioData/tvk-plugins.git

  • Installation:

    kubectl krew install tvk-oneclick/tvk-oneclick

  • Upgrade:

    kubectl krew upgrade tvk-oneclick

  • Removal:

     kubectl krew uninstall tvk-oneclick

Usage

tvk-oneclick - Installs, Configures UI, Create sample backup/restore test

Usage:

kubectl tvk-oneclick [options]

Parameter Default 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:
kubectl tvk-oneclick -n
  • Without -n:
kubectl tvk-oneclick -i -c -t -s