samanbayaka 0.0.19 → 0.0.21

package/README.md

@@ -9,7 +9,23 @@ This project is a modular, production-ready microservices framework built with M
 [![NPM version](https://img.shields.io/npm/v/samanbayaka.svg)](https://www.npmjs.com/package/samanbayaka)
 [![License](https://img.shields.io/npm/l/samanbayaka.svg)](LICENSE)
 
-# Features
+- [Table of contents](#table-of-contents)
+- [Features](#features)
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [Documentations](#documentations)
+  - [Errors](#errors)
+  - [getConfig](#getConfig)
+  - [loadDemo](#loadDemo)
+  - [loadGatewayService](#loadGatewayService)
+  - [loadFeatureService](#loadFeatureService)
+  - [auxBrokerService](#auxBrokerService)
+- [Usage](#usage)
+- [Demo](#Demo)
+- [Dockers](#dockers)
+  - [Etcd](#etcd)
+
+## Features
 
 - Moleculer-based microservices architecture
 - NATS transporter for high-performance messaging
@@ -23,12 +39,8 @@ This project is a modular, production-ready microservices framework built with M
 - Config-driven initialization
 - Metrics and Log shipping for Grafana
 
-# Documentation
 
-* Dockers
-  * [Etcd](https://gitlab.com/dalal.suvendu/samanbayaka/-/blob/main/docs/dockers/etcd.md?ref_type=heads)
-
-# Installation
+## Installation
 
 ```bash
 pnpm install samanbayaka
@@ -37,16 +49,16 @@ Once the package is installed, you can import the library using import or requir
 ```bash
 import sbk from "samanbayaka"
 ```
-# Prerequisites
+## Prerequisites
 It is assumed that NATS, Redpanda, Redis, and Etcd are installed and properly configured. All services should be discoverable through the /etc/hosts file.
-#### Minimum required Node.js version: >= 22.x.x
+### Minimum required Node.js version: >= 22.x.x
 ```bash
 node -v
 nvm use 22
 ```
 Additionally, OpenObserve is used to view logs and telemetry.
 
-#### Environment variables
+### Environment variables
 To configure all required environment variables, create a Bash file:
 ```bash
 source /etc/profile.d/sbk.sh
@@ -80,14 +92,14 @@ Optionally, you may verify the set environment variables.
 ```bash
 echo $SBK_PORT
 ```
-#### Configuration files
+### Configuration files
 Create a directory to store the configuration files, then copy all configuration files from the current project path into this directory and update them as needed. Before copying, ensure that your current working directory is the project directory.
 ```bash
 pwd
 sudo mkdir -p /usr/local/etc/<your_folder>
 sudo cp config/*.*  /usr/local/etc/<your_folder>
 ```
-#### Log files
+### Log files
 For production, it is recommended to create a new directory named "samanbayaka" under /var/log to store logs.
 ```bash
 sudo mkdir -p /var/log/samanbayaka
@@ -98,7 +110,7 @@ Empty your log files if they become very large, as follows:
 ```bash
 truncate -s 0 /var/log/samanbayaka/sbk-*.log
 ```
-#### Setup logrotate (optional)
+### Setup logrotate (optional)
 Create config file:
 ```bash
 sudo nano /etc/logrotate.d/sbk
@@ -117,27 +129,27 @@ Paste this:
 }
 ```
 
-## API Docs
+## Documentations
 
-### sbk.Errors
+### Errors
 
 `sbk.Errors` exposes the Moleculer `Errors` object.
 
-### sbk.getConfig
+### getConfig
 
 `sbk.getConfig` is a function that returns a configuration object from a specified file name.
 
 The file is loaded from the configuration directory defined by the environment variable.
 
-### sbk.loadDemo
+### loadDemo
 
 `sbk.loadDemo` is an asynchronous function that creates a demo service to help understand the project.
 
-### sbk.loadGatewayService
+### loadGatewayService
 
 `sbk.loadGatewayService` is an asynchronous function that creates a gateway service to expose REST APIs.
 
-### sbk.loadFeatureService
+### loadFeatureService
 
 `sbk.loadFeatureService` is an asynchronous function that creates a feature service.
 
@@ -169,7 +181,7 @@ Example:
 ```
 
 
-### sbk.auxBrokerService
+### auxBrokerService
 
 `sbk.auxBrokerService` is a function used to initialize and manage message brokers such as Kafka, MQTT, and RabbitMQ.
 
@@ -248,8 +260,8 @@ Example:
 }
 ```
 
-# Usage
-#### Create gateway service
+## Usage
+### Create gateway service
 The Gateway is a critical service that exposes all endpoints as REST APIs. At least one Gateway service must be running to make the REST APIs accessible.
 ```bash
 mkdir gateway
@@ -265,7 +277,7 @@ import sbk from "samanbayaka"
 await sbk.loadGatewayService()
 ```
 ---
-#### Create feature services
+### Create feature services
 ```bash
 mkdir <your_service_name>
 cd <your_service_name>
@@ -324,7 +336,7 @@ await sbk.loadFeatureService({
 
 ```
 ---
-#### Create auxaliary broker services
+### Create auxaliary broker services
 ##### for producer
 ```bash
 mkdir <your_service_name>-<type>-<topic>
@@ -365,7 +377,7 @@ If you do not expose the service as a REST API and run it as a private/internal
 rest: false
 ```
 
-##### for consumer
+#### for consumer
 ```bash
 mkdir <your_service_name>-<type>-<topic>-<group>
 cd <your_service_name>-<type>-<topic>-<group>
@@ -403,7 +415,7 @@ The `interMessageDelayMs` option introduces a delay between two consecutive mess
 
 ---
 
-#### Run the services 
+### Run the services 
 
  * development/testing
 ```bash
@@ -420,7 +432,7 @@ cd <your_path>/hello
 node index.mjs >> /var/log/samanbayaka/sbk-${HOSTNAME}-$$.log 2>&1
 ```
 
-# Demo
+## Demo
 You can also run the demo service to better understand how microservices work in the Moleculer ecosystem and how REST APIs are exposed.
 ```bash
 mkdir demo
@@ -439,6 +451,134 @@ Run the service, demo
 node demo.mjs
 ```
 
+## Dockers
+
+### Etcd
+To manage configurations centrally, use the docker-compose.yml file to run Etcd.
+```bash
+mkdir -p etcd
+cd etcd
+touch docker-compose.yml
+export ETCD_ROOT_PW=<your_root_pass>
+export ETCD_CONFIG_ADMIN_PW=<your_config_admin_pass>
+```
+
+Open `docker-compose.yml` and paste the following:
+```yml
+services:
+  etcd:
+    image: quay.io/coreos/etcd:v3.5.5
+    container_name: sbk-etcd
+
+    ports:
+      - "<your_api_port>:2379"
+      - "<your_cluster_port>:2380"
+
+    volumes:
+      - /usr/local/etc/samanbayaka:/etcd-data
+
+    command:
+      - /usr/local/bin/etcd
+      - --name=etcd
+      - --data-dir=/etcd-data
+      - --listen-client-urls=http://0.0.0.0:2379
+      - --advertise-client-urls=http://etcd:2379
+      - --listen-peer-urls=http://0.0.0.0:2380
+      - --initial-advertise-peer-urls=http://etcd:2380
+      - --initial-cluster=etcd=http://etcd:2380
+      - --initial-cluster-state=new
+
+    restart: unless-stopped
+
+  etcd-init:
+    image: quay.io/coreos/etcd:v3.5.5
+    depends_on:
+      - etcd
+
+    volumes:
+      - /usr/local/etc/samanbayaka:/etcd-data
+
+    environment:
+      - ETCDCTL_API=3
+
+    entrypoint: 
+      - /bin/sh
+      - -c
+
+    command:
+      - |
+        set -e
+
+        echo "waiting for etcd..."
+
+        for i in $(seq 1 30); do
+          etcdctl --endpoints=http://etcd:2379 endpoint health && break
+          echo "retry $$i..."
+          sleep 2
+        done
+
+        echo "etcd initialized"
+
+        echo "Creating the root role"
+        etcdctl --endpoints=http://etcd:2379 role add root || true
+
+        echo "Creating the root user"
+        etcdctl --endpoints=http://etcd:2379 user add root:${ETCD_ROOT_PW} || true
+
+        echo "Granting the root role to the root user"
+        etcdctl --endpoints=http://etcd:2379 user grant-role root root
+
+        echo "Enable authentication"
+        etcdctl --endpoints=http://etcd:2379 auth enable || true
+
+        # -------------------------------------------------------
+
+        echo "Creating admin role"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role add admin
+
+        echo "Granting broad permissions"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role grant-permission --prefix=true admin readwrite /
+
+        echo "Creating configadmin user"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} user add configadmin:${ETCD_CONFIG_ADMIN_PW}
+
+        echo "Assign role"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} user grant-role configadmin admin
+
+        # ---------------------------------------------------------
+
+        echo "Creating Roles and Granting"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role add gateway
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role grant-permission --prefix=true gateway read /config/yaml/nats
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role grant-permission --prefix=true gateway read /config/yaml/auth
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role grant-permission --prefix=true gateway read /config/yaml/catch
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} role grant-permission --prefix=true gateway read /config/yaml/telemetry
+
+        # ---------------------------------------------------------
+        
+        echo "Creating User and Assign Role"
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} user add <your_user>:<your_pass>
+        etcdctl --endpoints=http://etcd:2379 --user=root:${ETCD_ROOT_PW} user grant-role apigtwy gateway
+
+        # ---------------------------------------------------------
+
+        etcdctl --endpoints=http://etcd:2379 --user=configadmin:${ETCD_CONFIG_ADMIN_PW} put /config/yaml/nats "$(cat /etcd-data/nats.yml)" || true
+
+        #etcdctl --endpoints=http://etcd:2379 --user=<your_user>:<your_pass> get /config/yaml/nats
+
+
+        echo "etcd initialization completed"
+```
+Optionally verify:
+```bash
+docker ps | grep 'sbk-etcd'
+```
+Optionally check health:
+```bash
+docker exec -it sbk-etcd etcdctl --endpoints=http://etcd:2379 endpoint health
+```
+---
+
 <p align="center" style="margin-top: 100px;">
   <img src="https://moleculer.services/images/banner.png" alt="Moleculer Logo" width="600">
 </p>

package/commit-hash.mjs

@@ -1 +1 @@
-export const COMMIT_HASH = '4fc1d9b';
+export const COMMIT_HASH = '85a1def';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "samanbayaka",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "Moleculer Gateway service with kafka transporter",
   "homepage": "https://gitlab.com/dalal.suvendu/samanbayaka#readme",
   "bugs": {