Skip to main content

NGOSS Service

Purpose​

mvp3-ngoss-service is the backend service for NGOSS-related workflows.

Local runtime facts​

  • default local port: 3004
  • swagger docs: /ngoss/docs
  • metrics endpoint: /ngoss/metrics
  • env template: .env.example

Owned modules​

  • ngoss

Dependencies​

  • MariaDB
  • Redis
  • RabbitMQ credentials are part of the template
  • CAMELIA_SOCKET_BASE_URI
  • JWT configuration

Required config groups​

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

Upstream and downstream​

  • upstream callers: portal screens or integrations that need NGOSS domain behavior
  • downstream systems: MariaDB, Redis, and Camelia socket integration
  • queue publishing confirmed from code:
    • emits create-kci to intt_kci_queue
    • sends tmf-update-ctt-list to intt_ctt_queue
  • 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: /ngoss
  • technical host module: NgossModule

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