The deck tool helps you manage Kong clusters with a declarative
configuration file.
It can be used to export, import, or sync entities to Kong.
Usage:
deck [command]
Available Commands:
ai Subcommand to host decK AI Gateway operations
completion Generate completion script
convert [deprecated] see 'deck file convert --help' for changes to the command
diff [deprecated] see 'deck gateway diff --help' for changes to the command
dump [deprecated] see 'deck gateway dump --help' for changes to the command
file Subcommand to host the decK file operations
gateway Subcommand to host the decK network operations
help Help about any command
konnect [deprecated] Configuration tool for Konnect
ping [deprecated] use 'deck gateway ping' instead
reset [deprecated] use 'deck gateway reset' instead
sync [deprecated] see 'deck gateway sync --help' for changes to the command
validate [deprecated] see 'deck [file|gateway] validate --help' for changes to the commands
version Print the decK version
Flags:
--analytics --analytics=false Share anonymized data to help improve decK.
Use --analytics=false to disable this. (default true)
--ca-cert --ca-cert-file Custom CA certificate (raw contents) to use to verify Kong's Admin TLS certificate.
This value can also be set using DECK_CA_CERT environment variable.
This takes precedence over --ca-cert-file flag.
--ca-cert-file string Path to a custom CA certificate to use to verify Kong's Admin TLS certificate.
This value can also be set using DECK_CA_CERT_FILE environment variable.
--config string Config file (default is $HOME/.deck.yaml).
--headers strings HTTP headers (key:value) to inject in all requests to Kong's Admin API.
This flag can be specified multiple times to inject multiple headers.
-h, --help help for deck
--kong-addr string HTTP address of Kong's Admin API.
This value can also be set using the environment variable DECK_KONG_ADDR
environment variable. (default "http://localhost:8001")
--kong-admin-token string Token to use for authentication with Kong's Admin API.
This value can also be set using DECK_KONG_ADMIN_TOKEN environment variable.
--kong-cookie-jar-path string Absolute path to a cookie-jar file in the Netscape cookie format for auth with Admin Server.
You may also need to pass in as header the User-Agent that was used to create the cookie-jar.
--konnect-addr string Address of the Konnect endpoint. (default "https://us.api.konghq.com")
--konnect-control-plane-name string Konnect Control Plane name.
--konnect-token --konnect-token-file Personal Access Token associated with your Konnect account, this takes precedence over --konnect-token-file flag.
--konnect-token-file string File containing the Personal Access Token to your Konnect account.
--no-color Disable colorized output
--skip-workspace-crud Skip API calls related to Workspaces (Kong Enterprise only).
--timeout int Set a request timeout for the client to connect with Kong (in seconds). (default 10)
--tls-client-cert string PEM-encoded TLS client certificate to use for authentication with Kong's Admin API.
This value can also be set using DECK_TLS_CLIENT_CERT environment variable. Must be used in conjunction with tls-client-key
--tls-client-cert-file string Path to the file containing TLS client certificate to use for authentication with Kong's Admin API.
This value can also be set using DECK_TLS_CLIENT_CERT_FILE environment variable. Must be used in conjunction with tls-client-key-file
--tls-client-key string PEM-encoded private key for the corresponding client certificate .
This value can also be set using DECK_TLS_CLIENT_KEY environment variable. Must be used in conjunction with tls-client-cert
--tls-client-key-file string Path to file containing the private key for the corresponding client certificate.
This value can also be set using DECK_TLS_CLIENT_KEY_FILE environment variable. Must be used in conjunction with tls-client-cert-file
--tls-server-name string Name to use to verify the hostname in Kong's Admin TLS certificate.
This value can also be set using DECK_TLS_SERVER_NAME environment variable.
--tls-skip-verify Disable verification of Kong's Admin TLS certificate.
This value can also be set using DECK_TLS_SKIP_VERIFY environment variable.
--verbose int Enable verbose logging levels
Sets the verbosity level of log output (higher is more verbose).
Use "deck [command] --help" for more information about a command.
Options (23)
| Option | Description | Source |
|---|---|---|
--analytics --analytics=false | Share anonymized data to help improve decK. | help |
--ca-cert --ca-cert-file | Custom CA certificate (raw contents) to use to verify Kong's Admin TLS certificate. | help |
--ca-cert-file string | Path to a custom CA certificate to use to verify Kong's Admin TLS certificate. | help |
--config string | Config file (default is $HOME/.deck.yaml). | help |
--headers strings | HTTP headers (key:value) to inject in all requests to Kong's Admin API. | help |
-h, --help | help for deck | help |
--kong-addr string | HTTP address of Kong's Admin API. | help |
--kong-admin-token string | Token to use for authentication with Kong's Admin API. | help |
--kong-cookie-jar-path string | Absolute path to a cookie-jar file in the Netscape cookie format for auth with Admin Server. | help |
--konnect-addr string | Address of the Konnect endpoint. | help |
--konnect-control-plane-name string | Konnect Control Plane name. | help |
--konnect-token --konnect-token-file | Personal Access Token associated with your Konnect account, this takes precedence over --konnect-token-file flag. | help |
--konnect-token-file string | File containing the Personal Access Token to your Konnect account. | help |
--no-color | Disable colorized output | help |
--skip-workspace-crud | Skip API calls related to Workspaces (Kong Enterprise only). | help |
--timeout int | Set a request timeout for the client to connect with Kong (in seconds). | help |
--tls-client-cert string | PEM-encoded TLS client certificate to use for authentication with Kong's Admin API. | help |
--tls-client-cert-file string | Path to the file containing TLS client certificate to use for authentication with Kong's Admin API. | help |
--tls-client-key string | PEM-encoded private key for the corresponding client certificate . | help |
--tls-client-key-file string | Path to file containing the private key for the corresponding client certificate. | help |
--tls-server-name string | Name to use to verify the hostname in Kong's Admin TLS certificate. | help |
--tls-skip-verify | Disable verification of Kong's Admin TLS certificate. | help |
--verbose int | Enable verbose logging levels Sets the verbosity level of log output (higher is more verbose). | help |