From 83f8f793a0d1485c8ece0d995d61edf0eb999473 Mon Sep 17 00:00:00 2001 From: Erikson Tung Date: Thu, 21 Nov 2019 13:42:14 -0800 Subject: [PATCH] README: Adds info on host-container persistent storage and mounted binaries Adds documentation on what's currently bind mounted in for all host-containers (just apiclient for now) Adds description for host-container persistent storage and what the default admin container is storing there (ssh host keys) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index dbb98a7063c..fb6fec42a6f 100644 --- a/README.md +++ b/README.md @@ -292,6 +292,11 @@ apiclient -u /settings/commit_and_apply -X POST If the `enabled` flag is `true`, it will be started automatically. +All host containers will have the `apiclient` binary available at `/usr/local/bin/apiclient` so they're able to [interact with the API](#using-the-api-client). + +In addition, all host containers come with persistent storage at `/.thar/host-containers/$HOST_CONTAINER_NAME` that is persisted across reboots and container start/stop cycles. +The default `admin` host-container, for example, store its SSH host keys under `/.thar/host-containers/admin/etc/ssh/`. + There are a few important caveats to understand about host containers: * They're not orchestrated. They only start or stop according to that `enabled` flag. * They run in a separate instance of containerd than the one used for orchestrated containers like Kubernetes pods.