Welcome to Kafka Topology Builder’s documentation!¶
Welcome to the Kafka Topology Builder documentation, in this site we recollected notes and guides to provide the beginners, but as well reference for the most experienced on implementing a gitops approach for operations in Apache Kafka.
Getting started¶
If you have landed in this page is because you aim to get started with the Kafka Topology Builder. To get you started we recommend:
- Want a quickstart ? checkout our demo in https://github.com/purbon/kafka-topology-builder-demo.
- New to gitops and kafka, check the Core Concepts page.
- If you are ready to jump in, start with the How to setup a full workflow (by example).
Installation¶
To install the Kafka Topology Builder and enable your teams to use a gitops approach when managing Apache Kafka you need:
- A CI/CD server, for example Jenkins, but any other will serve the purpose
- A git repository where the Topology description will be stored
- And for sure a Kafka cluster :-)
See the How to setup a full workflow (by example) section to learn more how to setup the required components to enable the full workflow.
if you already have this components, you can install the topology builder agent:
- As an RPM package for RedHat/CentOS linux distributions.
- As a DEB package for Debian based OS.
- As tar.gz source package.
- As well in the form of a docker image, available from docker hub.
You always can self build this package, all information is available from here. Users can download the latest “official” release artifacts directly from the download page here.
Help?¶
If case you require any help regarding the usage or development of the Kafka Topology Builder, don’t hesitate to contact our gitter community. In the future, when there is the request we might as well create a mailing list or other method of communication that help people using this project.
Contents¶
- Core Concepts
- What can you do with Kafka Topology Builder
- Understanding the descriptor files
- How can you run Kafka Topology Builder
- Handling delete in the Kafka Topology Builder
- How to setup a full workflow (by example)
- A collection of Kafka Topology Demos
- Important configuration values
- Access control configuration
- RBAC configuration
- Schema Management
- Topology Builder backend usage and selection
- Customize the topic naming convention
- Optimised number of ACLs and RBAC bindings
- Internal topics prefixes
- Topology level validations
- Prevent ACL for topic creation for connector principal
- Retrieve topic management state from local controlled view
- Control allowed Service accounts to be managed by KTB