diff --git a/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationCharacteristics_v1_0.png b/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationCharacteristics_v1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..a53938b7f3e07b85ee4a015f45608a2f02293e51 Binary files /dev/null and b/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationCharacteristics_v1_0.png differ diff --git a/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationLCM_v1_0.png b/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationLCM_v1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..8345cec9426ba7592651ad415cda8946c535be83 Binary files /dev/null and b/doc/service_design/examples/monitoring_aas/images/MetricoCFSSpecificationLCM_v1_0.png differ diff --git a/doc/service_design/examples/monitoring_aas/images/ServiceOrderCheckout_v1_0.png b/doc/service_design/examples/monitoring_aas/images/ServiceOrderCheckout_v1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..28f5ab94dda6058a6635d205d59605b205b3dca6 Binary files /dev/null and b/doc/service_design/examples/monitoring_aas/images/ServiceOrderCheckout_v1_0.png differ diff --git a/doc/service_design/examples/monitoring_aas/images/edit_cfs_service_characteristic_v_1_0.png b/doc/service_design/examples/monitoring_aas/images/edit_cfs_service_characteristic_v_1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..73b838c53d55f3950a2b5d4c7ff0a883ee6ff9db Binary files /dev/null and b/doc/service_design/examples/monitoring_aas/images/edit_cfs_service_characteristic_v_1_0.png differ diff --git a/doc/service_design/examples/monitoring_aas/monitoring_aas.md b/doc/service_design/examples/monitoring_aas/monitoring_aas.md index 639959ce706c16a407e659645a760de6bfb18152..4f3187919fdb9f0c6800c3929414a8bd049aeabd 100644 --- a/doc/service_design/examples/monitoring_aas/monitoring_aas.md +++ b/doc/service_design/examples/monitoring_aas/monitoring_aas.md @@ -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_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_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_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: -![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```. @@ -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. -![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. @@ -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. -![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. diff --git a/doc/service_design/monitoring/design_monitoring_services.md b/doc/service_design/monitoring/design_monitoring_services.md index 2aacd078df181411dc903d65acaa5fc091b15013..a8f76d2f2cfd001fbabdb51afd582df35e449bc1 100644 --- a/doc/service_design/monitoring/design_monitoring_services.md +++ b/doc/service_design/monitoring/design_monitoring_services.md @@ -8,11 +8,11 @@ This section introduces a way to design Service Specifications that integrate ex When METRICO component instantiates, it automatically creates a respective Resource Specification, named ```METRICO_Resource_Specification```. It is always noted with a specific ```Version``` and ```Category```. As METRICO evolves, this combination shall change. METRICO creates its versioned Resource Specification, only when it is not already existing. -![METRICO Resource Specification](./images/MetricoResourceSpecification.png) +![METRICO Resource Specification](./images/MetricoResourceSpecification_v1_0.png) The Resource Specification comprises of all the properties needed to execute a monitoring job towards an external source and return the data to a candidate service. For this reason, it incorporates the respective characteristics, as shown below: -![METRICO Resource Specification's Characteristics](./images/MetricoResourceSpecificationCharacteristics.png) +![METRICO Resource Specification's Characteristics](./images/MetricoResourceSpecificationCharacteristics_v1_0.png) Namely, the characteristics provide the following information: @@ -20,8 +20,6 @@ Namely, the characteristics provide the following information: - **_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_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_CHARACTERISTIC_NAME**: The characteristic of the service with id _MT_SERVICEUUID that will be updated with the retrieved monitoring data diff --git a/doc/service_design/monitoring/images/MetricoResourceSpecificationCharacteristics_v1_0.png b/doc/service_design/monitoring/images/MetricoResourceSpecificationCharacteristics_v1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..2d4fb90a3f8275705acc58c0809ea01dbb54c2aa Binary files /dev/null and b/doc/service_design/monitoring/images/MetricoResourceSpecificationCharacteristics_v1_0.png differ diff --git a/doc/service_design/monitoring/images/MetricoResourceSpecification_v1_0.png b/doc/service_design/monitoring/images/MetricoResourceSpecification_v1_0.png new file mode 100644 index 0000000000000000000000000000000000000000..fed6a3818ed03db3f5e9f6dd34aa3859335d7d8c Binary files /dev/null and b/doc/service_design/monitoring/images/MetricoResourceSpecification_v1_0.png differ diff --git a/mkdocs.yml b/mkdocs.yml index c5d95f3cc3a8c3c91c40b48942e5b5afd382dba8..40ddaf6fcbdfeab3b93260bf10e93e977ddba947 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -99,7 +99,7 @@ extra: link: https://twitter.com/OpensliceOSS version: provider: mike - documentation_version: "develop" + documentation_version: "2025Q2" # Page tree nav: