CLI Configuration
The tool uses the next folders by default
| Operating System | Config folder | Data folder |
|---|---|---|
| Linux / macOS | ~/.config/vvctl | ~/.local/share/vvctl |
| Windows | $HOME\AppData\Roaming\vvctl | $HOME\AppData\Local\vvctl |
The configuration file can be found in the file settings.json in your config folder.
You would only need to edit this file in case you have an special requirement,
otherwise the default values should just work fine.
This is an example of a configuration file settings.json
{
"session_path": "~/.local/share/vvctl/session",
"api_host": "https://app.ververica.cloud",
"default_flink_engine_version": "vera-1.0.6-flink-1.17",
"agent_version": "1.9.2-1",
"agent_charts": "oci://registry.ververica.cloud/agent-charts-stage/vv-agent",
"agent_name": "vv-agent"
}
where
| Property | Description |
|---|---|
session_path | File path to store the authentication session. You can leave the default value |
api_host | URl of you of the Ververica API. By default https://app.ververica.cloud. |
agent_* | Parameters for the BYOC agent installation. Leave the default values |
Using Environment variables
You can also set some environment variables, which will be used as the default value for some options if they are required.
| ENV Variable | Description |
|---|---|
VV_API_HOST | URL of the Ververica API to use |
VV_API_TOKEN | API token for authentication |
VV_EMAIL and VV_PASSWORD | Credentials, email and password, for authentication |
VV_WORKSPACE_ID | Default Workspace ID to use |
VV_NAMESPACE_ID | Default Namespace ID to use |
VV_CONFIG_DIR | Path to the folder containing the configuration files |
Authentication
vvctl supports two authentication methods:
- Email and password
- Authentication tokens
The authentication tokens will be stored in the file defined in the authentication file. Make sure only your user has access to this file.
If the authentication stored is not valid, the tool will ask for the credentials when executing any command if they are not setup in as environment variables.
You can always authenticate directly using the command vvctl login with your credentials or an API token.