Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kvaps committed May 6, 2024
1 parent 40c022d commit fd0fa09
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Talm

Just like Helm, but for Talos Linux
Manage Talos the GitOps Way!

Talm is just like Helm, but for Talos Linux

## Installation

Expand Down Expand Up @@ -30,6 +32,7 @@ talm -n 1.2.3.4 -e 1.2.3.4 template -t templates/controlplane.yaml -i > nodes/no

Edit `templates/node1.yaml` file:
```yaml
# talm: nodes=["1.2.3.4"], endpoints=["1.2.3.4"], templates=["templates/controlplane.yaml"]
machine:
network:
# -- Discovered interfaces:
Expand Down Expand Up @@ -81,3 +84,23 @@ Apply config:
```bash
talm apply -f nodes/node1.yaml -i
```

Upgrade node:
```bash
talm upgrade -f nodes/node1.yaml
```

Show diff:
```bash
talm apply -f nodes/node1.yaml --dry-run
```

Template config and update in place:
```
talm template -f nodes/node1.yaml -I
```

You're free to edit template files in `./templates` directory.
All [Helm](https://helm.sh/docs/chart_template_guide/functions_and_pipelines/) and [Sprig](https://masterminds.github.io/sprig/) functions are supported, including lookups for talos resources!


0 comments on commit fd0fa09

Please sign in to comment.