Skip to main content
Version: v2.10.0

Get started

This guide walks you through the seven steps that take a fresh tenant all the way to running your first query on a Yeedu cluster. Follow the stages in order on your first run; if you already use Yeedu, jump directly to the stage that is most relevant to you.

Prerequisites​

Before you begin you need:

  • Access to an AWS, Azure, or Google Cloud account where you've permission to create networks, IAM roles, and virtual machines.
  • A Yeedu license or trial entitlement from your account team.
  • A workstation with bash, curl, and a recent browser.

If you want to run the CLI examples, also install the Yeedu CLI.

The seven stages​

1. Set up Yeedu in your cloud​

Choose your cloud and deployment model:

We deploy Yeedu inside your own Virtual Private Cloud (VPC) or on-premises environment, so your data never leaves your network. Our Cloud Formation Engine provisions the compute machines in that account on your behalf and tears them down when they're no longer needed. On AWS you can take either the CloudFormation quickstart or the manual installation, while the Azure and GCP routes are Kubernetes deployments that both begin from a requirement checklist.

2. Create a workspace​

A workspace groups users, clusters, jobs, notebooks, and secrets for a team or business unit. See Create a workspace.

3. Connect a catalog​

Catalogs hold table and schema metadata so your queries can discover datasets in object storage. Connect one of the supported metastores:

4. Create a cluster​

Clusters provide the compute that runs your jobs and notebooks. See Create a cluster and choose a sizing strategy in Cluster size and Load-based sizing.

5. Run code in a notebook​

Open the notebook editor, attach it to your new cluster, and run a query. See Create a notebook and Editor pane.

6. Configure access control​

Grant the right people the right permissions on workspaces, clusters, catalogs, jobs, and notebooks. See Access management and Roles.

7. Drive Yeedu from the command line​

For automation and CI/CD, install the Yeedu CLI and authenticate, then explore the CLI commands reference.

Next steps​