Skip to content

Commit 94a2a34

Browse files
committed
docs: detail on the install
Signed-off-by: Anton Whalley <[email protected]>
1 parent b163807 commit 94a2a34

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A gitops tool to deploy systemd managed containers on linux. A.K.A quadlets.
66

77
`quadit` is focused on managing [quadlets](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html) and running containers in rootless mode using a gitops model.
88

9-
The `quadit`' core usecase is a `remote edge` scenario enforcing a pure pull model that ensures no inbound access to the device.
9+
The `quadit` core usecase is a `remote edge` scenario enforcing a pure pull model that ensures no inbound access to the device.
1010

1111
It is written in rust to minimise the overall footprint and improve the power consumption of running a gitops service on low resourced systems.
1212

@@ -41,6 +41,10 @@ Please evaluate the following matrix to understand which one would better suit y
4141

4242
## install
4343

44+
This example runs [a simple container](https://github.com/ubiquitous-factory/quadit/blob/main/samples/helloworld/hello.container#L7) that tails `/dev/null` to demonstrate how you automate the provisioning of containers through a yaml config file.
45+
46+
Once you've seen the demo you will probably want to host the config file in your own repo rather than use this one so you can add additional services and test out how the GitOps aspects work when the `config.yaml` is updated.
47+
4448
From the edge device running a systemd based distro with the latest podman the following commands:
4549
```
4650
sudo setsebool -P container_manage_cgroup true

0 commit comments

Comments
 (0)