Automating Connections

This page describes automating (provisioning) connections and channels for Lenses at installation and how to apply updates.

On start-up, Lenses will be in bootstrap mode unless it has an existing Kafka Connection.

To fully start Lenses you need two key pieces of information to start and perform basic functions:

1. Kafka Connection

2. Valid License

Provisioning

If provisioning is enabled, any changes in the UI will be overriden.

A dedicated API, called provisioning, is available to handle bootstrapping key connections at installation time. This allows you to fully install and configure key connections such as Kafka, Schema Registry, Kafka Connect, and Zookeepers in one go. You can use either of the following approaches depending on your needs:

File Watcher provisioning

Provisioning with a YAML file, with Lenses watching for changes in the file.

API Based provisioning

Using APIs to load the provisioning YAML files.

Both approaches use a YAML file to define connections.

Defining a Connection

Connections are defined in theprovisioning.yaml. This file is divided into components, each component representing a type of connection.

Each component must have:

1. Name - This is the free name of the connection

2. Version set to 1

3. Optional tags

4. Configuration - This is a list of keys/values and is dependent on the component type.

For a full list of configuration options for the connect see Provisioning API Spec.