Commit e67cd503 authored by Muhammad Umair Khan's avatar Muhammad Umair Khan
Browse files

patch README.md for K8s tilt

parent f3ca8beb

README.md

+8 −8
Original line number Diff line number Diff line
@@ -392,14 +392,14 @@ tilt up # Start watching (platform must already be deployed) 
# Open http://localhost:10350 for the Tilt dashboard

```



### What Tilt automates



| You edit | Tilt automatically runs |

|----------|------------------------|

| `go-apps/meep-iot/` (Go code) | `meepctl build` → `meepctl dockerize` → restart K8s pods |

| `charts/meep-iot/` (Helm chart) | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` |

| `go-apps/meep-platform-ctrl/` (core Go code) | `meepctl build` → `meepctl dockerize` → `meepctl deploy core -f` |

| `charts/meep-platform-ctrl/` (core chart) | `meepctl deploy core meep-platform-ctrl -f` |

### What Tilt manages



| You edit | Trigger type | What Tilt runs |

|----------|--------------|----------------|

| `go-apps/meep-iot/` (Go code) | **Manual** (from GUI button) | `meepctl build` → `meepctl dockerize` → restart K8s pods |

| `charts/meep-iot/` (Helm chart) | **Auto** on save | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` |

| `go-apps/meep-platform-ctrl/` (core Go code) | **Auto** on save | `meepctl build` → `meepctl dockerize` → `meepctl deploy core -f` |

| `charts/meep-platform-ctrl/` (core chart) | **Auto** on save | `meepctl deploy core meep-platform-ctrl -f` |



Dependencies (Grafana, CouchDB, etc.) are available as **manual buttons** in the Tilt UI dashboard.

docs/tilt-dev-workflow.md

+18 −18
Original line number Diff line number Diff line
@@ -63,10 +63,10 @@ Tilt wraps `meepctl` commands. When you save a file, Tilt detects the change and 


| Scenario | Before (manual) | After (with Tilt) |

|----------|-----------------|-------------------|

| Edit `go-apps/meep-federation/` | `meepctl build meep-federation` → `meepctl dockerize meep-federation` → restart pods | **Just save the file** |

| Edit `charts/meep-federation/` | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` | **Just save the file** |

| Edit `go-apps/meep-platform-ctrl/` | `meepctl build` → `meepctl dockerize` → `meepctl deploy core meep-platform-ctrl -f` | **Just save the file** |

| Edit `charts/meep-platform-ctrl/` | `meepctl deploy core meep-platform-ctrl -f` | **Just save the file** |

| Edit `go-apps/meep-federation/` | `meepctl build meep-federation` → `meepctl dockerize meep-federation` → restart pods | **Click "Trigger" button in Tilt GUI** |

| Edit `charts/meep-federation/` | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` | **Just save the file** (Auto) |

| Edit `go-apps/meep-platform-ctrl/` | `meepctl build` → `meepctl dockerize` → `meepctl deploy core meep-platform-ctrl -f` | **Just save the file** (Auto) |

| Edit `charts/meep-platform-ctrl/` | `meepctl deploy core meep-platform-ctrl -f` | **Just save the file** (Auto) |



---
@@ -92,13 +92,13 @@ Each core app has two Tilt resources: 


---



### Sandbox MEC API Apps (auto-watched)

### Sandbox MEC API Apps (manual-trigger)



Each sandbox app has one Tilt resource:

Each sandbox app has one Tilt resource configured in manual trigger mode (`TRIGGER_MODE_MANUAL`) so that file changes do not trigger builds automatically. Instead, Tilt watches the files and shows a manual trigger button in the GUI when there are pending changes:



| Resource | Watches | Triggers |

|----------|---------|----------|

| `<app>:code` | `go-apps/<app>/` | `meepctl build` → `meepctl dockerize` → `kubectl rollout restart` on all deployments using that image |

| Resource | Watches | Trigger Type | Action |

|----------|---------|--------------|--------|

| `<app>:code` | `go-apps/<app>/` | **Manual (GUI)** | `meepctl build` → `meepctl dockerize` → `kubectl rollout restart` on all deployments using that image |



The restart step automatically finds all K8s deployments using the app's Docker image across all namespaces (since sandbox deployments have dynamic names like `mep1-mec033-1`).
@@ -168,14 +168,14 @@ Dependencies are third-party infrastructure services that rarely change. They ap 


Complete reference of what happens when each type of file changes:



| File changed | Tilt resource triggered | Commands executed |

|-------------|------------------------|-------------------|

| `go-apps/meep-platform-ctrl/**` | `meep-platform-ctrl:code` | build → dockerize → `meepctl deploy core meep-platform-ctrl -f` |

| `charts/meep-platform-ctrl/**` | `meep-platform-ctrl:chart` | `meepctl deploy core meep-platform-ctrl -f` |

| `go-apps/meep-iot/**` | `meep-iot:code` | build → dockerize → `kubectl rollout restart` (all deployments using meep-iot image) |

| `charts/meep-iot/**` | `meep-virt-engine:sandbox-charts` | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` |

| `go-apps/meep-virt-engine/**` | `meep-virt-engine:code` | build → dockerize → `meepctl deploy core meep-virt-engine -f` |

| `charts/meep-virt-engine/**` | `meep-virt-engine:chart` | `meepctl deploy core meep-virt-engine -f` |

| File changed | Tilt resource triggered | Trigger Type | Commands executed |

|-------------|------------------------|--------------|-------------------|

| `go-apps/meep-platform-ctrl/**` | `meep-platform-ctrl:code` | Auto | build → dockerize → `meepctl deploy core meep-platform-ctrl -f` |

| `charts/meep-platform-ctrl/**` | `meep-platform-ctrl:chart` | Auto | `meepctl deploy core meep-platform-ctrl -f` |

| `go-apps/meep-iot/**` | `meep-iot:code` | **Manual** (GUI) | build → dockerize → `kubectl rollout restart` (all deployments using meep-iot image) |

| `charts/meep-iot/**` | `meep-virt-engine:sandbox-charts` | Auto | `meepctl dockerize meep-virt-engine` → `meepctl deploy core meep-virt-engine -f` |

| `go-apps/meep-virt-engine/**` | `meep-virt-engine:code` | Auto | build → dockerize → `meepctl deploy core meep-virt-engine -f` |

| `charts/meep-virt-engine/**` | `meep-virt-engine:chart` | Auto | `meepctl deploy core meep-virt-engine -f` |



> **Ignored paths:** `vendor/` directories are excluded from watching to avoid false triggers.
@@ -189,7 +189,7 @@ The Tiltfile has three configurable lists at the top: 
# Core apps (auto-watched for code + chart changes)

CORE_APPS = ['meep-auth-svc', 'meep-mon-engine', ...]



# Sandbox MEC API apps (auto-watched for code changes)

# Sandbox MEC API apps (manual trigger for code changes)

SANDBOX_APPS = ['meep-ams', 'meep-iot', 'meep-federation', ...]



# Dependencies (manual buttons only)