Quick CLI¶
Commands¶
quick
¶
Control your Quick deployment
Usage:
quick [-h] command [options ...] ...
context
: Manage quick configurationtopic
: Manage topicsgateway
: Manage gatewaysmirror
: Manage mirrorsapp
: Manage streams applications
quick context
¶
Manage quick configuration
Usage:
quick context [-h] command [options ...] ...
create
: Create a new contextdescribe
: Display a context configurationlist
: List all context configurationsactivate
: Activate context
quick context create
¶
Create a new context
Usage:
quick context create [-h] [--host HOST] [--key API-KEY] [--context CONTEXT] [--debug]
--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]
--context
: Select context (defaults to current one)--debug
: Enable debug output
quick context list
¶
List all context configurations
Usage:
quick context list [-h] [--debug]
--debug
: Enable debug output
quick context activate
¶
Activate context
Usage:
quick context activate [-h] [--debug] NAME
name
: Name of the context to activate
Optional:
--debug
: Enable debug output
quick topic
¶
Manage topics
Usage:
quick topic [-h] command [options ...] ...
create
: Create a new topicdelete
: Delete a topiclist
: List all topicsdescribe
: 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]
[--context CONTEXT] [--debug]
NAME
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)--context
: Context of quick--debug
: Enable debug output
quick topic delete
¶
Delete a topic
Usage:
quick topic delete [-h] [--context CONTEXT] [--debug] TOPIC
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]
--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
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 ...] ...
create
: Create a gatewaydelete
: Delete a gatewayapply
: Apply a new schema to a gatewaylist
: List all gatewaysdescribe
: Display information about a gateway
quick gateway create
¶
Create a gateway
Usage:
quick gateway create [-h] [--replicas REPLICAS] [--tag TAG] [--context CONTEXT] [--debug] NAME
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
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
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]
--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
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 ...] ...
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] [--context CONTEXT] [--debug] TOPIC
topic
: Topic to mirror
Optional:
--tag
: Docker image tag (defaults to currently installed tag)--replicas
: Number of replicas (default: 1)--context
: Context of quick--debug
: Enable debug output
quick mirror delete
¶
Delete a mirror
Usage:
quick mirror delete [-h] [--context CONTEXT] [--debug] TOPIC
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 ...] ...
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 [--replicas REPLICAS]
[--args [ARG=VALUE [ARG=VALUE ...]]] [--context CONTEXT] [--debug]
NAME
name
: Name of the application (must be unique)--registry
: URL to container registry--image
: Name of the image--tag
: Docker image tag
Optional:
--replicas
: Number of replicas--args
: CLI arguments of the application (broker and schema registry not required)--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
name
: Name of the application
Optional:
--context
: Context of quick--debug
: Enable debug output