From 022e622901793b2ac6c2039f3382ee793b4aab88 Mon Sep 17 00:00:00 2001
From: wwatson <w@vulk.co>
Date: Mon, 1 Jan 2024 17:12:45 -0600
Subject: [PATCH] #1848 Update CNF_TESTSUITE_YML_USAGE.md

Signed-off-by: wwatson <w@vulk.co>
---
 CNF_TESTSUITE_YML_USAGE.md | 153 +++++++++++++++++++++++++++++++++++++
 1 file changed, 153 insertions(+)

diff --git a/CNF_TESTSUITE_YML_USAGE.md b/CNF_TESTSUITE_YML_USAGE.md
index acbaa49af..4eea4b2e1 100644
--- a/CNF_TESTSUITE_YML_USAGE.md
+++ b/CNF_TESTSUITE_YML_USAGE.md
@@ -177,3 +177,156 @@ For an image registry service named `foobar`, running in `default` namespace, on
 ```yaml
 docker_insecure_registries: ["foobar.default.svc.cluster.local:5000"]
 ```
+### RAN cofiguration
+
+#### `ric_label`
+
+The ran tests expect a ric to be configured under the ric_label.  The entry must be the k8s label which is most likely a full key/value identification.
+
+For a ric named `flexrric`, under the label key `app.kubernetes.io/name` the following would be the expected configuration.
+
+```yaml
+ric_label:  app.kubernetes.io/name=flexric
+```
+### Open5gs and UERANSIM configuration
+
+#### mmc
+
+Mobile Country Code. This identifies the country of the mobile subscriber. In this case, '999' is a test code.
+
+```yaml
+dmmc: '999
+```
+#### mnc
+
+Mobile Network Code. This identifies the mobile network within the country specified by the MCC. '70' is a test code.
+```yaml
+mnc: '70'
+```
+
+#### sst
+
+Single-NEC Single Radio Voice Call Continuity. This value indicates the type of services a Slice/Session should support.
+
+```yaml
+sst: 1
+```
+
+#### sd
+
+Slice Differentiator. This is used to differentiate between different slices within the same SST.
+
+```yaml
+sd: '0x111111'
+```
+
+#### tac
+
+Tracking Area Code. This is used for paging procedures and to manage mobility between eNBs in LTE.
+
+```yaml
+tac: '0001'
+```
+#### protectionScheme
+
+The type of security protocol being used.
+
+```yaml
+protectionScheme: 1
+```
+#### publicKey
+
+This is the public key used in asymmetric encryption.
+
+```yaml
+publicKey: 0ac95ceeb93308df01be82ff9994d8330e38804ece1700ee4b972d8028796275
+```
+
+#### publicKeyId
+
+Identifier for the public key.
+
+```yaml
+publicKeyId: 1:
+```
+
+#### routingIndicator
+
+This is used to route messages in the network.
+
+```yaml
+routingIndicator: '0000'
+```
+
+#### enabled
+
+Indicates whether the network is currently enabled or not.
+
+```yaml
+enabled: true
+```
+
+#### count
+
+Used in UERANSIM to specify the number of entities (like User Equipment or UEs) to be simulated.
+
+```yaml
+count: 1
+```
+
+#### initialMSISDN
+
+This MSISDN is a unique number that identifies a subscription in a GSM or a UMTS mobile network.
+
+```yaml
+initialMSISDN: '0000000001'
+```
+
+#### key
+
+Cryptographic key used in the network.
+
+```yaml
+key: 465B5CE8B199B49FAA5F0A2EE238A6BC:
+```
+
+#### op
+
+The operator variant algorithm configuration field. Used in conjunction with the key for security purposes.
+
+```yaml
+op: E8ED289DEBA952E4283B54E88E6183CA
+```
+
+#### opType
+
+Indicates that the operator variant algorithm is in use.
+
+```yaml
+opType: OPC
+```
+
+#### type
+
+The type of IP addresses being used in the network.
+
+```yaml
+type: 'IPv4'
+```
+
+#### apn
+
+Access Point Name. This is the name of a gateway between a GPRS, 3G or 4G mobile network and another computer network, frequently the public internet.
+
+```yaml
+apn: 'internet'
+```
+
+#### emergency:
+
+Indicates whether this is an emergency APN.
+
+```yaml
+emergency: false
+```
+