:_mod-docs-content-type: ASSEMBLY

// Module included in the following assemblies:
//
// master.adoc

[id='assembly-deploying-{context}']
= Deploying the console

[role="_abstract"]
Deploy the console using the dedicated operator.
After installing the operator, you can create instances of the console. 

For each console instance, the operator needs a Prometheus instance to collect and display Kafka cluster metrics. 
You can configure the console to use an existing Prometheus source.
If no source is set, the operator creates a private Prometheus instance when the console is deployed. 
However, this default setup is not recommended for production and should only be used for development or evaluation purposes.

Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and groups used by Kafka client applications to coordinate work.

Configure the console to integrate with related services, including:

* **Authentication providers** to secure access to Kafka clusters
* **Kafka Connect clusters** to view connector and configuration details
* **Metrics providers** to monitor Kafka cluster performance
* **Schema registries** to validate and decode messages using data schemas

Define these integrations in the `Console` custom resource configuration YAML file.

//Prereqs, including example Kafka install 
include::../modules/deploying/con-deploying-prereqs.adoc[leveloffset=+1]
include::../modules/deploying/proc-deploying-kafka.adoc[leveloffset=+2]
//instructions to deploy the operator
include::../assemblies/assembly-deploying-operator.adoc[leveloffset=+1]
include::../modules/deploying/proc-deploying-operator-crd.adoc[leveloffset=+2]
// TODO: Enable this when the Operator is submitted to the OperatorHub. See https://github.com/streamshub/console/issues/1526
//include::../modules/deploying/proc-deploying-operator-olm-cli.adoc[leveloffset=+2]
//include::../modules/deploying/proc-deploying-operator-olm-ui.adoc[leveloffset=+2]
//Using the operator to deploy the console
include::../modules/deploying/proc-connecting-console.adoc[leveloffset=+1]
//virtual kafka clusters
include::../modules/deploying/ref-virtual-kafka-clusters.adoc[leveloffset=+2]
//cluster connection authentication options
include::../modules/deploying/ref-authentication-options.adoc[leveloffset=+2]
//kafka connect 
include::../modules/deploying/ref-kafka-connect-clusters.adoc[leveloffset=+2]
//cluster metrics options
include::../modules/deploying/ref-metrics-options.adoc[leveloffset=+2]
//cluster schema registry options
include::../modules/deploying/ref-schema-registries.adoc[leveloffset=+2]