Prerequisites for Installing Confluent Platform with Ansible Playbooks
General requirements
The following table summarizes version compatibility among Ansible Playbooks for Confluent Platform (Confluent Ansible) and other required components.
The Default Confluent Platform column specifies the default Confluent Platform version that the particular version of Confluent Ansible installs.
Default Confluent Platform |
Confluent Ansible |
Ansible and Python Versions |
|---|---|---|
7.9.10 |
7.9.10 [1] |
|
7.9.9 |
7.9.9 [1] |
|
7.9.8 |
7.9.8 [1] |
|
7.9.6 |
7.9.6 [1] |
|
7.9.5 |
7.9.5 [1] |
|
7.9.4 |
7.9.4 [1] |
|
7.9.3 |
7.9.3 [1] |
|
7.9.2 |
7.9.2 [1] |
|
7.9.1 |
7.9.1 [1] |
|
7.9.0 |
7.9.0 |
|
[1] Confluent Ansible supports the same versions of Confluent Control Center as corresponding Confluent Platform versions support.
The prerequisites for installing and using Confluent Ansible 7.9 are:
Ansible package 7.x+
We recommend installing the Ansible package instead of Ansible Core (ansible-core). Ansible Core contains a minimal number of modules and plugins, and you might have to manually install additional modules and plugin that Confluent Ansible requires.
For details on selecting an Ansible package and version to install, see Installing Ansible — Ansible Community Documentation.
SSH access between Ansible control nodes and Confluent Platform hosts
For the steps and the command to verify the SSH connections for all the hosts involved, see Prepare Ansible Inventory File to Install Confluent Platform.
sudoaccess for SSH user to all Confluent Platform hostsStarting in 7.1.0, Ansible Playbooks for Confluent Platform supports tag-based separation of tasks that require root permission from tasks that do not require root permission. You can run the latter tasks without root privileges. However, there are certain steps where you do need root access. For details, see Install Confluent Platform without root access.
(Optional) Internet connectivity to pull Confluent Platform software from
packages.confluent.io. If you don’t have internet access, refer to Deploy Confluent Platform in Air-Gapped Environment Using Ansible Playbooks for deploying in an air-gapped environment.For detailed version requirements for the controller node, the managed node, and Python, see Ansible Support Matrix.
Supported Confluent Platform versions
It is highly recommended that you use the version of Confluent Ansible as referred in the above table in accordance with the Confluent Platform version.
Warning
Before you upgrade to Confluent Ansible 7.6.14, 7.7.12, 7.8.11, 7.9.10,
8.0.8, 8.1.6, 8.2.4, 8.3.2, or 8.4.0, add confluent_package_version
to your inventory and set it to the Confluent Platform version you want to install.
For the supported version pairs, see the preceding compatibility table.
These versions no longer ship a hard-coded default Confluent Platform version, and the
playbook fails early if the variable is not set.
Hardware
Starting in the 7.6.0 release, Confluent Ansible supports the X86 and ARM64 hardware architecture for the production workloads.
For more information about hardware support, see the on-premises system requirements for Confluent Platform components.
Operating systems
Confluent Ansible supports the operating systems listed in the Confluent Platform System Requirements, except for those marked as deprecated.
Network
Internet protocols
You can use Confluent Ansible to deploy Confluent Platform on machines on an IPv6 network, an IPv4 network, or dual-stack with both IPv4 and IPv6.
IPv6 or dual stack support is subject to the following constraints:
It can be enabled only on clusters using Java 11 or above.
It can be enabled only on clusters using KRaft.
Ports
Refer to the ports used by Confluent Platform components.
Users
Each Confluent Platform component runs under its own user set up during installation. The
usernames are prefixed with cp- followed by the component name. For example,
cp-kafka and cp-schema-registry.
The one exception is that ZooKeeper and KRaft run as the cp-kafka user.
Time synchronization
Clock synchronization on each Kafka broker is required to ensure the full system functions correctly. See Time synchronization requirement for details.
Locale
The en_US.UTF-8 locale is required for installing Confluent Platform using Confluent Ansible.