ukama

Introduction

Init System

Orgs

Nodes

Systems

Registry System

Invitations

Members

Networks

Data Plan System

Baserates

Packages

Rates

Subscriber System

List all subscribers for a network

List all sims for a network

Subscriber

Sim Pool

Notification System

Mailer

Notification

Metrics System

Get metrics data stream. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Live metric handler-fm

Get metrics

Get metrics. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Metric handler-fm

Get metrics for an network. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Network metric handler-fm

Get metrics for anode. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Node metric handler-fm

Get metrics for an org. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Org metric handler-fm

Get metrics range for a time period. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Metric range handler-fm

Get metrics for a sim. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Sim metric handler-fm

Get metrics for a susbcriber. Response has Prometheus data format https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors

Subscriber metric handler-fm

Messaging System

Prometheus Target

Nucleus system include Org and User services

Nucleus System

Users

Ukama Systems

Production

Sandbox

Ukama Systems is a collection of software components and services developed by Ukama Inc. These systems are designed to provide various functionalities and capabilities for server-side applications. They are built with a focus on simplicity, flexibility, and modularity, allowing developers to easily integrate them into their projects.The Ukama Systems include components such as API Gateway, Base Rate, Package Management, Subscriber Management, and SIM Manager. Each of these components serves a specific purpose in managing and controlling data flows, communication between services, and handling subscriber-related operations.The systems are built on top of the Ukama Common codebase, which provides shared functionality and utilities that are used across all Ukama projects. This common codebase ensures consistency and reduces code duplication across the systems.To use Ukama Systems, developers can import the required packages and libraries into their projects. The systems are designed to be easily integrated into existing applications and can be customized as per the specific requirements of the project.Overall, Ukama Systems provide a lightweight and simple service mesh and proxy control/data plane for server-side applications. They offer a range of functionalities and capabilities that can enhance the performance, scalability, and reliability of applications.

Ukama Systems is a collection of software components and services developed by Ukama Inc. These systems are designed to provide various functionalities and capabilities for server-side applications. They are built with a focus on simplicity, flexibility, and modularity, allowing developers to easily integrate them into their projects.

The Ukama Systems include components such as API Gateway, Base Rate, Package Management, Subscriber Management, and SIM Manager. Each of these components serves a specific purpose in managing and controlling data flows, communication between services, and handling subscriber-related operations.

The systems are built on top of the Ukama Common codebase, which provides shared functionality and utilities that are used across all Ukama projects. This common codebase ensures consistency and reduces code duplication across the systems.

To use Ukama Systems, developers can import the required packages and libraries into their projects. The systems are designed to be easily integrated into existing applications and can be customized as per the specific requirements of the project.

Overall, Ukama Systems provide a lightweight and simple service mesh and proxy control/data plane for server-side applications. They offer a range of functionalities and capabilities that can enhance the performance, scalability, and reliability of applications.

The Ukama Init system is a lightweight and simple service mesh and proxy control/data plane for server-side applications. It provides functionality for registering systems, querying system information, sending health updates, restarts, and updates to the init system.The system includes various sub-systems, such as the Sim Pool sub-system, Subscriber sub-system, and Sim Manager sub-system. Each sub-system has its own specific functionality and purpose within the Ukama Init system.The initClient is a client used for registering a system to the local Init and global Init systems. It also handles GRPC communication from services within the system. The initClient can register the system using a unique identifier (UUID) and can query the init system for specific system information.The Ukama Init system supports maintaining URLs as well, in addition to system registration.Overall, the Ukama Init system provides a central control and management point for server-side applications, allowing for easy registration, querying, and communication between systems.

The Ukama Init system is a lightweight and simple service mesh and proxy control/data plane for server-side applications. It provides functionality for registering systems, querying system information, sending health updates, restarts, and updates to the init system.

The system includes various sub-systems, such as the Sim Pool sub-system, Subscriber sub-system, and Sim Manager sub-system. Each sub-system has its own specific functionality and purpose within the Ukama Init system.

The initClient is a client used for registering a system to the local Init and global Init systems. It also handles GRPC communication from services within the system. The initClient can register the system using a unique identifier (UUID) and can query the init system for specific system information.

The Ukama Init system supports maintaining URLs as well, in addition to system registration.

Overall, the Ukama Init system provides a central control and management point for server-side applications, allowing for easy registration, querying, and communication between systems.

The Ukama Registry system is a comprehensive platform that manages various aspects of an organisation&apos;s operations. It consists of three main components: Invitation, Member, and Node.The Invitation component allows organizations to send invitations to individuals, inviting them to join the organisation. This can include inviting new members, partners, or collaborators. The Invitation service handles the creation, retrieval, and management of invitations. It enables organizations to track the status of invitations, update their status, and delete invitations when necessary. This component streamlines the process of onboarding new members and facilitates communication and collaboration within organisations.The Member component focuses on managing the members within an organisation. It provides functionality to add new members, update member information, and remove members if needed. The Member service ensures that member data is stored securely and can be accessed when required. Organizations can retrieve information about individual members, such as their role within the organization, contact details, and other relevant data. This component plays a crucial role in maintaining an up-to-date and accurate record of an organization&apos;s members.The Node component handles the management of nodes within the registry system. Nodes represent different entities or elements within the organization, such as servers, devices, or endpoints. The Node service allows organisations to add new nodes, update node information, and delete nodes as necessary. It provides functionalities to attach nodes to specific networks or detach them from networks. This component enables organizations to keep track of their network infrastructure and manage the relationships between different nodes and networks.Overall, the Ukama Registry system provides a comprehensive solution for organizations to manage invitations, members, and nodes efficiently. It streamlines processes, enhances collaboration, and ensures that organisations have accurate and up-to-date information about their members and network infrastructure.

The Ukama Registry system is a comprehensive platform that manages various aspects of an organisation's operations. It consists of three main components: Invitation, Member, and Node.

The Invitation component allows organizations to send invitations to individuals, inviting them to join the organisation. This can include inviting new members, partners, or collaborators. The Invitation service handles the creation, retrieval, and management of invitations. It enables organizations to track the status of invitations, update their status, and delete invitations when necessary. This component streamlines the process of onboarding new members and facilitates communication and collaboration within organisations.

The Member component focuses on managing the members within an organisation. It provides functionality to add new members, update member information, and remove members if needed. The Member service ensures that member data is stored securely and can be accessed when required. Organizations can retrieve information about individual members, such as their role within the organization, contact details, and other relevant data. This component plays a crucial role in maintaining an up-to-date and accurate record of an organization's members.

The Node component handles the management of nodes within the registry system. Nodes represent different entities or elements within the organization, such as servers, devices, or endpoints. The Node service allows organisations to add new nodes, update node information, and delete nodes as necessary. It provides functionalities to attach nodes to specific networks or detach them from networks. This component enables organizations to keep track of their network infrastructure and manage the relationships between different nodes and networks.

Overall, the Ukama Registry system provides a comprehensive solution for organizations to manage invitations, members, and nodes efficiently. It streamlines processes, enhances collaboration, and ensures that organisations have accurate and up-to-date information about their members and network infrastructure.

The Ukama Data Plan system is a comprehensive system that manages all the sim packages and base rates functionality. It consists of three sub-systems: the API Gateway, the Base Rate sub-system, and the Package sub-system.The API Gateway acts as a central entry point for all the requests made to the Data Plan system. It handles the authentication and routing of requests to the appropriate sub-systems. It provides a unified interface for clients to interact with the system.The Base Rate sub-system is responsible for managing the base rates for different services such as SMS, data, and voice. It provides functionalities to retrieve base rates based on various parameters like country, provider, and SIM type. It also allows the upload of new base rates.The Package sub-system manages the sim packages offered by Ukama. It provides functionalities to add, delete, update, and retrieve sim packages. Each package has associated rates for SMS, data, and voice services. The Package sub-system also allows the retrieval of packages based on the organization ID.Overall, the Ukama Data Plan system ensures efficient management of sim packages and base rates. It provides a seamless experience for both clients and administrators by offering a unified interface and robust functionalities for managing packages and rates.

