Launch Tool Options

Use the vkconfig script's launch tool to assign a name to a scheduler instance. It accepts the following arguments in addition to the Common vkconfig Script Options.

Option Description
--enable-ssl {true|false} (Optional) Enables SSL authentication

between Kafka and Vertica . For more information, refer to Using SSL with Kafka.
--ssl-ca-alias alias The user-defined alias of the root certifying authority you are using to authenticate communication between Vertica and Kafka. This parameter is used only when SSL is enabled.
--ssl-key-alias alias The user-defined alias of the key/certificate pair you are using to authenticate communication between Vertica and Kafka. This parameter is used only when SSL is enabled.
--ssl-key-password password The password used to create your SSL key. This parameter is used only when SSL is enabled.

--instance-name name

(Optional) Allows you to name the process running the scheduler. You can use this command when viewing the scheduler_history table, to find which instance is currently running.

--kafka_conf 'option=value[;option2=value2...]'

A semicolon-delimited list of option=value pairs to pass directly to the rdkafka library. This is the library Vertica uses to communicate with Kafka. You can use this parameter to directly set configuration options that are not available through the Vertica integration with Kafka. See Directly Setting Kafka Library Options for details.

Examples

This example shows how you can launch the scheduler defined in the myscheduler.conf config file and give it the instance name PrimaryScheduler:

$ /opt/vertica/packages/kafka/bin/vkconfig launch --instance-name PrimaryScheduler --conf myscheduler.conf

This example shows how you can launch an instance named SecureScheduler with SSL enabled:

$ /opt/vertica/packages/kafka/bin/vkconfig launch --instance-name SecureScheduler --enable-SSL true \
                                                  --ssl-ca-alias authenticcert --ssl-key-alias ourkey \
                                                  --ssl-key-password secret \
                                                  --conf myscheduler.conf