sigscale/im repository overview

⁠SigScale RIM

This application provides the Resource Inventory (TMFC012) and Resource Catalog (TMFC010) functions of the TM Forum Open Digital Architecure (ODA), producing TMF639 and TMF634 Open APIs.

⁠Resources

The information model is based on TM Forum SID and 3GPP Network Resource Models (NRM). The catalog is populated with specifications representing the entities of the 3GPP NRMs as well as ETSI MEC and TM Forum ODA. The inventory is dynamically populated by entities representing the instantiated instance of this software application, obtained through self reflection.

⁠REST

The core functions of the TMFC010 and TMFC012 ODA Components produce the TMF634 and TMF639 Open APIs. Supported operations include creating resource inventory, creating resource specifications and querying inventory and catalog with TMF630 Part 6 advanced query patterns (JSONPath).

⁠Progressive Web App (PWA)

A human interface is also provided as a stanadlone PWA which simply uses the TM Forum Open APIs while providing a visually pleasing presentation. This provides a convenient table form with expanding details and tabbed views to make browsing the catalogs and inventories easy.

⁠Get the latest image

$ docker pull sigscale/im

⁠Initialize a volume for persistent storage of tables:

$ docker run -ti --rm --entrypoint bash -h `hostname --fqdn` -v db:/home/otp/db sigscale/im
[email protected]:~$ bin/initialize
[email protected]:~$ exit

⁠Start SigScale RIM listening for HTTP:

$ docker run -dti -h `hostname --fqdn` -v db:/home/otp/db -p 8080:8080/tcp sigscale/im

Be sure to use an FQDN (-h host.example.com) or you shall get the error: Can't set long nodename!

⁠Kubernetes

Use our Helm chart for deploying a scaling StatefulSet:

helm install rim-1 oci://asia-east1-docker.pkg.dev/sigscale-oss/charts/sigscale-im

⁠Get Support

Feel free to contact us at [email protected]⁠ with any questions. Commercial subscription support is also available.