You are browsing documentation for an outdated version. See the latest documentation here.

deck konnect sync

The Konnect sync command reads the state file and performs operations in Konnect to get Konnect’s state in sync with the input state.

Deprecation notice: The deck konnect command has been deprecated as of v1.12. Please use deck <cmd> instead if you would like to declaratively manage your Kong Gateway config with Konnect.

Syntax

deck konnect sync [command-specific flags] [global flags]

Flags

-h, --help

help for sync (Default: false)

--include-consumers

export consumers, associated credentials and any plugins associated with consumers. (Default: false)

--parallelism

Maximum number of concurrent operations. (Default: 100)

--silence-events

disable printing events to stdout (Default: false)

-s, --state

file(s) containing Konnect’s configuration. This flag can be specified multiple times for multiple files. (Default: [konnect.yaml])

Global flags

--analytics

Share anonymized data to help improve decK. Use --analytics=false to disable this. (Default: true)

--ca-cert

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

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

Config file (default is $HOME/.deck.yaml).

--headers

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.

--kong-addr

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-cookie-jar-path

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

Address of the Konnect endpoint. (Default: "https://us.api.konghq.com")

--konnect-email

Email address associated with your Konnect account.

--konnect-password

Password associated with your Konnect account, this takes precedence over --konnect-password-file flag.

--konnect-password-file

File containing the password to your Konnect account.

--no-color

Disable colorized output (Default: false)

--skip-workspace-crud

Skip API calls related to Workspaces (Kong Enterprise only). (Default: false)

--timeout

Set a request timeout for the client to connect with Kong (in seconds). (Default: 10)

--tls-client-cert

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

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

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

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

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. (Default: false)

--verbose

Enable verbose logging levels Setting this value to 2 outputs all HTTP requests/responses between decK and Kong. (Default: 0)

See also

• Deck Kong Gateway - Configuration tool for Konnect (in alpha)