The Ukama Data Plan system is a comprehensive system that manages all the sim packages and base rates functionality. It consists of three sub-systems: the API Gateway, the Base Rate sub-system, and the Package sub-system.

The API Gateway acts as a central entry point for all the requests made to the Data Plan system. It handles the authentication and routing of requests to the appropriate sub-systems. It provides a unified interface for clients to interact with the system.

The Base Rate sub-system is responsible for managing the base rates for different services such as SMS, data, and voice. It provides functionalities to retrieve base rates based on various parameters like country, provider, and SIM type. It also allows the upload of new base rates.

The Package sub-system manages the sim packages offered by Ukama. It provides functionalities to add, delete, update, and retrieve sim packages. Each package has associated rates for SMS, data, and voice services. The Package sub-system also allows the retrieval of packages based on the organization ID.

Overall, the Ukama Data Plan system ensures efficient management of sim packages and base rates. It provides a seamless experience for both clients and administrators by offering a unified interface and robust functionalities for managing packages and rates.

The Subscriber System API section is a crucial part of the Ukama Systems platform, offering developers access to a range of services. These services include the Registry, Sim Pool, Sim Manager, and Test Agent. By utilizing this API, developers can interact with and manage subscribers, SIM cards, and testing capabilities effectively.With the Subscriber System API, developers can perform various operations on subscriber information. They can create new subscribers, retrieve existing subscriber details, update subscriber information, and even delete subscribers if needed. This functionality provides developers with complete control over managing subscriber data within the Ukama Systems platform.Additionally, the API also allows developers to allocate SIM cards to subscribers. They can request SIM cards from the Sim Pool, which is responsible for managing and providing SIM cards. This feature enables developers to seamlessly allocate SIM cards to subscribers, ensuring a smooth user experience.Furthermore, the Subscriber System API section includes the Test Agent service, which allows developers to monitor testing activities. They can track and manage the testing capabilities within the Ukama Systems platform, ensuring efficient testing processes and accurate results.Overall, the Subscriber System API section aims to simplify the integration process for developers and provide comprehensive access to the services offered by the Ukama Systems platform. It empowers developers to manage subscribers, allocate SIM cards, and monitor testing activities effectively, ultimately enhancing the functionality and usability of the Ukama Systems platform.

The Subscriber System API section is a crucial part of the Ukama Systems platform, offering developers access to a range of services. These services include the Registry, Sim Pool, Sim Manager, and Test Agent. By utilizing this API, developers can interact with and manage subscribers, SIM cards, and testing capabilities effectively.

With the Subscriber System API, developers can perform various operations on subscriber information. They can create new subscribers, retrieve existing subscriber details, update subscriber information, and even delete subscribers if needed. This functionality provides developers with complete control over managing subscriber data within the Ukama Systems platform.

Additionally, the API also allows developers to allocate SIM cards to subscribers. They can request SIM cards from the Sim Pool, which is responsible for managing and providing SIM cards. This feature enables developers to seamlessly allocate SIM cards to subscribers, ensuring a smooth user experience.

Furthermore, the Subscriber System API section includes the Test Agent service, which allows developers to monitor testing activities. They can track and manage the testing capabilities within the Ukama Systems platform, ensuring efficient testing processes and accurate results.

Overall, the Subscriber System API section aims to simplify the integration process for developers and provide comprehensive access to the services offered by the Ukama Systems platform. It empowers developers to manage subscribers, allocate SIM cards, and monitor testing activities effectively, ultimately enhancing the functionality and usability of the Ukama Systems platform.

