Use Teradata AI Unlimited With Workspace Client

This product is in preview and is subject to change. If you’re interested in learning more about this offering, contact Teradata Support.

Overview

Workspace Client (workspacectl) is a command line interface (CLI) for Teradata AI Unlimited. This document provides step-by-step instructions to install workspacectl. In this document, you can find all the necessary information and guidance on the CLI commands, allowing you to navigate the command line quickly and efficiently. For the current release, you can only connect to the workspace service and manage the engine using workspacectl. Teradata recommends using JupyterLab as the Teradata AI Unlimited interface for data exploration.

See Deploy a Teradata AI Unlimited Interface Using Docker.

Before you begin

Make sure you have:

Installed, configured, and set up workspace service using the steps outlined in Deploy and Setup Teradata AI Unlimited Workspace Service Using Docker.
Copied and retained the AWS environment variables and API Key.

Install workspacectl

Download the workspacectl executable file from https://downloads.teradata.com/download/tools/ai-unlimited-ctl.

Workspacectl supports all major operating systems.

Use workspacectl

Open the terminal window and run the workspacectl file.
- Windows
- MacOS
worksapcesctl.exe
workspacesctl
Configure workspace service using the API Key.
```
workspacesctl workspaces config
```

Create a new project.

workspacesctl project create <Project_Name> -e <CSP> --no-tls

Deploy an engine for the project.

workspacesctl project engine deploy <Project_Name> -t <Size_of_Engine> --no-tls

Run a sample workload.
Manage your project and engine.

Backup your project.

workspacesctl project backup <Project_Name> --no-tls

Suspend the engine.

workspacesctl project engine suspend <Project_Name> --no-tls

For a supported list of commands, see Workspaces CLI Reference.

Workspace Client reference

workspaces config

Description: One-time configuration to bind CLI with the workspace service. Go to the Workspace service Profile page and copy the API Key.

Usage:

workspacesctl workspaces config

Flags:

-h, --help: List the details of the command.

Output:

Follow the prompts to choose the workspace service endpoint and API Key.

workspaces user list

Description: View the list of users set up for Teradata AI Unlimited on GitHub.

Usage:

workspacesctl workspaces user list --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

project create

Description: Create a project in Teradata AI Unlimited. The command also creates a corresponding GitHub repository for the project.

Usage:

workspacesctl project create <Project_Name> -e <CSP> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

Flag Type Description Required?

Flag	Type	Description	Required?
`-e`, `--environment`	String	The environment where the project engine is hosted. Values: aws, azure, or gcloud. Currently, Teradata AI Unlimited supports aws and azure.	Yes
`-f`, `--manifest`	String	The path to manifest the yaml file to be used for the input.	No
`-t`, `--team`	String	The team assigned to the project.	No
`-h`, `--help`		List the details of the command.	No

-e, --environment

String

The environment where the project engine is hosted. Values: aws, azure, or gcloud. Currently, Teradata AI Unlimited supports aws and azure.

Yes

-f, --manifest

String

The path to manifest the yaml file to be used for the input.

-t, --team

String

The team assigned to the project.

-h, --help

List the details of the command.

Output:

project list

Description: View the list of all projects set up in Teradata AI Unlimited.

Usage:

workspacesctl project list --no-tls

workspacesctl project list <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

project delete

Description: Delete a project in Teradata AI Unlimited.

Usage:

 workspacesctl project delete <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

The output is in YAML format.

project user list

Description: View the list of collaborators assigned to the project in GitHub.

Usage:

workspacesctl project user list <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

project backup

Description: Back up the engine object definitions to the GitHub repository assigned for the project.

Usage:

workspacesctl project backup <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

The output is in YAML format.

project restore

Description: Restore all engine object definitions from the project GitHub repository.

Usage:

workspacesctl project restore <Project_Name> --no-tls

workspacesctl project restore <Project_Name> --gitref <git_reference> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

Flag Type Description Required?

Flag	Type	Description	Required?
`-g`, `--gitref`	String	Tag, SHA, or branch name.	No
`-h`, `--help`		List the details of the command.	No

-g, --gitref

String

Tag, SHA, or branch name.

-h, --help

List the details of the command.

Output:

The output is in YAML format.

project engine deploy

Description: Deploy an engine for the project.

Usage:

workspacesctl project engine deploy <Project_Name> -t small --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

Flag Type Description Required?

Flag	Type	Description	Required?
`-c`, `--instance-count`	Int	The number of engine nodes. The default value is 1.	No
`-t`, `--instance-size`	String	The instance size of the engine.	No
`-f`, `--manifest`	String	The path to manifest the yaml file to use for the input.	No
`-r`, `--region`	String	The region for the deployment.	No
`-s`, `--subnet-id`	String	The subnet ID for the deployment.	No
`-h`, `--help`		List the details of the command.	No

-c, --instance-count

Int

The number of engine nodes. The default value is 1.

-t, --instance-size

String

The instance size of the engine.

-f, --manifest

String

The path to manifest the yaml file to use for the input.

-r, --region

String

The region for the deployment.

-s, --subnet-id

String

The subnet ID for the deployment.

-h, --help

List the details of the command.

project engine suspend

Description: Destroy the deployed engine and back up the object definitions created during the session.

Usage:

workspacesctl project engine suspend <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

The output is in YAML format.

project engine list

Description: View the detailed information about the engine for a project. The command displays the last state of the engine.

Usage:

workspacesctl project engine list <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

The output is in YAML format.

project auth create

Description: Create authorization for object store.

Usage:

workspacesctl project auth create <Project_Name> -n <Auth_Name> -a <Auth_Key> -s <Auth_Secret> -r <ObjectStore_Region> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

Flag Type Description Required?

Flag	Type	Description	Required?
`-a`, `--accesskey`	String	The authorization access key or ID.	Yes, if you’re not using the `-f` flag.
`-n`, `--name string`	String	The authorization name for the object store.	Yes, if you’re not using the `-f` flag.
`-f`, `--manifest`	String	The path to manifest the yaml file to use for the input.	No
`-r`, `--region`	String	The region of the object store.	Yes
-s, --secret string	String	The authorization secret access key of the object store.	Yes, if you’re not using the `-f` flag.
`-h`, `--help`		List the details of the command.	No

-a, --accesskey

String

The authorization access key or ID.

Yes, if you’re not using the -f flag.

-n, --name string

String

The authorization name for the object store.

Yes, if you’re not using the -f flag.

-f, --manifest

String

The path to manifest the yaml file to use for the input.

-r, --region

String

The region of the object store.

Yes

-s, --secret string

String

The authorization secret access key of the object store.

Yes, if you’re not using the -f flag.

-h, --help

List the details of the command.

Output:

The output is in YAML format.

project auth list

Description: List object store authorizations that are created for a project.

Usage:

workspacesctl project auth list <Project_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

-h, --help: List the details of the command.

Output:

The output is in YAML format.

project auth delete

Description: Delete object store authorizations that are created for a project.

Usage:

workspacesctl project auth delete <Project_Name> -n <Auth_Name> --no-tls

If your setup includes TLS configuration, you need not add the -no-tls parameter.

Flags:

Flag Type Description Required?

Flag	Type	Description	Required?
`-n`, `--name`	String	Name of the object store authorization to delete.	Yes
`-h`, `--help`		List the details of the command.	No

-n, --name

String

Name of the object store authorization to delete.

Yes

-h, --help

List the details of the command.

Output:

The output is in YAML format.

If you have any questions or need further assistance, please visit our community forum where you can get support and interact with other community members.

Did this page help?