Add CI to build both images

[ric-app/mc.git] / docs / readme.rst

diff --git a/docs/readme.rst b/docs/readme.rst
index 3b84a97..ef60c65 100644 (file)
--- a/docs/readme.rst
+++ b/docs/readme.rst
@@ -6,7 +6,9 @@ RIC Measurement Campaign (MC) supported KPIs
 ============================================\r
 \r
 name: throughput_ue\r
+\r
 description: throughput experienced by UE over a measurement interval. "Active" throughput is throughput while actively downloading, "average" averages bytes transfered over the measurement interval\r
+\r
 - ULLONG TS\r
 - LLONG e_RAB_ID\r
 - LLONG UE_ID\r
@@ -19,6 +21,7 @@ description: throughput experienced by UE over a measurement interval. "Active"
 \r
 \r
 name: addreq_success_stats\r
+\r
 description: statistics on the time to successfully make a DC connection\r
 \r
 - V_STR GNB_ID\r
@@ -33,6 +36,7 @@ description: statistics on the time to successfully make a DC connection
 \r
 \r
 name: addreq_pdf_nr_cell\r
+\r
 description : histogram of neighboring cell RSRP, aggregated by cell id\r
 \r
 - ULLONG TS\r
@@ -47,6 +51,7 @@ description : histogram of neighboring cell RSRP, aggregated by cell id
 \r
 \r
 name: addreq_pdf_nr_gnb\r
+\r
 description : histogram of neighboring cell RSRP, aggregated by GNB, as computed from addition request events.\r
 \r
 - ULLONG TS\r
@@ -61,6 +66,7 @@ description : histogram of neighboring cell RSRP, aggregated by GNB, as computed
 \r
 \r
 name: addreq_stats_nr_cell\r
+\r
 description : statistics about neighboring cell RSRP aggregated by cell id\r
 \r
 - ULLONG TS\r
@@ -76,6 +82,7 @@ description : statistics about neighboring cell RSRP aggregated by cell id
 \r
 \r
 name: addreq_stats_nr_gnb\r
+\r
 description : statistics about neighboring cell RSRP aggregated by GNB, as computed from addition request events.\r
 \r
 - ULLONG TS\r
@@ -91,6 +98,7 @@ description : statistics about neighboring cell RSRP aggregated by GNB, as compu
 \r
 \r
 name: erab_stats\r
+\r
 description: number of admitted bearers and the distribution of their qCI\r
 \r
 - ULLONG TS\r
@@ -109,6 +117,7 @@ description: number of admitted bearers and the distribution of their qCI
 \r
 \r
 name: mc_connected_cnt\r
+\r
 description: Number of dual connected users\r
 \r
 - ULLONG TS\r
@@ -117,6 +126,7 @@ description: Number of dual connected users
 \r
 \r
 name: mc_connection_stats\r
+\r
 description : statistics about the length of dual connected sessions\r
 \r
 - ULLONG TS\r
@@ -130,6 +140,7 @@ description : statistics about the length of dual connected sessions
 \r
 \r
 name: mc_connects_cnt\r
+\r
 description: number of DC connection requests\r
 \r
 - ULLONG TS\r
@@ -138,6 +149,7 @@ description: number of DC connection requests
 \r
 \r
 name: mc_disconnects_cnt\r
+\r
 description: number of DC connection releases\r
 \r
 - ULLONG TS\r
@@ -146,6 +158,7 @@ description: number of DC connection releases
 \r
 \r
 name: mc_unique_ue_cnt\r
+\r
 description: Number of distinct UEs making a DC request or release\r
 \r
 - ULLONG TS\r
@@ -154,6 +167,7 @@ description: Number of distinct UEs making a DC request or release
 \r
 \r
 name: mod_req_failure_distribution\r
+\r
 description: distribution of causes of a modification requet failure\r
 \r
 - ULLONG TS\r
@@ -169,6 +183,7 @@ description: distribution of causes of a modification requet failure
 \r
 \r
 name: reconfig_status_success_rate\r
+\r
 description: fraction of DC connect requests which are successful\r
 \r
 - V_STR GNB_ID\r
@@ -180,6 +195,7 @@ description: fraction of DC connect requests which are successful
 \r
 \r
 name: reconfig_status_reject_cause\r
+\r
 description: distribution of causes for DC rejection\r
 \r
 - V_STR gnb_id\r
@@ -192,6 +208,7 @@ description: distribution of causes for DC rejection
 \r
 \r
 name: mod_status_refuse_cause\r
+\r
 description: distribution of causes for a sgnb modification refusal\r
 \r
 - V_STR GNB_ID\r
@@ -205,6 +222,7 @@ description: distribution of causes for a sgnb modification refusal
 \r
 \r
 name: release_cause\r
