AETHER-2047 Adding page for VCS management
Also
* fixed problems in "index.rst"
* removed unused "sop.rst"
* updated "dictionary"
* added details of DeviceGroup "monitoring"
Change-Id: Ie76076defec5b29238ca93723b398e5d4aa1b8af
diff --git a/operations/images/aether-roc-gui-add-vcs.png b/operations/images/aether-roc-gui-add-vcs.png
new file mode 100644
index 0000000..6c01949
--- /dev/null
+++ b/operations/images/aether-roc-gui-add-vcs.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-devicegroup-monitor.png b/operations/images/aether-roc-gui-devicegroup-monitor.png
new file mode 100644
index 0000000..b83be30
--- /dev/null
+++ b/operations/images/aether-roc-gui-devicegroup-monitor.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-ue-monitor.png b/operations/images/aether-roc-gui-ue-monitor.png
new file mode 100644
index 0000000..208b4da
--- /dev/null
+++ b/operations/images/aether-roc-gui-ue-monitor.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-vcs-edit-showing-app-dg.png b/operations/images/aether-roc-gui-vcs-edit-showing-app-dg.png
new file mode 100644
index 0000000..45cada2
--- /dev/null
+++ b/operations/images/aether-roc-gui-vcs-edit-showing-app-dg.png
Binary files differ
diff --git a/operations/images/aether-roc-vcs-monitor.png b/operations/images/aether-roc-vcs-monitor.png
new file mode 100644
index 0000000..2c75164
--- /dev/null
+++ b/operations/images/aether-roc-vcs-monitor.png
Binary files differ
diff --git a/operations/images/monitor-icon.png b/operations/images/monitor-icon.png
new file mode 100644
index 0000000..046b231
--- /dev/null
+++ b/operations/images/monitor-icon.png
Binary files differ
diff --git a/operations/sop.rst b/operations/sop.rst
deleted file mode 100644
index 94fd81a..0000000
--- a/operations/sop.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-..
- SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
- SPDX-License-Identifier: Apache-2.0
-
-Standard Operating Procedures
-=============================
-
-
diff --git a/operations/subscriber.rst b/operations/subscriber.rst
index 63fb195..87ea6f5 100644
--- a/operations/subscriber.rst
+++ b/operations/subscriber.rst
@@ -56,6 +56,8 @@
TODO: This file will probably be placed under gitops control once the 5G ROC is deployed. Document
the new location of the file.
+.. _configure_device_group:
+
Configure Connectivity Service for a new UE
-------------------------------------------
@@ -113,6 +115,8 @@
The changes are not committed to **aether-config** until the **Basket** is committed.
This allows several changes to be gathered together in one transaction and checked before committing.
+.. _committing:
+
Committing
**********
To commit the changes
@@ -190,9 +194,7 @@
Navigate to the *VCS* list view to see the list of VCS's and their associations to DeviceGroups.
-.. image:: images/aether-roc-gui-vcs-list.png
- :width: 920
- :alt: VCS List View in Aether ROC GUI showing DeviceGroup association
+ |VCS-LIST|
To edit a *VCS* click on the *edit* button next to it in this list.
@@ -213,6 +215,45 @@
The procedure is covered in the above section.
+.. _monitor_device_group:
+
+Monitoring a DeviceGroup
+------------------------
+
+The performance of a Device Group can be monitored in many ways, by clicking its |monitor| (**monitor**) icon:
+
+* From the *VCS Monitor* page, which shows all DeviceGroup's belonging to an VCS.
+* From the DeviceGroup List Page - click the |monitor| icon for the DeviceGroup.
+* When editing an existing DeviceGroup - in the Edit page, the |monitor| is next to the *id*
+
+The *monitor* page itself shows:
+
+* An information Panel for each *IMSI Range* in the *DeviceGroup*
+
+ * Each UE has a |monitor| button that allows further drill down
+ * Each UE is shown with its fully expanded IMSI number (a combination of *Imsi ID* and *Site* parameters)
+* An information panel for the *Site* and *IP Domain* of the *DeviceGroup*
+
+ * Clicking on the down arrow expands each panel
+
+.. image:: images/aether-roc-gui-devicegroup-monitor.png
+ :width: 600
+ :alt: DeviceGroup Monitor View with UE links and information panels
+
+The per UE Monitor panel contains:
+
+* a graph of the UE's Throughput and Latency over the last 15 minutes
+* a graph of the UE's connectivity over the last 15 minutes
+
+.. image:: images/aether-roc-gui-ue-monitor.png
+ :width: 600
+ :alt: DeviceGroup Monitor View with UE links and information panels
+
+
+.. |monitor| image:: images/monitor-icon.png
+ :width: 28
+ :alt: Monitor icon
+
.. |DEVICEGROUP-LIST| image:: images/aether-roc-gui-devicegroups-list.png
:width: 755
:alt: Device Groups List View in Aether ROC GUI showing Site association and Imsi Range of all DeviceGroups
@@ -220,3 +261,7 @@
.. |DEVICEGROUP-EDIT| image:: images/aether-roc-gui-devicegroup-edit.png
:width: 755
:alt: Device Groups Edit View in Aether ROC GUI showing Imsi Range
+
+.. |VCS-LIST| image:: images/aether-roc-gui-vcs-list.png
+ :width: 920
+ :alt: VCS List View in Aether ROC GUI showing DeviceGroup association
diff --git a/operations/vcs.rst b/operations/vcs.rst
new file mode 100644
index 0000000..2c87613
--- /dev/null
+++ b/operations/vcs.rst
@@ -0,0 +1,128 @@
+..
+ SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+ SPDX-License-Identifier: Apache-2.0
+
+VCS Management
+==============
+
+A **VCS** (Virtual Cellular Service) is a slice of network access for a set of UEs with a defined set of
+QOS parameters.
+
+To define a VCS requires it to be associated with:
+
+* one or more **Application**
+* one or more **DeviceGroup**
+* an **AccessPointList**
+* a **UPF**
+* a **TrafficClass**
+
+and must also be created with attributes like:
+
+* **SD** (slice differentiator)
+* **SST** (slice/service type)
+* **Uplink** (data rate in mbps)
+* **Downlink** (data rate in mbps)
+
+Provisioning a new VCS
+----------------------
+
+.. note::
+ This section refers to a fully installed ROC GUI, properly secured and with Enterprises, Connectivity Services
+ Applications, and Sites already configured by a ROC Administrator. The examples shown below are taken from an example
+ configuration shipped with the ROC - the "MEGA Patch" (see :ref:`posting-the-mega-patch`)
+
+This procedure assumes you have already set up one or more DeviceGroups, containing
+configuration for a number of UEs. Follow the procedure in :ref:`configure_device_group`
+to configure DeviceGroups.
+
+To add a new VCS, click the **Add** button in the VCS List View.
+
+ |VCS-LIST|
+
+In the resulting VCS edit page:
+
+#. enter a VCS ID (this must be unique across the whole system).
+#. enter a Display Name (optional).
+#. enter a Description (optional).
+#. Choose a template
+
+ * this will copy over values from that template, which may be edited individually at this create stage
+ * they will not be editable afterwards.
+#. Choose an *Access Point List* from the drop down list.
+#. Choose a *UPF* from the drop down list.
+
+.. image:: images/aether-roc-gui-add-vcs.png
+ :width: 500
+ :alt: VCS Edit page adding a new VCS
+
+One or more Applications and or DeviceGroups can be associated with the VCS at this
+stage or later, by clicking on the *+* icon.
+
+When chosen, they appear as a list in the VCS edit page, and are automatically enabled/allowed:
+
+.. image:: images/aether-roc-gui-vcs-edit-showing-app-dg.png
+ :width: 300
+ :alt: VCS Edit showing Application and Device Group choice lists
+
+Click on the "Update" to add these changes to the *Basket*.
+
+Click the **Commit** in the *Basket View* to commit the changes. See :ref:`committing`.
+
+Editing an existing VCS
+-----------------------
+When editing an existing VCS, it will not be possible to change:
+
+* the **id**
+* the **template** or any of the parameters beneath it
+
+Existing *Applications* or *DeviceGroups* can be removed by clicking the *trash can* icon next to it.
+
+Alternatively existing *Applications* or *DeviceGroups* can be *disabled/disallowed* by clicking the slider
+next to it. This will have the same effect as disabling it.
+
+If one of the *DeviceGroup*s or *Application*s, *Access Point List*, *Traffic Class* or *UPF*
+itself is modified, then the changes on the VCS will take effect whenever changes to those
+objects are committed.
+
+Removing a VCS
+--------------
+Removing a VCS can be achieved by clicking the *trash can* icon next to the VCS in the
+VCS List page
+
+ |VCS-LIST|
+
+Monitoring a VCS
+----------------
+
+The performance of a VCS can be monitored in many ways, by clicking its |monitor| (**monitor**) icon:
+
+* From the **Dashboard** page, which shows all VCS's belonging to an Enterprise.
+* From the VCS List Page - click the |monitor| icon for the VCS.
+* When editing an existing VCS - in the Edit page, the |monitor| is next to the *id*
+
+The *monitor* page itself shows:
+
+* A stacked bar graph of the Connectivity count of UEs over the last 15 minutes
+
+ * This shows the count of UE in the 3 different states - Active, Inactive and Idle
+* A line graph of the Throughput, Latency and Jitter of the VCS over the last 15 minutes
+* The live Throughput, Latency and Jitter values
+* Information panels for each sub-object of the VCS
+
+ * Clicking on the down arrow expands each panel
+
+The DeviceGroup(s) associated with the VCS has itself a |monitor| button that allows
+monitoring of each DeviceGroup. See :ref:`monitor_device_group`.
+
+.. image:: images/aether-roc-vcs-monitor.png
+ :width: 920
+ :alt: VCS Monitor View with Connectivity and Performance Charts
+
+
+.. |VCS-LIST| image:: images/aether-roc-gui-vcs-list.png
+ :width: 920
+ :alt: VCS List View in Aether ROC GUI
+
+.. |monitor| image:: images/monitor-icon.png
+ :width: 28
+ :alt: Monitor icon
