VES Quickstart Tool

Overview

Use the Volterra quickstart tool script to install Volterra Node using terraform on public cloud infrastructure.


Installation

docker run --rm -v $(pwd):/opt/bin:rw docker.io/volterraio/volt-terraform:latest cp /deploy-terraform.sh /opt/bin

Usage

Syntax:

 ./deploy-terraform.sh <subcommand> [options]

Note: Use the script or the subcommand with the -h or --help option for more information. For example, use $ ./deploy-terraform.sh -h to obtain information on available subcommands.

Subcommands

The following table shows the list of subcommands:

Subcommand Description
apply Creates a node or modifies an existing node.
destroy Deletes a node.
list-templates Displays all available terraform templates.
exec Executes other commands such as az, aws, etc.
output Displays the output of terraform output command.

To know more options of each subcommand, invoke the help by executing the following command.

./deploy-terraform.sh <subcommand> -h|--help

Options for Subcommands

Option Expansion Description
-p --provider Specifies name of cloud provider such as AWS or Azure.
-tn --template-name Specifies name of terraform template.
-i --input-file Specifies input variables file for terraform.
-as --aws-secret-access-key Specifies AWS secret access key.
-ak --aws-acess-key-id Specifies AWS access key.
-r --region aws Specifies AWS region.
-n --volterra-cluster-name Specifies the cluster name.
-au --azure-username Specifies the azure user.
-ac --azure-client-id Specifies azure client ID.
-azc --azure-client-secret Specifies azure client access secret.
-at --azure-tenant-id Specifies azure user tenant.
-f --force Enables the -auto-approve option for terraform command.
-d --develop Enables develop mode which mounts the local code to the container.

Examples

The following example displays a list of azure accounts in tabular format:

 ./deploy-terraform.sh exec az account list --output table

The following example displays the caller identity of the associated AWS account:

./deploy-terraform.sh exec aws sts get-caller-identity

The following example displays the deployment details:

./deploy-terraform.sh output -n <name of deployment>