Quick CLI

Commands

quick

Control your Quick deployment

Usage:

quick [-h] command [options ...] ...

Available commands:

• context: Manage quick configuration
• topic: Manage topics
• gateway: Manage gateways
• mirror: Manage mirrors
• app: Manage streams applications

---

quick context

Manage quick configuration

Usage:

quick context [-h] command [options ...] ...

Available commands:

• create: Create a new context
• describe: Display a context configuration
• list: List all context configurations
• activate: Activate context

quick context create

Create a new context

Usage:

quick context create [-h] [--host HOST] [--key API-KEY] [--context CONTEXT] [--debug]

Optional:

• --host: Name of the host (prompted if not given)
• --key: API key of this quick instance (prompted if not given)
• --context: Name of the context (defaults to host)
• --debug: Enable debug output

quick context describe

Display a context configuration

Usage:

quick context describe [-h] [--context CONTEXT] [--debug]

Optional:

• --context: Select context (defaults to current one)
• --debug: Enable debug output

quick context list

List all context configurations

Usage:

quick context list [-h] [--debug]

Optional:

• --debug: Enable debug output

quick context activate

Activate context

Usage:

quick context activate [-h] [--debug] NAME

Required:

• name: Name of the context to activate

Optional:

• --debug: Enable debug output

---

quick topic

Manage topics

Usage:

quick topic [-h] command [options ...] ...

Available commands:

• create: Create a new topic
• delete: Delete a topic
• list: List all topics
• describe: Display information for a topic

quick topic create

Create a new topic

Usage:

quick topic create [-h] -k TYPE -v TYPE [-s SCHEMA] [--immutable] [--retention-time RETENTION_TIME]
                          [--range-field RANGE_FIELD] [--context CONTEXT] [--debug]
                          NAME

Required:

• name: The name of the topic
• -k, --key-type: The key type of the topic
• -v, --value-type: The value type of the topic

Optional:

• -s, --schema: The location of the schema file or std in
• --immutable: An immutable topic does not allow ingesting the same key twice (default: False)
• --retention-time: Retention time of data in the topic in (if not given, the data is kept indefinitely)
• --range-field: The field name, which the range index should be built on
• --context: Context of quick
• --debug: Enable debug output

quick topic delete

Delete a topic

Usage:

quick topic delete [-h] [--context CONTEXT] [--debug] TOPIC

Required:

• topic: Topic to delete

Optional:

• --context: Context of quick
• --debug: Enable debug output

quick topic list

List all topics

Usage:

quick topic list [-h] [--context CONTEXT] [--debug]

Optional:

• --context: Context of quick
• --debug: Enable debug output

quick topic describe

Display information for a topic

Usage:

quick topic describe [-h] [--context CONTEXT] [--debug] NAME

Required:

• name: The name of the topic.

Optional:

• --context: Context of quick
• --debug: Enable debug output

---

quick gateway

Manage gateways

Usage:

quick gateway [-h] command [options ...] ...

Available commands:

• create: Create a gateway
• delete: Delete a gateway
• apply: Apply a new schema to a gateway
• list: List all gateways
• describe: Display information about a gateway

quick gateway create

Create a gateway

Usage:

quick gateway create [-h] [--replicas REPLICAS] [--tag TAG] [--context CONTEXT] [--debug] NAME

Required:

• gateway_name: Name of the gateway

Optional:

• --replicas: Number of replicas
• --tag: Docker image tag (defaults to currently installed tag)
• --context: Context of quick
• --debug: Enable debug output

quick gateway delete

Delete a gateway

Usage:

quick gateway delete [-h] [--context CONTEXT] [--debug] NAME

Required:

• gateway_name: Name of the gateway

Optional:

• --context: Context of quick
• --debug: Enable debug output

quick gateway apply

Apply a new schema to a gateway

Usage:

quick gateway apply [-h] -f FILE [--context CONTEXT] [--debug] NAME

Required:

• gateway: Name of the gateway
• -f, --file: Location of the schema file or std in

Optional:

• --context: Context of quick
• --debug: Enable debug output

quick gateway list

List all gateways

Usage:

quick gateway list [-h] [--context CONTEXT] [--debug]

Optional:

• --context: Context of quick
• --debug: Enable debug output

quick gateway describe

Display information about a gateway

Usage:

quick gateway describe [-h] [--context CONTEXT] [--debug] NAME

Required:

• name: The name of the gateway.

Optional:

• --context: Context of quick
• --debug: Enable debug output

---

quick mirror

Mirrors make topics queryable. With these commands, you can control which topic can be queried through gateway.

Usage:

quick mirror [-h] command [options ...] ...

Available commands:

• create: Mirror a Kafka topic
• delete: Delete a mirror

quick mirror create

Create a mirror for a topic and make it queryable through a gateway

Usage:

quick mirror create [-h] [--tag TAG] [--replicas REPLICAS] [--range-field RANGE_FIELD] [--context CONTEXT]
                           [--debug]
                           TOPIC

Required:

• topic: Topic to mirror

Optional:

• --tag: Docker image tag (defaults to currently installed tag)
• --replicas: Number of replicas (default: 1)
• --range-field: The field name, which the range index should be built on
• --context: Context of quick
• --debug: Enable debug output

quick mirror delete

Delete a mirror

Usage:

quick mirror delete [-h] [--context CONTEXT] [--debug] TOPIC

Required:

• mirror: Topic to delete mirror from

Optional:

• --context: Context of quick
• --debug: Enable debug output

---

quick app

Streams applications are Kafka Streams applications processing your data stream. You can deploy them to the quick cluster.

Usage:

quick app [-h] command [options ...] ...

Available commands:

• deploy: Deploy a new application
• delete: Delete an application

quick app deploy

Deploy a new application. The application must be provided as a Docker image. You can specify the registry.

Usage:

quick app deploy [-h] --registry REGISTRY_URL --image IMAGE --tag TAG [--image-pull-secret IMAGE_PULL_SECRET]
                        [--replicas REPLICAS] [--args [ARG=VALUE ...]] [--port PORT] [--context CONTEXT] [--debug]
                        NAME

Required:

• name: Name of the application (must be unique)
• --registry: URL to container registry
• --image: Name of the image
• --tag: Docker image tag

Optional:

• --image-pull-secret: A secret in a string format for pulling an image from a private registry
• --replicas: Number of replicas
• --args: CLI arguments of the application (broker and schema registry not required)
• --port: The container port of the application
• --context: Context of quick
• --debug: Enable debug output

quick app delete

Delete an application. This stops the running Streams application and removes all its state.

Usage:

quick app delete [-h] [--context CONTEXT] [--debug] name

Required:

• name: Name of the application

Optional:

• --context: Context of quick
• --debug: Enable debug output