Skip to content

Passing Settings Through

You can set a product option quinectl has no field for from quinectl.yaml, and quinectl still writes the rest of the product's configuration file for you. Use one of three pass-through fields in the product's block. They work the same under quine: and novelty:.

Field What it takes Where it ends up
properties Configuration keys and scalar values A block of its own in the generated configuration
configFile A configuration (HOCON) file you write Included at the start of the generated configuration
jvmProperties Java system property names and values -D flags on the product's launch command

properties

Keys use the product's own spelling, as in the Quine Enterprise configuration reference or the Novelty configuration reference. For example:

quinectl.yaml
quine:
  edition: enterprise
  licenseKey: ${QE_LICENSE_KEY}
  customerId: ${QE_CUSTOMER_ID}
  properties:
    quine.persistence.snapshot-after-events: 100
services:
  persistor: cassandra
  auth: keycloak
  proxy: none
  metrics: none
  kafka: none

Nested YAML is the same as dotted keys, so this is equivalent:

quinectl.yaml
quine:
  edition: enterprise
  licenseKey: ${QE_LICENSE_KEY}
  customerId: ${QE_CUSTOMER_ID}
  properties:
    quine:
      persistence:
        snapshot-after-events: 100
services:
  persistor: cassandra
  auth: keycloak
  proxy: none
  metrics: none
  kafka: none

Values that look like plain numbers or true/false are written as they are, even if you quote them in YAML; everything else is written as a quoted string. A value that is exactly ${NAME} is written as a reference for the product to resolve when it starts, so the value never reaches the file. quinectl passes the variable to the product, from its image or a jar. If the variable isn't set, up stops before starting anything, with an error naming the key and the variable.

configFile

For lists, nested objects, or a block copied from the product documentation, write a configuration file and point at it:

quinectl.yaml
quine:
  edition: enterprise
  licenseKey: ${QE_LICENSE_KEY}
  customerId: ${QE_CUSTOMER_ID}
  configFile: ./quine-extra.conf
services:
  persistor: cassandra
  auth: keycloak
  proxy: none
  metrics: none
  kafka: none

The path is relative to quinectl.yaml. quinectl includes the file as-is and never reads or changes it. Editing it restarts the product on the next up.

jvmProperties

Each entry becomes a -D flag on the product's launch command:

quinectl.yaml
quine:
  edition: enterprise
  licenseKey: ${QE_LICENSE_KEY}
  customerId: ${QE_CUSTOMER_ID}
  jvmProperties:
    some.system.property: value
services:
  persistor: cassandra
  auth: keycloak
  proxy: none
  metrics: none
  kafka: none

quinectl doesn't print the values: for a member running from an image, the launch command that -v prints shows each one as ***. They aren't hidden on the machine, though. docker inspect shows them for a member running from an image, and anyone who can list processes can see them for a member running from a jar.

jvmProperties is also how you point a product at a different license server, if thatDot issued your key for one: quine.license-server-uri for Quine Enterprise, thatdot.novelty.license-server-uri for Novelty. Without it, the products use thatDot's license server.

What you can't override

quinectl protects the settings that keep its configuration in step with the services it runs:

  • In properties and jvmProperties, the main keys quinectl writes itself are refused, with the field to set instead. That covers storage, cluster, web port and address, auth, metrics reporters, logging, the proxy address and the license key. For example, use quine.port, not quine.webserver.port, and licenseKey, not quine.license-key. quine.webserver.address has no field: under runtime: docker the product listens on 0.0.0.0.
  • A few other keys quinectl writes are accepted, and replace quinectl's value.
  • configFile is included first, so a key in it that quinectl also writes is silently overridden.

Any change to these fields restarts the product on the next up. The generated files in conf/ are rewritten on every run, so make every change in quinectl.yaml.

Next steps