Skip to content

Latest commit

 

History

History
68 lines (38 loc) · 2.51 KB

README.md

File metadata and controls

68 lines (38 loc) · 2.51 KB
Raw

CP-Ansible

Description

Ansible provides a simple way to deploy, manage, and configure the Confluent Platform services. This repository provides playbooks and templates to easily spin up a Confluent Platform installation. Specifically this repository:

  • Installs Confluent Platform packages or archive.
  • Starts services using systemd scripts.
  • Provides configuration options for many security options including encryption, authentication, and authorization.

The services that can be installed from this repository are:

  • ZooKeeper
  • Kraft Controller (or Kafka Controller)
  • Kafka
  • Schema Registry
  • REST Proxy
  • Confluent Control Center
  • Kafka Connect (distributed mode)
  • KSQL Server
  • Replicator

Requirements

Prerequisites for installing CP can be found at https://docs.confluent.io/ansible/current/ansible-requirements.html#general-requirements.

Installation

You can install this collection from Ansible Automation Hub and Ansible Galaxy by following https://docs.confluent.io/ansible/current/ansible-download.html.

As an alternative to the recommended methods above, you can install the package directly from the source repository.

  • Create a directory with the following structure:
    mkdir -p <path_to_cp-ansible>/ansible_collections/confluent/

    You can put <path_to_cp-ansible> anywhere in your directory structure, but the directory structure under <path_to_cp-ansible> should be set up exactly as specified above.

  • Clone the Ansible Playbooks for Confluent Platform repo into the platform directory inside the directory you created in the previous step:
    git clone https://github.com/confluentinc/cp-ansible <path_to_cp-ansible>/ansible_collections/confluent/platform

Use Cases

Ansible Playbooks for Confluent Platform (Confluent Ansible) offers a simplified way to configure and deploy Confluent Platform.

Testing

CP-Ansible's tests use the Molecule framework, and it is strongly advised to test this way before submitting a Pull Request. Please refer to the HOW_TO_TEST.md

Contributing

If you would like to contribute to the CP-Ansible project, please refer to the CONTRIBUTE.md

Support

For any support request, please reach out to Confluent Support Portal.

Release Notes

This page summarizes the technical details of the Confluent releases.

License

Apache 2.0