# databricks-academy/workspace-setup architecture

> Architecture diagram of the GitHub repository databricks-academy/workspace-setup, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/databricks-academy/workspace-setup
- Repository: https://github.com/databricks-academy/workspace-setup

## Overview

This repository provides scripts and Databricks notebooks for preparing training workspaces, including Universal, CloudLabs, DAIS, and Vocareum variants. The main workflow configures workspace resources and permissions, then installs courseware or datasets; CloudLabs additionally provisions a workspace and launches a setup job. The shared REST client handles authenticated Databricks API calls. README and excerpts support these capabilities, but unsampled notebook sections leave some implementation details unverified.

Main entry points: [`universal-workspace-setup.py`](https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py) (Universal Setup), [`CloudLabs/cloudlabs-setup-script.py`](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-setup-script.py) (CloudLabs Provisioner), [`CloudLabs/cloudlabs-job-script.py`](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-job-script.py) (Job Deploy Runner), [`CloudLabs/simplified_rest_client.py`](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/simplified_rest_client.py) (REST Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Workspace Setup"]
  node_universal["Universal Setup"]
  node_dais["DAIS Setup"]
  node_vocareum["Vocareum Setup"]
  node_resources["Workspace Resources"]
  node_courseware["Courseware Install"]
  node_datasets["Dataset Install"]
end

subgraph group_cloudlabs["CloudLabs Provisioning"]
  node_cloudlabs_main["CloudLabs Provisioner"]
  node_cloudlabs_job["Job Deploy Runner"]
  node_cluster_deploy["Cluster Policy Deploy"]
  node_config_check["Workspace Inspector"]
  node_job_validate["DAIS Job Validator"]
end

subgraph group_shared["API Client"]
  node_rest_client["REST Client"]
end

node_operator(("Workspace Operator"))
node_databricks[("Databricks Workspace")]
node_job_config["Job Configuration"]
node_dais_config["DAIS Job Configuration"]

node_operator -->|"runs setup"| node_universal
node_operator -->|"runs setup"| node_dais
node_operator -->|"runs setup"| node_vocareum
node_operator -->|"starts provisioning"| node_cloudlabs_main
node_universal -->|"configures"| node_resources
node_universal -.->|"installs"| node_datasets
node_universal -.->|"installs"| node_courseware
node_dais -->|"configures"| node_resources
node_dais -.->|"installs"| node_courseware
node_vocareum -->|"configures"| node_resources
node_vocareum -->|"preinstalls"| node_courseware
node_cloudlabs_main -->|"calls"| node_rest_client
node_cloudlabs_main -->|"provisions via API"| node_databricks
node_cloudlabs_main -->|"creates and runs job"| node_cloudlabs_job
node_cloudlabs_job -->|"calls"| node_rest_client
node_cloudlabs_job -->|"downloads and parses"| node_job_config
node_cloudlabs_job -->|"creates and monitors job"| node_databricks
node_cluster_deploy -->|"calls"| node_rest_client
node_cluster_deploy -->|"creates cluster"| node_databricks
node_config_check -->|"calls"| node_rest_client
node_config_check -->|"reads configuration"| node_databricks
node_job_validate -->|"downloads and transforms"| node_dais_config
node_job_validate -->|"creates job"| node_databricks

click node_universal "https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py"
click node_dais "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/DAIS-2023-Workspace-Setup.py"
click node_vocareum "https://github.com/databricks-academy/workspace-setup/blob/main/Vocareum/Workspace-Setup-LLM-MOOC.py"
click node_resources "https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py"
click node_courseware "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/DAIS-2023-Workspace-Setup.py"
click node_cloudlabs_main "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-setup-script.py"
click node_cloudlabs_job "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-job-script.py"
click node_cluster_deploy "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cluster-policies.py"
click node_config_check "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-check-config-script.py"
click node_job_validate "https://github.com/databricks-academy/workspace-setup/blob/main/src/workspace_setup/cloudlabs/validate-dais-workspace-setup.py"
click node_rest_client "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/simplified_rest_client.py"
click node_job_config "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-job-config.json"
click node_dais_config "https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/dais-job-config.json"
click node_datasets "https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_universal,node_dais,node_vocareum,node_resources,node_courseware,node_datasets toneBlue
class node_cloudlabs_main,node_cloudlabs_job,node_cluster_deploy,node_config_check,node_job_validate,node_databricks toneAmber
class node_rest_client toneMint
class node_operator toneIndigo
class node_job_config,node_dais_config toneTeal
```

## Components

### Workspace Setup

- [Universal Setup](https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py): `universal-workspace-setup.py`
- [DAIS Setup](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/DAIS-2023-Workspace-Setup.py): `CloudLabs/DAIS-2023-Workspace-Setup.py`
- [Vocareum Setup](https://github.com/databricks-academy/workspace-setup/blob/main/Vocareum/Workspace-Setup-LLM-MOOC.py): `Vocareum/Workspace-Setup-LLM-MOOC.py`
- [Workspace Resources](https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py): `universal-workspace-setup.py`
- [Courseware Install](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/DAIS-2023-Workspace-Setup.py): `CloudLabs/DAIS-2023-Workspace-Setup.py`
- [Dataset Install](https://github.com/databricks-academy/workspace-setup/blob/main/universal-workspace-setup.py): `universal-workspace-setup.py`

### CloudLabs Provisioning

- [CloudLabs Provisioner](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-setup-script.py): `CloudLabs/cloudlabs-setup-script.py`
- [Job Deploy Runner](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-job-script.py): `CloudLabs/cloudlabs-job-script.py`
- [Cluster Policy Deploy](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cluster-policies.py): `CloudLabs/cluster-policies.py`
- [Workspace Inspector](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-check-config-script.py): `CloudLabs/cloudlabs-check-config-script.py`
- [DAIS Job Validator](https://github.com/databricks-academy/workspace-setup/blob/main/src/workspace_setup/cloudlabs/validate-dais-workspace-setup.py): `src/workspace_setup/cloudlabs/validate-dais-workspace-setup.py`

### API Client

- [REST Client](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/simplified_rest_client.py): `CloudLabs/simplified_rest_client.py`

### Other components

- **Workspace Operator**
- **Databricks Workspace**
- [Job Configuration](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/cloudlabs-job-config.json): `CloudLabs/cloudlabs-job-config.json`
- [DAIS Job Configuration](https://github.com/databricks-academy/workspace-setup/blob/main/CloudLabs/dais-job-config.json): `CloudLabs/dais-job-config.json`

## Connections

- Workspace Operator → Universal Setup: runs setup (evidence: `universal-workspace-setup.py`)
- Workspace Operator → DAIS Setup: runs setup (evidence: `CloudLabs/DAIS-2023-Workspace-Setup.py`)
- Workspace Operator → Vocareum Setup: runs setup (evidence: `Vocareum/Workspace-Setup-LLM-MOOC.py`)
- Workspace Operator → CloudLabs Provisioner: starts provisioning (evidence: `CloudLabs/cloudlabs-setup-script.py`)
- Universal Setup → Workspace Resources: configures (evidence: `universal-workspace-setup.py`)
- Universal Setup → Dataset Install: installs (evidence: `universal-workspace-setup.py`)
- Universal Setup → Courseware Install: installs
- DAIS Setup → Workspace Resources: configures (evidence: `CloudLabs/DAIS-2023-Workspace-Setup.py`)
- DAIS Setup → Courseware Install: installs (evidence: `CloudLabs/DAIS-2023-Workspace-Setup.py`)
- Vocareum Setup → Workspace Resources: configures (evidence: `Vocareum/Workspace-Setup-LLM-MOOC.py`)
- Vocareum Setup → Courseware Install: preinstalls (evidence: `Vocareum/Workspace-Setup-LLM-MOOC.py`)
- CloudLabs Provisioner → REST Client: calls (evidence: `CloudLabs/cloudlabs-setup-script.py`)
- CloudLabs Provisioner → Databricks Workspace: provisions via API (evidence: `CloudLabs/cloudlabs-setup-script.py`)
- CloudLabs Provisioner → Job Deploy Runner: creates and runs job (evidence: `CloudLabs/cloudlabs-setup-script.py`)
- Job Deploy Runner → REST Client: calls (evidence: `CloudLabs/cloudlabs-job-script.py`)
- Job Deploy Runner → Job Configuration: downloads and parses (evidence: `CloudLabs/cloudlabs-job-script.py`)
- Job Deploy Runner → Databricks Workspace: creates and monitors job (evidence: `CloudLabs/cloudlabs-job-script.py`)
- Cluster Policy Deploy → REST Client: calls (evidence: `CloudLabs/cluster-policies.py`)
- Cluster Policy Deploy → Databricks Workspace: creates cluster (evidence: `CloudLabs/cluster-policies.py`)
- Workspace Inspector → REST Client: calls (evidence: `CloudLabs/cloudlabs-check-config-script.py`)
- Workspace Inspector → Databricks Workspace: reads configuration (evidence: `CloudLabs/cloudlabs-check-config-script.py`)
- DAIS Job Validator → DAIS Job Configuration: downloads and transforms (evidence: `src/workspace_setup/cloudlabs/validate-dais-workspace-setup.py`)
- DAIS Job Validator → Databricks Workspace: creates job (evidence: `src/workspace_setup/cloudlabs/validate-dais-workspace-setup.py`)
