Skip to content

Commit 69f7958

Browse files
updated readme
1 parent 51a6b2b commit 69f7958

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ The stack will create a local Kubernetes cluster. Each network installation crea
129129
> Use `obol network list` to see all available networks. Customize installations with flags (e.g., `obol network install ethereum --network=holesky --execution-client=geth`) to create different deployment configurations. After installation, deploy to the cluster with `obol network sync <network>/<id>`.
130130
131131
> [!TIP]
132-
> You can also install arbitrary Helm charts as applications using `obol app install <chart-url>`. Find charts at [Artifact Hub](https://artifacthub.io).
132+
> You can also install arbitrary Helm charts as applications using `obol app install <chart>`. Find charts at [Artifact Hub](https://artifacthub.io).
133133
134134
## Managing Networks
135135

@@ -276,23 +276,32 @@ The Obol Stack supports installing arbitrary Helm charts as managed applications
276276

277277
### Install an Application
278278

279-
Install any Helm chart by providing a direct HTTPS URL to a chart `.tgz` file:
279+
Install any Helm chart using one of the supported reference formats:
280280

281281
```bash
282-
# Install Redis from Bitnami
282+
# Install using repo/chart format (resolved via ArtifactHub)
283+
obol app install bitnami/redis
284+
obol app install bitnami/[email protected]
285+
286+
# Install using direct URL
283287
obol app install https://charts.bitnami.com/bitnami/redis-19.0.0.tgz
284288

285-
# Install PostgreSQL with custom name and ID
286-
obol app install https://charts.bitnami.com/bitnami/postgresql-15.0.0.tgz --name mydb --id production
289+
# Install with custom name and ID
290+
obol app install bitnami/postgresql --name mydb --id production
287291
```
288292

289-
Find chart URLs at [Artifact Hub](https://artifacthub.io).
293+
Find charts at [Artifact Hub](https://artifacthub.io).
294+
295+
**Supported chart reference formats:**
296+
- `repo/chart` - Resolved via ArtifactHub (e.g., `bitnami/redis`)
297+
- `repo/chart@version` - Specific version (e.g., `bitnami/[email protected]`)
298+
- `https://.../*.tgz` - Direct URL to chart archive
290299

291300
**What happens during installation:**
292-
1. Downloads the chart files locally to `~/.config/obol/applications/<app>/<id>/`
293-
2. Extracts chart templates, values, and metadata
294-
3. Generates a helmfile.yaml for deployment
295-
4. Saves installation metadata
301+
1. Resolves the chart reference (via ArtifactHub for repo/chart format)
302+
2. Fetches default values from the chart
303+
3. Generates helmfile.yaml that references the chart remotely
304+
4. Saves configuration to `~/.config/obol/applications/<app>/<id>/`
296305

297306
**Installation options:**
298307
- `--name`: Application name (defaults to chart name)
@@ -347,25 +356,19 @@ This command will:
347356

348357
### Customize Applications
349358

350-
After installation, you can modify the chart files directly:
359+
After installation, you can modify the values file to customize your deployment:
351360

352361
```bash
353362
# Edit application values
354363
$EDITOR ~/.config/obol/applications/postgresql/eager-fox/values.yaml
355364

356-
# Modify templates
357-
$EDITOR ~/.config/obol/applications/postgresql/eager-fox/templates/statefulset.yaml
358-
359365
# Re-deploy with changes
360366
obol app sync postgresql/eager-fox
361367
```
362368

363369
**Local files:**
364-
- `Chart.yaml`: Chart metadata
370+
- `helmfile.yaml`: Deployment configuration (references chart remotely)
365371
- `values.yaml`: Configuration values (edit to customize)
366-
- `templates/`: Kubernetes resource templates
367-
- `helmfile.yaml`: Deployment definition
368-
- `metadata.yaml`: Installation metadata
369372

370373
### Managing the Stack
371374

@@ -496,11 +499,8 @@ The Obol Stack follows the [XDG Base Directory](https://specifications.freedeskt
496499
└── applications/ # Installed application deployments
497500
├── redis/ # Redis deployments
498501
│ └── <id>/ # Deployment instance
499-
│ ├── Chart.yaml # Chart metadata
500-
│ ├── values.yaml # Configuration values
501-
│ ├── helmfile.yaml # Deployment definition
502-
│ ├── metadata.yaml # Installation metadata
503-
│ └── templates/ # Kubernetes resources
502+
│ ├── helmfile.yaml # Deployment configuration
503+
│ └── values.yaml # Configuration values
504504
└── postgresql/ # PostgreSQL deployments
505505
└── <id>/ # Deployment instance
506506
```

0 commit comments

Comments
 (0)