Files and directories
Where instamix keeps things on a machine, and the files it writes into a tree.
On the machine#
| Path | What is there |
|---|---|
~/.config/instamix/config | the settings for everything |
.instamixconfig | the settings for a repository: the nearest one from the script’s directory up to the root of its git repository |
~/.cache/instamix/envs/ | the environments env builds, each named by a digest of what it holds |
~/.cache/instamix/lsp/ | the trees the language server lints and completes from |
~/.cache/instamix/proxy | the files the proxy has fetched |
~/.instamix/proxy.db | the proxy’s lists and its log of refusals (SQLite) |
~/.instamix/hub.db | the hub’s database (SQLite) |
~/.local/share/instamix/repos/ | the playbook repositories imix repo add clones |
In an environment#
Each directory under ~/.cache/instamix/envs/ holds:
| Path | What it is |
|---|---|
venv/ | the virtualenv, with ansible-core and the pip requirements |
requirements.in | what was asked for |
requirements.lock | what that resolved to, with hashes |
env.json | what was built |
collections/, roles/ | what a base brings, and nothing else |
In a generated tree#
| Path | Where it comes from |
|---|---|
inventory, ansible.cfg | added unless the script declares its own, or --bare |
requirements.yml | the galaxy requirements, when there are any |
requirements.txt | the pip requirements, unless the script declares one |
site.yml, group_vars/<group>.yml | written from the stages, groups and variables a script describes |
roles/, collections/ | what the script declares, and what install fetches |
galaxy.lock | what was installed, for which requirements |
.instamix | what generate wrote, so the next one removes what the script no longer declares; left out of archives |
In the source#
| Path | What it is |
|---|---|
api/openapi.json | the contract: imix spec -o api/openapi.json writes it again (download) |
instamix_bases.py | the pins of the community bases; tools/update_bases.py writes it again |
deploy/ | the images, the compose file and the kustomize base, components and overlays |
site/ | this site |