The Ukama Notification system is a comprehensive solution that provides developers with the ability to send notifications through various channels such as email. It consists of three main components: mailer, notify, and API gateway.The mailer component is responsible for sending email notifications. It utilizes a messaging system and follows the protocol defined in the &quot;validator.proto&quot; file. Developers can use the mailer to send notifications to specific recipients by providing relevant information such as the notification ID, description, severity, type, status, and additional details. The mailer component is implemented as a service and can be easily integrated into existing applications.The notify component is the core of the Ukama Notification system. It provides a set of APIs that developers can use to manage notifications. With the notify component, developers can add, retrieve, list, delete, and purge notifications. The notifications are represented by the Notification message defined in the &quot;notify.proto&quot; file. This message contains information such as the notification ID, node ID, node type, description, severity, type, service name, status, epoch time, and details. The notify component also provides an EventNotificationService that allows developers to receive event notifications.The API gateway component acts as a proxy and control plane for the mailer and notify components. It provides a unified interface for developers to interact with the notification system. Developers can send requests to the API gateway to perform operations on notifications, such as adding a new notification or retrieving existing ones. The API gateway is implemented using the Gin framework and follows the RESTful architecture style. It also supports cross-origin resource sharing (CORS) to enable communication with clients from different domains.In summary, the Ukama Notification system offers developers a powerful and flexible solution for sending notifications. The mailer component handles the delivery of notifications via email, while the notify component provides APIs for managing notifications. The API gateway component acts as a central point of entry for developers to interact with the notification system. By leveraging these components, developers can easily integrate notification functionality into their applications and improve their overall user experience.

The Ukama Notification system is a comprehensive solution that provides developers with the ability to send notifications through various channels such as email. It consists of three main components: mailer, notify, and API gateway.

The mailer component is responsible for sending email notifications. It utilizes a messaging system and follows the protocol defined in the "validator.proto" file. Developers can use the mailer to send notifications to specific recipients by providing relevant information such as the notification ID, description, severity, type, status, and additional details. The mailer component is implemented as a service and can be easily integrated into existing applications.

The notify component is the core of the Ukama Notification system. It provides a set of APIs that developers can use to manage notifications. With the notify component, developers can add, retrieve, list, delete, and purge notifications. The notifications are represented by the Notification message defined in the "notify.proto" file. This message contains information such as the notification ID, node ID, node type, description, severity, type, service name, status, epoch time, and details. The notify component also provides an EventNotificationService that allows developers to receive event notifications.

The API gateway component acts as a proxy and control plane for the mailer and notify components. It provides a unified interface for developers to interact with the notification system. Developers can send requests to the API gateway to perform operations on notifications, such as adding a new notification or retrieving existing ones. The API gateway is implemented using the Gin framework and follows the RESTful architecture style. It also supports cross-origin resource sharing (CORS) to enable communication with clients from different domains.

In summary, the Ukama Notification system offers developers a powerful and flexible solution for sending notifications. The mailer component handles the delivery of notifications via email, while the notify component provides APIs for managing notifications. The API gateway component acts as a central point of entry for developers to interact with the notification system. By leveraging these components, developers can easily integrate notification functionality into their applications and improve their overall user experience.

The Metrics System API endpoint in the Ukama Systems project provides access to the exporter service. This service allows users to retrieve various metrics data from the system. The Metrics System API can be utilised to gather information on system performance, user activity, and other relevant metrics. This endpoint is designed to support integrations with other applications and services, making it easy to retrieve and analyze metrics data for both technical and non-technical users.

The Metrics System API endpoint in the Ukama Systems project provides access to the exporter service. This service allows users to retrieve various metrics data from the system. The Metrics System API can be utilised to gather information on system performance, user activity, and other relevant metrics. This endpoint is designed to support integrations with other applications and services, making it easy to retrieve and analyze metrics data for both technical and non-technical users.

Nucleus system include Org and User services

Operations on Orgs

Get all organization owned by a user

Get orgs

user_uuid

memberOf

ownerOf

user

Add a new organization

Add org

certificate

name

owner_uuid

Get organization by name

Get org by name

Operations on Users

Sections