darwin-arm64
).
console
authentication mode (CDK_AUTH_MODE
is console
or empty).
Alternatively, you can use the external authentication mode to bypass token generation and use credentials from your identity provider or the API proxy instead. For that, set the CDK_AUTH_MODE
environment variable to external
:
Environment variables | Description |
---|---|
Console | |
CDK_BASE_URL | Console base URL, e.g. http://localhost:8080 |
CDK_API_KEY | Console API key (admin or application key) |
CDK_USER | Console local or LDAP user username |
CDK_PASSWORD | Console local or LDAP user password |
CDK_AUTH_MODE | Authentication mode (external , console or empty (default)) |
Gateway | |
CDK_GATEWAY_BASE_URL | Gateway base URL, e.g. http://localhost:8888 |
CDK_GATEWAY_USER | Gateway user login email |
CDK_GATEWAY_PASSWORD | Gateway user login password |
TLS & mTLS | |
CDK_CACERT | Root CA certificate to verify the Conduktor Console certificate (.pem) |
CDK_INSECURE | Skip the TLS verification of the Conduktor Console. Defaults to false . |
CDK_CERT | Certificate to authenticate the CLI (.pem) |
CDK_KEY | Key to authenticate the CLI (.pem) |
apply
command allows you to deploy any resource.
--parallelism
flag allows you to run multiple applies at the same time, in parallel. This is useful when applying a large number of resources. Be careful not to set it too high, as it may overload the Console/Gateway API.template
command allows you to get an example of a resource definition:
delete
command allows you to delete a resource. It works the same way as the apply
.
get
command allows you to retrieve resources. You can specify a kind, a name, or list all the resources.
token
command to manage your API keys.
run
command allows you to run a few actions:
--dry-run
flag, generating a report confirming that the resources can be successfully created or modified.main
branch, making the changes live.${ENV_VAR}
patterns. This keeps sensitive data like credentials out of configuration files.
You can set a default value using POSIX notation ${ENV:-default}
.
By default, the CLI fails if an environment variable is undefined or empty, ensuring all required variables are properly configured.
Use the --permissive
flag to replace missing or empty variables with empty strings instead of failing.
The example below shows a Conduktor cluster configuration with credentials secured using environment variables: