Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tensor9.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide explains how to install the tensor9 CLI and use it to create a Tensor9 control plane in a dedicated AWS account you own.

​
Prerequisites

Before you can use Tensor9, you need to ensure your environment meets the following requirements:
  • Tensor9 API Key: You must have an API key to use the tensor9 CLI. If you don’t have one, please send an email to [email protected] to request one.
  • A dedicated AWS account: This account should be used exclusively for Tensor9 to avoid conflicts with other resources.

​
Install the Tensor9 CLI

Install the tensor9 CLI via Homebrew (recommended): 
brew tap tensor9ine/tensor9
brew install tensor9
Alternatively, install via the install script: 
curl -sSL https://t9-artifacts-prod-1.s3.us-west-2.amazonaws.com/install-latest.sh | sh
Then set your Tensor9 API key: 
export T9_API_KEY=<YOUR_API_KEY>
Note: An API key is required. If you do not have an API key, send email to [email protected] to request one.

​
Set up your Tensor9 control plane

Your Tensor9 control plane is the engine that manages your customer appliances. It consists of a set of resources that are provisioned directly into your own dedicated Tensor9 AWS account. Your control plane is responsible for:
  • Managing your origin stacks.
  • Creating and managing appliances.
  • Performing deployments to appliances.
  • Synchronizing telemetry from appliances back to your observability sink.
  • Creating operations endpoints so that you can remotely operate appliances.
To set up your Tensor9 control plane, run the following command. This process can take several minutes to complete. 
tensor9 vendor setup \
  -cloud aws \
  -region <YOUR-REGION> \
  -awsProfile <YOUR_AWS_CLI_PROFILE>
Replace <YOUR-REGION> with the AWS region you are using and <YOUR_AWS_CLI_PROFILE> with the name of your configured AWS CLI profile.

​
Verify your control plane

Once the setup command completes, you can verify that your control plane is up and running by using the tensor9 report command. This command provides a summary of your Tensor9 control plane, including its health status. 
tensor9 report
For a newly created control plane with no apps or appliances yet, the output will look like this: 
Vendor: Acme Software [id: 000000000000003b]:
            Name: Acme Software

    Apps: (0)

    Customer Appliances: (0)

    Test Appliances: (0)
This confirms your control plane is running and ready to use. You can now proceed to create your first app and begin deploying to customer appliances.

​
Next steps

Now that your control plane is installed and running, explore these topics to start using Tensor9: