Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions osdc/docs/quick_start_macos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Quick Start (macOS)

## Prerequisites

### 1. Homebrew

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

### 2. Install tools

```bash
brew install mise just git
```

### 3. AWS credentials
reach out to pytorch dev infra team to get access to the AWS credential

### 4. Clone and init submodules

```bash
git clone <repo-url> ciforge
cd ciforge/osdc
git submodule update --init --recursive
```

### 5. Install project dependencies

```bash
mise install # installs tofu, kubectl, helm, crane, etc.
just setup # installs Python dependencies via uv
```

## Verify setup

```bash
just lint # all linters should pass
just test # all tests should pass
```

## Useful commands

```bash
just --list # all available recipes
kubectl get pods -A # all pods
kubectl get nodes # all nodes
kubectl get nodepools # Karpenter NodePools
k9s # interactive cluster UI
```

## Lint and test

Always run before submitting changes:

```bash
just lint
just test
```

## More docs

- [operations.md](operations.md) — day-to-day operations, adding clusters/modules/runners
- [architecture.md](architecture.md) — platform design
- [modules.md](modules.md) — module contract and structure
- [observability.md](observability.md) — monitoring and logging
4 changes: 2 additions & 2 deletions osdc/mise.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
[tools]
python = "3.12"
opentofu = "1.7"
kubectl = "1.29"
helm = "3.14"
kubectl = "1.29.12"
helm = "3.14.4"
awscli = "2"
packer = "1.10"
crane = "latest"
Expand Down
Loading