Files and State¶
quinectl keeps its files and containers in three places: your project directory, its own state directory, and Docker. This page lists what it keeps in each, and how to upgrade or uninstall quinectl.
In your project directory¶
| Path | What it is |
|---|---|
quinectl.yaml |
Your configuration. The only file you edit. quinectl writes it only when you run init, or generate-config -o with this path. |
conf/quine/member-<n>.conf |
The configuration quinectl generated for Quine member n, starting at 0. |
conf/novelty/member-0.conf |
The configuration generated for Novelty. |
logs/quine/member-<n>.log |
Output of Quine member n, from an image or a jar. |
logs/novelty/member-0.log |
The same for Novelty. |
conf/proxy.conf |
The nginx configuration, with proxy: nginx. |
quine.db, novelty.db |
Each product's graph, with persistor: rocks-db. |
Every file quinectl generates starts with a line saying so. They are rewritten on every run, so change
quinectl.yaml instead of editing them. Reading them is a good way to see how each product is configured.
Anything you set under jvmProperties is passed at launch and doesn't appear in them.
In ~/.quinectl/state/¶
quinectl keeps its own records here: the local certificate authority (certs/ca.pem), Keycloak client
secrets, which project started which member, which seed files it has loaded, and each project's
metrics targets, data source and dashboards. On Windows it is under %USERPROFILE%\.quinectl.
Don't edit anything in it. It never decides what quinectl runs; only quinectl.yaml does. quinectl gc
cleans up what deleted projects left behind: these records, and also their keyspaces, realms, Kafka topics
and containers, so read quinectl gc --dry-run first. If it stops with an error about a Docker network
while removing a deleted cluster, run it again. quinectl down --all --purge clears every project's
records from it. The local certificate authority and some cached files stay, so the next up keeps
using the same certificate authority.
In Docker¶
| Name | Shared by every project | What it is |
|---|---|---|
quinectl-cassandra |
Yes | Cassandra |
quinectl-keycloak |
Yes | Keycloak |
quinectl-kafka |
Yes | Kafka |
quinectl-prometheus |
Yes | Prometheus |
quinectl-grafana |
Yes | Grafana |
quinectl-prom-label-proxy |
Yes | Limits each project's dashboards to its own data |
quinectl-quine-<id>-<n> |
No | Quine member n of one project |
quinectl-novelty-<id>-0 |
No | Novelty for one project |
quinectl-proxy-<id> |
No | One project's nginx |
<id> is derived from the project directory's path. quinectl only ever stops or removes containers it
created.
Upgrade quinectl¶
Install the new version the same way you installed the first; see Get quinectl. You
can leave your projects running. Then run up in each project:
quinectl version
quinectl up
up restarts a product if its generated configuration changed. Your graph and Keycloak users stay.
A file from quinectl 1.0.9 or earlier may need changes
up,status,token,generate-quine-conf,cass-resetandkafka-resetneed aquinectl.yaml. A directory where you ranquinectl upwith no file, which started Quine OSS, needs one now:quinectl init --edition osswrites the same defaults.quinectl downstill stops what runs there.- Remove
services.auth.keycloak.postgresif your file sets it: it is now an unknown field. - A file that sets
jar:also needsruntime: jar. quine.webserver.addressandquine.metrics-reporters, and Novelty'sthatdot.novelty.webserver.addressandthatdot.novelty.metrics-reporters, are refused underpropertiesandjvmProperties. The error names the field to set instead.- Keyspace and realm names are checked. A keyspace starts with a lowercase letter, followed by
lowercase letters, digits or
_, at most 48 characters. A realm starts with a letter or digit, followed by letters, digits,_or-. - A product running from its image with metrics on, or with a
configFile, restarts once on the firstup.
Uninstall quinectl¶
Take quinectl's certificate authority out of your keychain if you trusted it, remove what quinectl started, then remove its state and the binary:
quinectl trust --remove # macOS, if you ran quinectl trust
quinectl down --all --purge
rm -rf ~/.quinectl
rm ~/.local/bin/quinectl
quinectl trust --remove needs the certificate authority in ~/.quinectl, so run it before you delete
that directory. quinectl down --all --purge deletes every project's graph, Keycloak users and Kafka
topics. The last command uses the path from Get quinectl, so change it if you
installed somewhere else.
Some things stay:
- Docker images: remove the ones you no longer need with
docker image rm. - Project directories:
quinectl.yaml,conf/andlogs/are yours to keep or delete.