ansible-role-kafka-ui

Ansible role for installation, configuration, usage and management of Kafka UI, a web-based UI for managing Apache Kafka clusters. The UI is accessible after installation via `https://:8080` Official website: `https://github.com/provectus/kafka-ui`

Ansible role Kafka UI : Design | Examples | Test | Issues |
Latest version:

Actions:

Deployment	Administration
install uninstall update	configure start stop

Deployment

action: install
Installation of the latest Provectus Kafka UI version.
variables:
uninstall (optional) : Uninstall existing Kafka UI instance before installation.

- name: Install Kafka UI
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : install

action: uninstall
Uninstallation of Provectus Kafka UI.
variables:
(none) : No variables required.

- name: Uninstall Kafka UI
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : uninstall

Administration

action: start
Start of Kafka UI service. ROADMAP.
variables:
(none) : No variables required.

- name: Start Kafka UI service
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : start

action: stop
Stop of Kafka UI service. ROADMAP.
variables:
(none) : No variables required.

- name: Stop Kafka UI service
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : stop

action: configure
Reconfiguration of Kafka UI. ROADMAP.
variables:
(none) : No variables required.

- name: Configure Kafka UI service
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : configure

---

• changelog
  Change log. See changelog

• roadmap
  Vision and future developments. See roadmap

---

Preparations

(none).

Dependencies

Dependencies are listed in the requirements.yml file.
Use ansible-galaxy install ./requirements.yml --force for installation.
If this role is used in other playbooks or Ansible projects, the URL of this role must be added to the requirements.yml file. Using the above command, the role will be placed in the correct folder structure.

Installation and configuration

Installation via the action variable install. (Re-)configuration via the action variable configure.

When using this role in other playbooks or Ansible projects:

- name: Install and configure Kafka UI
  hosts: localhost
  roles:
   - role: kafka-ui
     vars:
       action : install

When used as a stand-alone Ansible project:

- name: Install and configure Kafka UI
  hosts: localhost
  tasks:

    - name: Install Kafka UI
      ansible.builtin.include_tasks:
        file: tasks/install.yml

Additional information

The UI is accessible via https://<servername/ip>:8080.

License

MIT

Author

Marcel Venema