Installing the VAST DataEngine CLI

Prev Next

The VAST DataEngine CLI provides commands that perform the same tasks as the VAST DataEngine web user interface. The CLI also enables you to package a function as an image to upload to the container registry. You will need to initialize and package functions in order to deploy them within DataEngine pipelines (as described in Creating a DataEngine Function).

  1. Download the VAST DataEngine CLI binary file for your operating system.

  2. Save the file locally.

  3. Run the vastde config init command with the following syntax to initialize and edit the CLI configuration:

vastde config init --password PASSWORD
                   --tenant TENANT_NAME
                   --username USERNAME
                   --builder-image-url BUILDER-IMAGE-URL
                   --vms-url VMS-URL

Substitute the arguments for the following values:

PASSWORD

The password is associated with the username you provide as USERNAME.

TENANT_NAME

The name of the tenant you want to connect to (running DataEngine).

USERNAME

A username of a user with access  to the specified tenant. This can be an application user, a tenant admin user or a cluster admin user.  

BUILDER-IMAGE-URL

The URL of the VAST DataEngine Builder Docker image, in the format vastdataorg/vast-builder/TAG, where TAG is a version tag.

To find a version tag, browse to https://hub.docker.com/r/vastdataorg/vast-builder/ and select a tag from the Recent tags dropdown.

For example, vastdataorg/vast-builder:v1.0.60ee8cc7.vast-5.4.

VMS-URL

The URL to the cluster's VAST Management Service (VMS) in the format https://VMS_IP, where VMS_IP is the VMS IP.

  1. To view the content of the configuration file:

    vastde config view

Now that the configuration is initialized, you can run CLI commands against the specified tenant's DataEngine.

Note

VAST DataEngine CLI documentation is available at here.