Skip to content

Quick-Start.md

Latest commit

 

History

History
56 lines (35 loc) · 2.29 KB

Quick-Start.md

File metadata and controls

56 lines (35 loc) · 2.29 KB
Raw

Home > Deployment

Deploying InstantX - Brokers + Observability + Synchronization + APIs

Contains a package with 4 main layers:

  • An MQTT Broker (HiveMQ CE)
  • An Apache Kafka broker and Kafka Connect (with 2 MQTT Source and Sink connectors)
  • An Observability layer (Prometheus + Grafana)
  • An API Service (Event-Publisher)

Installation

Run docker-compose up -d inside the deployment folder This will run the docker compose file in detached mode and will start all 3 containers (hivemq ce, prometheus and grafana)

If you make any changes to the API Service (Event-Publisher), please run it with the --build flag docker-compose up --build -d

Usage

Ports

We are exposing:

  • Port 1883 - for MQTT Broker, to be able to send and receive MQTT messages.
  • Port 3000 - for Grafana.
  • Port 9092 - for Apache Kafka Broker.
  • Port 8083 - for Kafka Connect API.
  • Port 5000 - for API Service (Event-Publisher).
  • Port_8090_ - for Nifi console (:8090/nifi).
  • Port_18080_ - for Nifi Registry (:18080/nifi-registry).

Apache Kafka and Kafka Connect

Please refer to this documentation for details on how to configure and use Kafka and Kafka Connect.

Credentials

Inside Grafana, there is a dashboard with standard metrics related to publish/subscribe messages, connection count and connection time.

  • Grafana
    • Username: admin
    • Password: admin

⚠️ Security note: The credentials above are default development values shipped for a quick local start. They are not secrets and grant access only to a freshly deployed local stack. Change all default credentials before deploying to any shared or production environment, and supply real secrets via environment variables / .env files (which are git-ignored), never by committing them to the repository.

API Service

Please refer to the documentation for details on how to use API Service.

Please refer to this documentation for details on how to configure and run API Service.

NIFI

To open Nifi console open localhost:8090/nifi in your browser To open Nifi Registry console open localhost:18080/nifiregistry in your browser