quinectl.yaml Reference¶
This page lists every field quinectl.yaml accepts in quinectl 1.0.10. A field that isn't
listed here is rejected. For how the file fits together, see Configure quinectl.
- Required: the six choices marked yes must appear in every file, except that
quine.editionis needed only when there is aquine:block. ${NAME}: reads an environment variable, for examplelicenseKey: ${QE_LICENSE_KEY}. It works only in some fields; see Values from the environment.- Short and long forms: each service choice can be written as one word, such as
persistor: cassandra, or as a block holding that choice's settings, such aspersistor: {cassandra: {heap: 2G}}.
quinectl agent --schema prints the same information as JSON.
quine¶
| Field | Type | Required | Values | Description |
|---|---|---|---|---|
quine |
object | Quine settings. Leave the block out to run Novelty alone. | ||
quine.edition |
string | yes | oss, enterprise |
Which Quine to run: enterprise for Quine Enterprise, or oss for Quine OSS. Required whenever the quine: block is present. |
quine.port |
integer | Port for the web UI and REST API. Default 8080. |
||
quine.jar |
string | Path to the Quine jar. Needs runtime: jar set as well: with the default docker, it is an error. Found in the current directory when omitted. |
||
quine.runtime |
string | jar, docker |
docker (default) runs the product image. jar runs a local jar with Java 17 or newer. |
|
quine.image |
string | Image to run with runtime: docker. Defaults to the image for this quinectl release: thatdot/quine for edition: oss, or the Quine Enterprise image on registry.license.thatdot.com for edition: enterprise. |
||
quine.pullPolicy |
string | missing, always, never |
When to pull the image: missing (default) pulls only when it isn't on the machine, always pulls on every run, never requires it to be there already. |
|
quine.customerId |
string | Your thatDot customer id, used as the username when pulling the Quine Enterprise image. Usually ${QE_CUSTOMER_ID}. Only with an image on registry.license.thatdot.com; remove it for another registry or runtime: jar. |
||
quine.logLevel |
string | ERROR, WARN, INFO, DEBUG, TRACE |
Log level. Default WARN. |
|
quine.logRedaction |
boolean | Hide potentially sensitive values, such as ingested data, in logs. Default false, which suits local development. |
||
quine.logShowExceptions |
boolean | Include exception messages and stack traces in logs. Default true. |
||
quine.licenseKey |
string | Your Quine Enterprise license key, usually ${QE_LICENSE_KEY}. Required for Enterprise. It is never written to any file quinectl creates. |
||
quine.configFile |
string | A Quine configuration (HOCON) file of your own, included in the generated configuration. quinectl's own settings win where both set the same key. See Passing Settings Through. | ||
quine.publicUrl |
string | The address browsers use for Quine Enterprise, when that isn't localhost, such as a load balancer or a hostname. An origin: http or https, a host, and an optional port, with nothing after it. See Deploy to EC2. |
||
quine.properties |
object | Extra Quine configuration keys and values, added to the generated configuration. See Passing Settings Through. | ||
quine.jvmProperties |
object | Extra Java system properties, passed to Quine as -D flags. See Passing Settings Through. |
||
quine.keyspace |
string | Cassandra keyspace for Quine's graph. Default quine. Give each project its own. |
||
quine.realm |
string | Keycloak realm for Quine's login. Default quine-enterprise. |
||
quine.clientId |
string | OIDC client id in Quine's realm. Default quine-enterprise-client. |
||
quine.accessTokenAudience |
string | Audience Quine expects in bearer tokens. Defaults to clientId. Tokens from quinectl token carry only the client id, so with any other value Quine refuses them unless you configure Keycloak to add that audience. |
||
quine.roles |
array of string | Roles in Quine's realm. Defaults to the six Quine Enterprise roles. With quinectl's own Keycloak, it adds SRE if your list leaves it out. |
||
quine.seedTestUsers |
boolean | Create sample users in Quine's realm. Default true. Not used with an external Keycloak. |
||
quine.users |
array of object | Sample users, each with username, password and roles. Defaults to one user per role (superadmin1 / superadmin123, and so on). [] creates none. |
||
quine.users[].username |
string | Login name, unique in the realm. | ||
quine.users[].password |
string | Password, written out or as ${VARIABLE}. |
||
quine.users[].roles |
array of string | Role names; at least one, each listed in quine.roles. |
||
quine.users[].email |
string | Email address. Default <username>@example.com. |
||
quine.users[].firstName |
string | First name. Default Test. |
||
quine.users[].lastName |
string | Last name. Defaults to the user's first role. | ||
quine.cluster |
object | Run a local Quine Enterprise cluster. Defaults to a single member. | ||
quine.cluster.size |
integer | Number of cluster members. Default 1. |
||
quine.cluster.hotSpares |
integer | Extra members that stand by to replace a failed one. Default 0. |
||
quine.cluster.portBase |
integer | Cluster communication port. Default 25520. From the image, every member uses this port inside its own container, so projects can share it. With runtime: jar, member N uses portBase + N, so give each project on the machine its own range. |
novelty¶
| Field | Type | Required | Values | Description |
|---|---|---|---|---|
novelty |
object | Novelty settings. Add this block to run Novelty, alone or beside Quine. | ||
novelty.port |
integer | Port for Novelty's web UI and REST API. Default 8080; must differ from quine.port. |
||
novelty.jar |
string | Path to novelty.jar, with its lib/ directory beside it. Needs runtime: jar set as well: with the default docker, it is an error. |
||
novelty.runtime |
string | jar, docker |
docker (default) runs the Novelty image. jar runs a local jar with Java 17 or newer. |
|
novelty.image |
string | Image to run with runtime: docker. Defaults to the Novelty image for this quinectl release on registry.license.thatdot.com. |
||
novelty.pullPolicy |
string | missing, always, never |
When to pull the image: missing (default), always, or never. |
|
novelty.customerId |
string | Your thatDot customer id for Novelty, usually ${NOVELTY_CUSTOMER_ID}. Never taken from quine.customerId. Only with an image on registry.license.thatdot.com; remove it for another registry or runtime: jar. |
||
novelty.logLevel |
string | ERROR, WARN, INFO, DEBUG, TRACE |
Log level. Default WARN. |
|
novelty.logRedaction |
boolean | Hide potentially sensitive values in logs. Default false. |
||
novelty.logShowExceptions |
boolean | Include exception messages and stack traces in logs. Default true. |
||
novelty.licenseKey |
string | Your Novelty license key, usually ${NOVELTY_LICENSE_KEY}. Always required. Never written to a file. |
||
novelty.keyspace |
string | Cassandra keyspace for Novelty. Default novelty; must differ from quine.keyspace. |
||
novelty.realm |
string | Keycloak realm for Novelty's login. Default novelty; must differ from quine.realm. |
||
novelty.clientId |
string | OIDC client id in Novelty's realm. Default novelty-client. |
||
novelty.accessTokenAudience |
string | Audience Novelty expects in bearer tokens. Defaults to clientId. |
||
novelty.roles |
array of string | Roles in Novelty's realm. Defaults to the same six roles as Quine. | ||
novelty.seedTestUsers |
boolean | Create sample users in Novelty's realm. Default true. |
||
novelty.users |
array of object | Sample users for Novelty, written like quine.users. |
||
novelty.users[].username |
string | Login name, unique in Novelty's realm. | ||
novelty.users[].password |
string | Password, written out or as ${VARIABLE}. |
||
novelty.users[].roles |
array of string | Role names; at least one, each listed in novelty.roles. |
||
novelty.users[].email |
string | Email address. Default <username>@example.com. |
||
novelty.users[].firstName |
string | First name. Default Test. |
||
novelty.users[].lastName |
string | Last name. Defaults to the user's first role. | ||
novelty.configFile |
string | A Novelty configuration (HOCON) file of your own, included in the generated configuration. | ||
novelty.publicUrl |
string | The address browsers use for Novelty, when that isn't localhost. Works like quine.publicUrl. With auth on, Quine and Novelty need different hosts. |
||
novelty.properties |
object | Extra Novelty configuration keys and values. | ||
novelty.jvmProperties |
object | Extra Java system properties, passed to Novelty as -D flags. |
services¶
| Field | Type | Required | Values | Description |
|---|---|---|---|---|
services |
object | The services quinectl runs alongside the products. All five choices below are required. | ||
services.persistor |
object | yes | cassandra, rocks-db, in-memory |
Where the graph is stored: cassandra, rocks-db, or in-memory. |
services.persistor.cassandra |
object | Settings for the local Cassandra container. persistor: cassandra alone uses the defaults. |
||
services.persistor.cassandra.image |
string | Cassandra image. Default cassandra:4.1. |
||
services.persistor.cassandra.cqlPort |
integer | Host port for CQL. Default 9042. Shared by every project on the machine. |
||
services.persistor.cassandra.heap |
string | Cassandra's maximum heap. Default 1G. |
||
services.persistor.rocksDb |
object | Settings for local RocksDB files. persistor: rocks-db alone uses the defaults. |
||
services.persistor.rocksDb.filepath |
string | Where the RocksDB files go. Default quine.db. |
||
services.persistor.rocksDb.createParentDir |
boolean | Passed to the product. Default false. With runtime: docker, a missing directory is created for you. |
||
services.persistor.rocksDb.writeAheadLog |
boolean | Keep a write-ahead log. Default true. |
||
services.persistor.rocksDb.syncAllWrites |
boolean | Flush every write to disk; slower and safer. Default false. Needs writeAheadLog: true; with the log off, the product doesn't start. |
||
services.persistor.rocksDb.bloomFilterSize |
integer | Optional bloom filter size. Unset by default. | ||
services.persistor.inMemory |
object | Keep the graph in memory only; it is lost when the product stops. Takes no settings. | ||
services.auth |
object | yes | none, keycloak |
Auth for the products: none or keycloak. With a quine: block, Keycloak needs edition: enterprise. A file with only a novelty: block can use it too. |
services.auth.keycloak |
object | Settings for the local Keycloak. auth: keycloak alone uses the defaults. |
||
services.auth.keycloak.secureCookies |
boolean | Send session cookies over HTTPS only. Default false, which suits localhost. |
||
services.auth.keycloak.sessionExpirationSeconds |
integer | Session length in seconds. Default 3600. |
||
services.auth.keycloak.external |
object | Use a Keycloak you already run instead of starting one. | ||
services.auth.keycloak.external.adminURL |
string | Base URL of your Keycloak's admin API. | ||
services.auth.keycloak.external.adminUser |
string | Admin username for your Keycloak, a value or ${ENV_VAR}. |
||
services.auth.keycloak.external.adminPassword |
string | Admin password for your Keycloak, a value or ${ENV_VAR}. |
||
services.auth.keycloak.external.manageRealm |
boolean | true (default): quinectl creates the realm, client and roles it needs. false: it only reads what is there. |
||
services.auth.keycloak.publicUrl |
string | The address browsers use for Keycloak. Sets its hostname, token issuer and sign-in address. Not used with external. With an https address, set secureCookies: true. |
||
services.proxy |
object | yes | none, nginx |
A reverse proxy in front of one product: none or nginx. |
services.proxy.nginx |
object | Settings for the nginx container. proxy: nginx alone uses the defaults. |
||
services.proxy.nginx.image |
string | nginx image. Default nginx:1.30-alpine. |
||
services.proxy.nginx.port |
integer | Host port the proxy listens on. Default 80, or 443 with tls: true. |
||
services.proxy.nginx.tls |
boolean | Serve HTTPS at the proxy, using quinectl's local certificate authority. Default false. |
||
services.proxy.nginx.target |
string | Which product the proxy fronts, quine or novelty. Defaults to quine when the file has a quine: block, otherwise novelty. |
||
services.metrics |
object | yes | none, prometheus-grafana |
Metrics dashboards: none or prometheus-grafana. |
services.metrics.prometheusGrafana |
object | Settings for Prometheus and Grafana. metrics: prometheus-grafana alone uses the defaults. |
||
services.metrics.prometheusGrafana.prometheusImage |
string | Prometheus image, for every project on the machine. Default prom/prometheus:v3.5.0. |
||
services.metrics.prometheusGrafana.prometheusPort |
integer | Host port for Prometheus, for every project on the machine. Default 9090. |
||
services.metrics.prometheusGrafana.grafanaImage |
string | Grafana image, for every project on the machine. Default grafana/grafana:11.5.2. |
||
services.metrics.prometheusGrafana.grafanaPort |
integer | Host port for Grafana, for every project on the machine. Default 3000. |
||
services.metrics.prometheusGrafana.memberBasePort |
integer | Port each member publishes metrics on; member N uses memberBasePort + N. Omit it and quinectl picks free ports for this project, from 11091. |
||
services.metrics.prometheusGrafana.scrapeInterval |
string | How often Prometheus collects this project's metrics. Default 15s. |
||
services.metrics.prometheusGrafana.scrapeTimeout |
string | How long one collection may take. Default 12s; must be less than scrapeInterval. |
||
services.metrics.prometheusGrafana.grafanaAnonymous |
boolean | Open Grafana without signing in, for every project on the machine. Default true. With false, sign in as admin / admin. |
||
services.metrics.prometheusGrafana.grafanaAnonymousRole |
string | Viewer, Editor, Admin |
What anonymous visitors may do in Grafana, for every project on the machine. Default Editor. |
|
services.metrics.prometheusGrafana.grafanaPublicUrl |
string | The address browsers use for Grafana, for every project on the machine. | ||
services.metrics.prometheusGrafana.dashboard |
string | Path to your own Quine dashboard JSON. Defaults to thatDot's dashboard. | ||
services.metrics.prometheusGrafana.noveltyDashboard |
string | Path to your own Novelty dashboard JSON. Defaults to thatDot's dashboard. | ||
services.metrics.prometheusGrafana.agentJar |
string | Path to your own Prometheus JMX exporter agent jar, with runtime: jar. Downloaded once when omitted. With runtime: docker, the product runs the agent in its image, but setting this field still skips the download, which matters on a machine without internet access. |
||
services.kafka |
object | yes | none, local |
A local Kafka broker: none or local. |
services.kafka.local |
object | Settings for the local Kafka broker. kafka: local alone uses the defaults. |
||
services.kafka.local.image |
string | Kafka image. Default confluentinc/cp-kafka:7.6.0. |
||
services.kafka.local.port |
integer | Host port for the broker; clients connect to 127.0.0.1:<port>. Default 9092. Shared by every project on the machine. |
||
services.kafka.local.namespace |
string | Prefix for this project's topics on the shared broker, so events becomes <namespace>.events. Letters, digits, _ and -. Empty by default. |
||
services.kafka.local.topics |
array of object | Topics to create, each with a name, and optionally partitions and seedFile. |
||
services.kafka.local.topics[].name |
string | Topic name. With a namespace, the broker's name is <namespace>.<name>. |
||
services.kafka.local.topics[].partitions |
integer | Number of partitions. Default 1. |
||
services.kafka.local.topics[].seedFile |
string | A CSV, JSON or JSON Lines file loaded into the topic once, and again if the file changes. A relative path is relative to quinectl.yaml. The file must exist: if it doesn't, every command that reads quinectl.yaml stops with an error naming the file. |