quinectl¶
quinectl runs Quine Enterprise, Novelty, or both on your own machine, together with the services
they need, from one file: quinectl.yaml. You can try auth and RBAC with sample users, run a local
cluster, load data from Kafka, or watch the products in Grafana without writing a product configuration
yourself. quinectl starts the services, writes each product's configuration to match them, and launches
the products.
quinectl is for Quine Enterprise and Novelty license holders, and you download it with the same customer id and license key that pull the product images.
These two commands write a starting quinectl.yaml and start Quine Enterprise with Cassandra and
Keycloak. They need your license key and customer id exported; the Quick Start walks
through them:
quinectl init
quinectl up
quinectl is for local development, evaluation and demos, not production
quinectl is built for trying the products out, developing against them, and running demos on one machine. It uses a local certificate authority it creates itself, sample users with published passwords, and a Grafana anyone who can reach its port can open and edit without signing in. To share a demo with your team, see Deploy to EC2.
For production deployments, take the Kubernetes Deployment Tour, an animated walk through a complete Quine Enterprise deployment on Kubernetes. Then see Kubernetes with Helm and Terraform on AWS.
What it runs¶
Everything runs in Docker on your machine, unless you run a product from its jar. You choose each piece
in quinectl.yaml. A member is one running copy of a product, and a cluster has several:
| Piece | Choices | What you get |
|---|---|---|
| Products | Quine Enterprise, Novelty, or both | Each product's web UI and REST API on its own port |
| Graph storage | Cassandra, RocksDB, or in-memory | A local Cassandra container by default, one keyspace per product |
| Auth | None, or Keycloak | A local Keycloak with the product roles and one sample user per role |
| Reverse proxy | None, or nginx | One URL in front of a product, optionally with HTTPS |
| Metrics | None, or Prometheus and Grafana | Prometheus collecting from every member, Grafana with thatDot's dashboards |
| Kafka | None, or a local broker | A single-node broker with your topics created, and optionally loaded from a file |
| Cluster | One member, or several plus hot spares | Several members sharing one graph, plus hot spares that stand by |
quinectl can also run Quine OSS, which needs no license key.
How it works¶
- One file decides what runs.
quinectl.yamldescribes what you want. Runquinectl upafter a change, and quinectl starts what is missing, reuses what is already running and matching, and restarts a product whose configuration changed.updoesn't stop what you remove from the file; see How changes take effect. - A directory is a project. quinectl reads
quinectl.yamlfrom the current directory and writes the product configuration and logs beside it. Several project directories can share one Cassandra, Keycloak and Kafka. Give each its own port, keyspace, realm and Kafka namespace. Directories left on the default names share one graph, realm and topics, anduponly warns; see Multi-tenancy. - Your license stays out of quinectl's files. Your license key is read from the environment and handed to the product at launch, and quinectl doesn't write it to any file it creates. It isn't hidden on the machine: anyone with access to your Docker engine can read it from the running container, and a product run from its jar has the key on its command line.
- It leaves alone what it didn't create. quinectl doesn't stop or remove a container it didn't start.
If
quinectl downfinds a Quine process it didn't start, it reports it and leaves it running, unless you pass--orphans.
Next steps¶
| Page | What it covers |
|---|---|
| Get quinectl | Download quinectl with your license and put it on your PATH |
| Quick Start | Run Quine Enterprise with auth and call its REST API |
| Configure quinectl | The parts of quinectl.yaml and how changes take effect |
| Guides | One guide per service, product and way of working |
| Command Reference | Every command and flag |
| quinectl.yaml Reference | Every configuration field |
| Troubleshooting | What an error means and what to do about it |