Common vkconfig Script Options
These options are available across the different tools available in the vkconfig script.
| Option | Description |
|---|---|
--config-schema schema_name |
The name of the scheduler's Vertica schema. This value is the same as the name of the scheduler. You use this name to identify the scheduler during configuration. Default Value: stream_config |
--help
|
Prints out a help menu listing available options with a description. |
--version
|
Displays the version number of the scheduler. |
--dbhost host name |
The host name or IP address of the Vertica node acting as the initiator node for the scheduler. Default Value: localhost |
--dbport port_number
|
The port to use to connect to a Vertica database. Default Value: 5433 |
--username username |
The Vertica database user used to alter the configuration of the scheduler. This use must have create privileges on the scheduler's schema. Default Value: Current user |
--password password |
Password for the database user. |
--jdbc-url url |
A complete JDBC URL that vkconfig uses instead of standard JDBC URL string to connect to Vertica. |
--jdbc-opt option=value[&option2=value2...] |
One or more options to add to the standard JDBC URL that vkconfig uses to connect to Vertica. Cannot be combined with --jdbc-url. |
--conf filename |
A text file containing configuration options for the vkconfig script. See Configuration File Format below. |
--create
|
Creates a new instance of the supplied type. |
--update
|
Updates an existing instance of the supplied type. |
--delete
|
Delete an instance of the supplied type. |
--enable-ssl
|
Enables the vkconfig script to use SSL to connect to Vertica or between Vertica and Kafka. See Configuring Your Scheduler for SSL for more information. |
--ssl-ca-alias alias_name |
The alias of the root certificate authority in the trust store. Must be set when Vertica uses SSL to connect to Kafka. |
--ssl-key-alias alias_name |
The alias of the key and certificate pairs within the key store. Must be set when Vertica uses SSL to connect to Kafka. |
--ssl-key-password password |
The password for the SSL key. Must be set when Vertica uses SSL to connect to Kafka. Caution: Specifying this option on the command line can expose it to other users logged into the host. Always use a configuration file to set this option. |
Configuration File Format
You can use a configuration file to store common parameters you use in your calls to the vkconfig utility. The configuration file is a text file containing one option setting per line in the format:
option=value
You can also include comments in the option file by prefixing them with a hash mark (#).
#config.properties: username=myuser password=mypassword dbhost=localhost dbport=5433
You tell vkconfig to use the configuration file using the --conf option:
$ /opt/vertica/packages/kafka/bin/vkconfig source --update --conf config.properties
You can override any stored parameter from the command line:
$ /opt/vertica/packages/kafka/bin/vkconfig source --update --conf config.properties --dbhost otherVerticaHost
Examples
These examples show how you can use the shared utility options.
Display help for the scheduler utility:
$ /opt/vertica/packages/kafka/bin/vkconfig scheduler --help
This command configures a Scheduler, which can run and load data from configured
sources and clusters into Vertica tables. It provides options for changing the
'frame duration' (time given per set of batches to resolve), as well as the
dedicated Vertica resource pool the Scheduler will use while running.
Available Options:
PARAMETER REQUIRED #ARGS DESCRIPTION
conf no 1 Allow the use of a properties file to
associate parameter keys and values.
This file enables command string reuse
and cleaner command strings.
help no 0 Outputs a help context for the given
subutility.
version no 0 Outputs the current Version of the
scheduer.
skip-validation no 0 [Depricated] Use --validation-type.
validation-type no 1 Determine what happens when there are
configuration errors. Accepts: ERROR
- errors out, WARN - prints out a
message and continues, SKIP - skip
running validations
dbhost no 1 The Vertica database hostname that
contains metadata and configuration
information. The default value is
'localhost'.
dbport no 1 The port at the hostname to connect
to the Vertica database. The default
value is '5433'.
username no 1 The user to connect to Vertica.
The default value is the current system
user.
password no 1 The password for the user connecting
to Vertica. The default value is empty.
jdbc-url no 1 A JDBC URL that can override Vertica
connection parameters and provide
additional JDBC options.
jdbc-opt no 1 Options to add to the JDBC URL used to
connect to Vertica ('&'-separated
key=value list). Used with generated
URL (i.e. not with '--jdbc-url' set).
enable-ssl no 1 Enable SSL between JDBC and Vertica
and/or Vertica and Kafka.
ssl-ca-alias no 1 The alias of the root CA within the
provided trust store used when
connecting between Vertica and Kafka.
ssl-key-alias no 1 The alias of the key and certificate
pair within the provided key store
used when connecting between Vertica
and Kafka.
ssl-key-password no 1 The password for the key used when
connecting between Vertica and Kafka.
Should be hidden with file access
(see --conf).
config-schema no 1 The schema containing the configuration
details to be used, created or edited.
This parameter defines the scheduler.
The default value is 'stream_config'.
create no 0 Create a new instance of the supplied
type.
update no 0 Update an instance of the supplied
type.
delete no 0 Delete an instance of the supplied
type.
drop no 0 Drops the specified configuration
schema. CAUTION: this command will
completely delete and remove all
configuration and monitoring data for
the specified scheduler.
operator no 1 Specifies a user designated as an
operator for the created configuration.
Used with --create.
add-operator no 1 Add a user designated as an operator
for the specified configuration. Used
with --update.
remove-operator no 1 Removes a user designated as an operator
for the specified configuration. Used
with --update.
upgrade no 0 Upgrade the current scheduler
configuration schema to the current version
of this scheduler. WARNING: if upgrading
between EXCAVATOR and FRONTLOADER be aware
that the Scheduler is not backwards
compatible. The upgrade procedure will
translate your kafka model into the new
stream model.
upgrade-to-schema no 1 Used with upgrade: will upgrade the
configuration to a new given schema instead
of upgrading within the same schema.
fix-config no 0 Attempts to fix the configuration (ex:
dropped tables) before doing any other
updates. Used with --update.
frame-duration no 1 The duration of the Scheduler's frame,
in which every configured Microbatch
runs. Default is 10 seconds: '00:00:10'
resource-pool no 1 The Vertica resource pool to run the
Scheduler on. Default is
'kafka_default_pool'.
config-refresh no 1 The interval of time between Scheduler
configuration refreshes. Default is
5 minutes: '00:05'
new-source-policy no 1 The policy for new Sources to be
scheduled during a frame. Options are:
START, END, and FAIR. Default is 'FAIR'.
eof-timeout-ms no 1 The duration in milliseconds that any
Microbatch waits for additional data
before considering itself at end of
stream.
pushback-policy no 1
pushback-max-count no 1
auto-sync no 1 Automatically update configuration
based on metadata from the Kafka
cluster
