Skip to content

vepo/project-maestro

Repository files navigation

Project Maestro

Project Maestro is a comprehensive tool designed to manage Apache Kafka deployments and simplify the creation of Kafka consumers and producers. It aims to streamline Kafka operations and enhance productivity for developers and administrators.

Objectives

  1. Manage Apache Kafka Deployment: Simplify the deployment and management of Apache Kafka clusters.
  2. Easy Kafka Consumer and Producer Creation: Provide an intuitive interface for creating and managing Kafka consumers and producers.

Features

  • Cluster Management: Easily deploy, monitor, and manage Kafka clusters.
  • Consumer and Producer Management: Create, configure, and manage Kafka consumers and producers with minimal effort.
  • Topic Management: Create, delete, and manage Kafka topics.
  • Monitoring and Alerts: Monitor Kafka cluster health and set up alerts for critical events.
  • Security: Implement security best practices for Kafka, including SSL/TLS encryption and authentication.

Getting Started

Prerequisites

  • Java 11 or higher
  • Apache Kafka 2.8.0 or higher
  • Maven 3.6.0 or higher

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/project-maestro.git
    cd project-maestro
  2. Build the project:

    mvn clean install
  3. Run the application:

    java -jar target/maestro-1.0.0.jar

Configuration

Project Maestro requires a configuration file to connect to your Kafka cluster. Create a config.properties file in the root directory with the following content:

kafka.bootstrap.server=localhost:9092
kafka.security.protocol=SSL
kafka.ssl.truststore.location=/path/to/truststore.jks
kafka.ssl.truststore.password=yourpassword
kafka.ssl.keystore.location=/path/to/keystore.jks
kafka.ssl.keystore.password=yourpassword
kafka.ssl.key.password=yourpassword

Usage

  1. Access the Web Interface: Open your browser and navigate to http://localhost:8080.
  2. Manage Clusters: Use the interface to add, remove, and monitor Kafka clusters.
  3. Create Consumers and Producers: Navigate to the Consumers or Producers section to create and manage Kafka consumers and producers.

Contributing

We welcome contributions to Project Maestro! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Create a new Pull Request.

License

Project Maestro is licensed under the MIT License. See the LICENSE file for more details.

Contact

For questions or support, please open an issue on the GitHub repository.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages