> For the complete documentation index, see [llms.txt](https://docs.lenses.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lenses.io/latest/devx/5.5/deployment/installation/automation.md).

# Automating Connections

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

{% hint style="warning" %}
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
   {% endhint %}

## Provisioning

{% hint style="danger" %}
If provisioning is enabled, any changes in the UI will be overriden.
{% endhint %}

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:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>File Watcher provisioning</strong></td><td>Provisioning with a YAML file, with Lenses watching for changes in the file.</td><td><a href="/latest/devx/5.5/deployment/installation/automation/file-watcher-provisioning.md">File Watcher Provisioning</a></td></tr><tr><td><strong>API Based provisioning</strong></td><td>Using APIs to load the provisioning YAML files.</td><td><a href="/latest/devx/5.5/deployment/installation/automation/api-provisioning.md">API Provisioning</a></td></tr></tbody></table>

{% hint style="success" %}
Both approaches use a YAML file to define connections.
{% endhint %}

## Defining a Connection

Connections are defined in the\*\*`provisioning.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](/latest/devx/5.5/deployment/installation/automation/provisioning-api-reference.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lenses.io/latest/devx/5.5/deployment/installation/automation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.