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 have 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:

  • [Set up on AWS](./SetUp/AWS setup/index.mdx) — CloudFormation quickstart or manual installation.
  • [Set up on Azure](./SetUp/Azure setup/Kubernetes/1-requirement-checklist.mdx).
  • [Set up on GCP](./SetUp/GCP setup/Kubernetes/1-requirement-checklist.mdx).

You can deploy Yeedu directly inside your own Virtual Private Cloud (VPC) for full data isolation, or connect to Yeedu's serverless compute plane.

2. Create a workspace​

A workspace groups users, clusters, jobs, notebooks, and secrets for a team or business unit. See [Create a workspace](./Workspaces/Create Workspaces.md).

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:

  • [Hive Metastore](./Catalogs/Create Catalogs/Hive Metastore.md)
  • [AWS Glue Metastore](./Catalogs/Create Catalogs/Glue Metastore.md)
  • [Databricks Unity Catalog](./Catalogs/Create Catalogs/Unity Metastore.md)

4. Create a cluster​

Clusters provide the compute that runs your jobs and notebooks. See [Create a cluster](./Clusters/Create Cluster.md) and choose a sizing strategy in [Cluster size](./Clusters/Cluster Size.md) and [Load-based sizing](./Clusters/Load Based Sizing.md).

5. Run code in a notebook​

Open the notebook editor, attach it to your new cluster, and run a query. See [Create a notebook](./Notebook/Create notebook.md) and [Editor pane](./Notebook/Editor Pane.md).

6. Configure access control​

Grant the right people the right permissions on workspaces, clusters, catalogs, jobs, and notebooks. See [Access management](./Access Control/access_management.md) and [Roles](./Access Control/Roles.md).

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​

  • Operationalize workloads with [Jobs](./Jobs/Create Job.md).
  • Schedule recurring runs with the [Airflow operator](./Schedulers/Airflow Yeedu Operator.md) or the [Prefect operator](./Schedulers/Prefect Yeedu Operator.md).
  • Track spend with [the usage dashboard](./Usage and Cost Management/UsageDashboard.md).