Quickstart

This guide walks you through deploying your first application (Superset) using the Onvera CLI. The entire process takes less than 10 minutes.

Prerequisites

A Linux, macOS, or Windows machine
An Onvera account (sign up at onvera.io (opens in a new tab))
curl installed (for CLI installation)

Step 1: Install the CLI

Install the Onvera CLI using the installation script:

curl -fsSL https://onvera-downloads.s3.amazonaws.com/cli/install/install.sh | sh

The installer automatically detects your architecture and installs the appropriate binary.

Verify installation:

onvera version

You should see the CLI version number.

Step 2: Authenticate

Authenticate with Onvera using browser login:

onvera auth login

ℹ️

This command:

Opens your browser to the Onvera login page
Prompts you to authenticate and approve CLI access
Stores your API key locally for future commands

Alternative: API Key Authentication

If you prefer to use an API key directly:

onvera auth login --token onv_sk_live_...

Or paste interactively:

onvera auth login --key

Step 3: Deploy Superset

Deploy your first Superset instance:

onvera deploy superset --name "My First Superset"

The --name flag is optional. If omitted, Onvera generates a name automatically.

ℹ️

What happens:

Onvera creates a Deployment resource
Returns a Deployment ID and Operation ID
The CLI polls for completion, showing progress updates
Deployment typically takes 5-10 minutes

Example output:

Creating superset deployment...
Deployment created: dep_550e8400-e29b-41d4-a716-446655440000
Operation ID: op_660e8400-e29b-41d4-a716-446655440001
Polling for completion...
Press Ctrl+C to stop polling (deployment will continue)
Status: provisioning_db - Provisioning database (45s elapsed)
Status: provisioning_infrastructure - Creating infrastructure (2m 14s elapsed)
Status: waiting_for_subdomain - Configuring subdomain (4m 32s elapsed)
Status: ready - Deployment ready (6m 15s elapsed)

Deployment succeeded!

💡

You can press Ctrl+C to stop polling. The deployment continues in the background. Use the Operation ID to check status later.

Step 4: Inspect Your Deployment

View details about your deployment:

onvera inspect dep_550e8400-e29b-41d4-a716-446655440000

Example output:

Deployment ID: dep_550e8400-e29b-41d4-a716-446655440000
Name: My First Superset
App Type: superset
Status: ready
URL: https://my-first-superset-abc123.onvera.io
Created: 2024-01-20T12:00:00Z

Step 5: List All Deployments

View all deployments in your organization:

onvera ls

Example output:

ID                                    NAME                APP TYPE    STATUS
dep_550e8400-e29b-41d4-a716-446655440000  My First Superset  superset    ready
dep_660e8400-e29b-41d4-a716-446655440001  Production Airflow airflow     ready

Next Steps

Explore the API - Use the REST API for programmatic access
Understand Operations - Learn about async operations and polling
CLI Commands - Complete CLI reference

Troubleshooting

⚠️

If you encounter issues:

Installation fails: Check that curl is installed and you have write permissions
Authentication fails: Ensure you're logged in at onvera.io (opens in a new tab)
Deployment fails: Check the operation status with onvera ops get <operation_id>
See more troubleshooting tips

What's Next?

You've successfully deployed your first application! Learn more about:

Concepts - Core concepts and architecture
CLI Commands - Complete CLI reference
API Reference - REST API documentation

Overview Overview