NOC Grid Service

Purpose

mvp3-nocgrid-service is the backend service for NOC Grid-related workflows.

Local runtime facts

• default local port: 3009
• swagger docs: /nocgrid/docs
• metrics endpoint: /nocgrid/metrics
• env template: .env.example

Owned modules

• audit-log
• kci
• mail
• notifications
• ntt

Dependencies

• MariaDB
• MariaDB replica
• Redis
• RabbitMQ credentials are part of the template
• CAMELIA_SOCKET_BASE_URI
• shared storage volume appears in docker-compose.yml

Required config groups

• PORT
• DB_*
• DB_REPLICA_*
• TOKEN_EXPIRED_PER_SECONDS, JWT_ISSUER, JWT_ALGORITHM
• REDIS_*
• RABBITMQ_*
• CAMELIA_SOCKET_BASE_URI

Upstream and downstream

• upstream callers: portal flows for NOC Grid, KCI, or NTT-related operations
• downstream systems: MariaDB, replica DB, Redis, shared storage, KCI verification flows
• team clarification:
  • this service is part of the Antrix system of record
  • it exposes endpoints for external sources
  • cross-service integration should happen through endpoints, not direct table writes

Confirmed module mapping

• route prefix: /nocgrid
• submodules mounted under this service:
  • /nocgrid/kci
  • /nocgrid/ntt

Local commands

Install:

git submodule update --init --recursive
cd share-entity
git checkout development
cd ..
pnpm install

Run locally:

pnpm run start:dev

Build and run production mode:

pnpm run build
pnpm run start:prod

Test:

pnpm run test
pnpm run test:e2e
pnpm run test:cov

Local testing

• unit tests: pnpm run test
• e2e tests: pnpm run test:e2e
• coverage: pnpm run test:cov