+\r
 description: distribution of the causes of a DC release\r
 \r
 - V_STR GNB_ID\r
@@ -218,6 +236,7 @@ description: distribution of the causes of a DC release
 \r
 \r
 name: release_req_success_stats\r
+\r
 description: statistics on the time to delease a DC connection\r
 \r
 - V_STR GNB_ID\r
@@ -232,6 +251,7 @@ description: statistics on the time to delease a DC connection
 \r
 \r
 name: rrcx_pdf_neigh_cell_csi\r
+\r
 description: distribution of the beam csi rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -246,6 +266,7 @@ description: distribution of the beam csi rsrp of neighboring cells, aggregated
 \r
 \r
 name: rrcx_pdf_neigh_gnb_csi\r
+\r
 description: distribution of the beam csi rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -260,6 +281,7 @@ description: distribution of the beam csi rsrp of neighboring cells, aggregated
 \r
 \r
 name: rrcx_pdf_neigh_cell_ssb\r
+\r
 description: distribution of the beam ssb rsrp of neighboring cells, aggregated by cell id, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -274,6 +296,7 @@ description: distribution of the beam ssb rsrp of neighboring cells, aggregated
 \r
 \r
 name: rrcx_pdf_neigh_gnb_ssb\r
+\r
 description: distribution of the beam ssb rsrp of neighboring cells, aggregated by gNB, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -288,6 +311,7 @@ description: distribution of the beam ssb rsrp of neighboring cells, aggregated
 \r
 \r
 name: rrcx_pdf_serv_cell\r
+\r
 description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -302,6 +326,7 @@ description: distribution of the  ssb rsrp of serving cell aggregated by cell id
 \r
 \r
 name: rrcx_pdf_neighbor_cell\r
+\r
 description: distribution of the  ssb rsrp of neighbor cells aggregated by cell id, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -316,6 +341,7 @@ description: distribution of the  ssb rsrp of neighbor cells aggregated by cell
 \r
 \r
 name: rrcx_pdf_serv_gnb\r
+\r
 description: distribution of the  ssb rsrp of serving cell aggregated by gnb, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -330,6 +356,7 @@ description: distribution of the  ssb rsrp of serving cell aggregated by gnb, co
 \r
 \r
 name: rrcx_pdf_neighbor_gnb\r
+\r
 description: distribution of the  ssb rsrp of serving cell aggregated by cell id, computed from rrc transfer\r
 \r
 - ULLONG TS\r
@@ -344,6 +371,7 @@ description: distribution of the  ssb rsrp of serving cell aggregated by cell id
 \r
 \r
 name: rrcx_stats_neigh_cell\r
+\r
 description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by cell ID, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -359,6 +387,7 @@ description: statistics on ssb RSRP on the beams of nrighboring cells, aggregate
 \r
 \r
 name: rrcx_stats_neigh_gnb\r
+\r
 description: statistics on ssb RSRP on the beams of nrighboring cells, aggregated by gNB, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -374,6 +403,7 @@ description: statistics on ssb RSRP on the beams of nrighboring cells, aggregate
 \r
 \r
 name: rrcx_stats_serv_cell\r
+\r
 description: statistics on the ssb rsrp of the serving cell, aggregated by cell id, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -389,6 +419,7 @@ description: statistics on the ssb rsrp of the serving cell, aggregated by cell
 \r
 \r
 name: rrcx_stats_neighbor_cell\r
+\r
 description: statistics on the ssb rsrp of the neighbor cells, aggregated by cell id, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -404,6 +435,7 @@ description: statistics on the ssb rsrp of the neighbor cells, aggregated by cel
 \r
 \r
 name: rrcx_stats_serv_gnb\r
+\r
 description: statistics on the ssb srp of the serving cell, aggregated by gNB, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -419,6 +451,7 @@ description: statistics on the ssb srp of the serving cell, aggregated by gNB, c
 \r
 \r
 name: rrcx_stats_neighbor_gnb\r
+\r
 description: statistics on the ssb rsrp of the neighbor cells, aggregated by gNB, computed using rrc transfer\r
 \r
 - ULLONG TS\r
@@ -434,6 +467,7 @@ description: statistics on the ssb rsrp of the neighbor cells, aggregated by gNB
 \r
 \r
 name: throughput_rollup\r
+\r
 description: statistics on the per-UE throughput\r
 \r
 - ULLONG TS\r
@@ -452,6 +486,7 @@ description: statistics on the per-UE throughput
 \r
 \r
 name: throughput_gnb\r
+\r
 description: throughput experienced by a GNB over a measurement interval. "Active" throughput is throughput while actively downloading, "average" averages bytes transfered over the measurement interval\r
 \r
 - ULLONG TS\r