Commit 6d34526d authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

Merge branch '21-2025q2-metrico-documentation' into 'develop'

Resolve "2025Q2 METRICO DOCUMENTATION"

See merge request !19
parents 0696e1a6 62c34b76
Loading
Loading
Loading
Loading
Loading
+152 KiB
Loading image diff...
+205 KiB
Loading image diff...
+3 −5
Original line number Original line Diff line number Diff line
@@ -27,8 +27,6 @@ For reference, the available Characteristics are:
- **_MT_URL**: The monitoring source URL (e.g. https://prom.osl.etsi.org:9090)
- **_MT_URL**: The monitoring source URL (e.g. https://prom.osl.etsi.org:9090)
- **_MT_QUERY**: The query towards the monitoring source (e.g. query=gnb_service_state)
- **_MT_QUERY**: The query towards the monitoring source (e.g. query=gnb_service_state)
- **_MT_RECURRING_INTERVAL**: The polling interval of the monitoring source (default value: G_1MN, Available values: G_10SEC, G_30SEC, G_1MN, G_5MN, G_15MN, G_30MN, G_1H, G_24H, G_1M, G_1Y)
- **_MT_RECURRING_INTERVAL**: The polling interval of the monitoring source (default value: G_1MN, Available values: G_10SEC, G_30SEC, G_1MN, G_5MN, G_15MN, G_30MN, G_1H, G_24H, G_1M, G_1Y)
- **_MT_START_TIME**: The starting time of the monitoring job (default value, if left blank: NOW)
- **_MT_END_TIME**: The ending time of the monitoring job (default value, if left blank: NOW + 1h)
- **_MT_SERVICEUUID**: The ID of the service to update with the retrieved monitoring data
- **_MT_SERVICEUUID**: The ID of the service to update with the retrieved monitoring data
- **_MT_CHARACTERISTIC_NAME**: The characteristic of the service with id _MT_SERVICEUUID that will be updated with the retrieved monitoring data
- **_MT_CHARACTERISTIC_NAME**: The characteristic of the service with id _MT_SERVICEUUID that will be updated with the retrieved monitoring data


@@ -64,7 +62,7 @@ Using "Create New Characteristic" menu, create the Characteristics as shown belo


After filling all the Characteristics, you should be able to see something like the image below:
After filling all the Characteristics, you should be able to see something like the image below:


![METRICO CFSS Characteristics](./images/metrico_cfss_characteristics.png)
![METRICO CFSS Characteristics](./images/MetricoCFSSpecificationCharacteristics_v1_0.png)


The above configuration is expected to query ```http://172.16.10.100:9090/api/v1/query?query=gnb_service_state&time=1736528808.484``` every 1 minute and return the result to the service that the user will point out (filling ```_MT_SERVICEUUID	```), and especially into a Characteristic named ```METRICO Result```.
The above configuration is expected to query ```http://172.16.10.100:9090/api/v1/query?query=gnb_service_state&time=1736528808.484``` every 1 minute and return the result to the service that the user will point out (filling ```_MT_SERVICEUUID	```), and especially into a Characteristic named ```METRICO Result```.


@@ -101,7 +99,7 @@ Order the service from the previously assigned Service Catalog > Service Categor


Here, we assume that the user will not provide the ```_MT_SERVICEUUID``` during the Service Order Checkout phase, neither the task's interval (which defaults to 1 hour). Note how the values are filled in with the defaults from the designing phase.
Here, we assume that the user will not provide the ```_MT_SERVICEUUID``` during the Service Order Checkout phase, neither the task's interval (which defaults to 1 hour). Note how the values are filled in with the defaults from the designing phase.


![Metrico CFSS Order Checkout](./images/metrico_cfss_order_checkout.png)
![Metrico CFSS Order Checkout](./images/ServiceOrderCheckout_v1_0.png)


Once ordered, you may navigate to the Order Preview by Manage Services > Service Orders list.
Once ordered, you may navigate to the Order Preview by Manage Services > Service Orders list.


@@ -119,7 +117,7 @@ Starting from the Service Order overview and specifically the Order Item #1 tab


Navigate to the "Service Characteristics" tab and click the edit Service Characteristics button. Provide the ID of the Metrico Service (as found in the address bar), at the ```_MT_SERVICEUUID``` value, as depicted in the figure below.
Navigate to the "Service Characteristics" tab and click the edit Service Characteristics button. Provide the ID of the Metrico Service (as found in the address bar), at the ```_MT_SERVICEUUID``` value, as depicted in the figure below.


![Edit Metrico CFS Service Characteristic "_MT_SERVICEUUID"](./images/edit_cfs_service_characteristic.png)
![Edit Metrico CFS Service Characteristic "_MT_SERVICEUUID"](./images/edit_cfs_service_characteristic_v_1_0.png)


Once the ```_MT_SERVICEUUID``` value is provided, the Metrico RFS will be created and eventually the Service Order will become "COMPLETED", as seen in the Service Order overview.
Once the ```_MT_SERVICEUUID``` value is provided, the Metrico RFS will be created and eventually the Service Order will become "COMPLETED", as seen in the Service Order overview.


Loading