tubalcain

README

tubalcain

TL;DR

• A MQTT client implementation for IoT devices.
• Integrates with OpenTelemetry for observability.
• Docker and Docker Compose support for easy setup and deployment.
• Configurations for Prometheus, Grafana, OpenSearch, and more included.

Getting Started

Prerequisites

• Install Docker
• Install Go

Installation

1. Clone the repository:

git clone https://github.com/organization/printfarm.git
cd printfarm

1. Build the Docker image:

docker compose build

Usage

To run the application along with its dependencies (Prometheus, Grafana, OpenTelemetry Collector, etc.), use Docker Compose:

docker compose up

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Deployment

The docker-compose.yml file included in the project root defines the deployment for local development and testing. For production environments, ensure you configure the environment variables securely and consider scaling the services as necessary.

Built-with

• Go - The programming language used.
• Eclipse Paho MQTT Go Client - For MQTT communication.
• OpenTelemetry - For tracing and observability.
• Docker & Docker Compose - For containerization and orchestration.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

References

• Eclipse Paho MQTT Go Client documentation
• OpenTelemetry Go SDK
• Docker documentation
• Docker Compose documentation