Aether-3028 updating screenshots in Operations
Change-Id: I2f9cd147d42d161af5528860f512cd1f64155bed
diff --git a/dict.txt b/dict.txt
index af1dc65..e8aba39 100644
--- a/dict.txt
+++ b/dict.txt
@@ -107,6 +107,7 @@
differentiator
disaggregated
dl
+doesn
downlink
dropdown
elmerf
diff --git a/operations/images/aether-roc-gui-add-vcs.png b/operations/images/aether-roc-gui-add-vcs.png
index 6c01949..25e2880 100644
--- a/operations/images/aether-roc-gui-add-vcs.png
+++ b/operations/images/aether-roc-gui-add-vcs.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-basket-view-history.png b/operations/images/aether-roc-gui-basket-view-history.png
new file mode 100644
index 0000000..d8d6ddc
--- /dev/null
+++ b/operations/images/aether-roc-gui-basket-view-history.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-basket-view-new-range.png b/operations/images/aether-roc-gui-basket-view-new-range.png
index 98884f7..480145a 100644
--- a/operations/images/aether-roc-gui-basket-view-new-range.png
+++ b/operations/images/aether-roc-gui-basket-view-new-range.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-devicegroup-add.png b/operations/images/aether-roc-gui-devicegroup-add.png
index 2ac66be..4904bea 100644
--- a/operations/images/aether-roc-gui-devicegroup-add.png
+++ b/operations/images/aether-roc-gui-devicegroup-add.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-devicegroup-edit.png b/operations/images/aether-roc-gui-devicegroup-edit.png
index f9ca841..763ba35 100644
--- a/operations/images/aether-roc-gui-devicegroup-edit.png
+++ b/operations/images/aether-roc-gui-devicegroup-edit.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-devicegroup-monitor.png b/operations/images/aether-roc-gui-devicegroup-monitor.png
index b83be30..20371d9 100644
--- a/operations/images/aether-roc-gui-devicegroup-monitor.png
+++ b/operations/images/aether-roc-gui-devicegroup-monitor.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-devicegroups-list.png b/operations/images/aether-roc-gui-devicegroups-list.png
index 1abf3a0..ce87669 100644
--- a/operations/images/aether-roc-gui-devicegroups-list.png
+++ b/operations/images/aether-roc-gui-devicegroups-list.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-sites-list.png b/operations/images/aether-roc-gui-sites-list.png
index a51cf2f..d06139a 100644
--- a/operations/images/aether-roc-gui-sites-list.png
+++ b/operations/images/aether-roc-gui-sites-list.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
index 45cada2..a5836e6 100644
--- a/operations/images/aether-roc-gui-vcs-edit-showing-app-dg.png
+++ b/operations/images/aether-roc-gui-vcs-edit-showing-app-dg.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-vcs-edit.png b/operations/images/aether-roc-gui-vcs-edit.png
index dda9994..d61f5c3 100644
--- a/operations/images/aether-roc-gui-vcs-edit.png
+++ b/operations/images/aether-roc-gui-vcs-edit.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-vcs-list.png b/operations/images/aether-roc-gui-vcs-list.png
index db1361f..356e38d 100644
--- a/operations/images/aether-roc-gui-vcs-list.png
+++ b/operations/images/aether-roc-gui-vcs-list.png
Binary files differ
diff --git a/operations/images/aether-roc-vcs-monitor.png b/operations/images/aether-roc-vcs-monitor.png
index 2c75164..69b25a8 100644
--- a/operations/images/aether-roc-vcs-monitor.png
+++ b/operations/images/aether-roc-vcs-monitor.png
Binary files differ
diff --git a/operations/subscriber.rst b/operations/subscriber.rst
index e908760..d3e3503 100644
--- a/operations/subscriber.rst
+++ b/operations/subscriber.rst
@@ -6,7 +6,7 @@
======================================
Subscriber management includes workflows associated with provisioning new subscribers, removing
-existing subscribers, and associating subscribers with virtual connectivity services.
+existing subscribers, and associating subscribers with Virtual Connectivity Services (VCS).
.. note::
This section refers to a fully installed ROC GUI, properly secured and with Enterprises, Connectivity Services
@@ -72,17 +72,15 @@
The Site details can be seen by navigating to the Site list view.
-.. image:: images/aether-roc-gui-sites-list.png
- :width: 755
- :alt: Sites List View in Aether ROC GUI showing site details
+|SITE-LIST|
In the ROC GUI, navigate to the Device Groups list view, to see the list of
Device Groups and their association to Sites.
- |DEVICEGROUP-LIST|
+|DEVICEGROUP-LIST|
-In the DeviceGroup *New York POS* example above an IMSI Range **store** of
-**70-73** will mean the set of IMSI IDs (when the *format* specifier of the
+In the DeviceGroup *New York POS* example above an UE ID Range **store** of
+**70-73** will mean the set of UE IDs (when the *format* specifier of the
*starbucks-newyork* Site are applied to its *MCC*, *MNC* and *Enterprise*) of
* 021032002000070 (021-032-002-000070)
@@ -97,17 +95,19 @@
Editing
*******
-Edit the DeviceGroup by clicking on the Edit icon, and in the Edit page,
-adjust an existing range or create a new range (by clicking on the `+` icon).
+Edit the DeviceGroup by clicking on the Edit icon, and in the List page,
+adjust an existing UE ID range or create a new range (by clicking on the `+` icon).
- |DEVICEGROUP-EDIT|
+|DEVICEGROUP-EDIT|
The following restrictions apply
-#. The IMSI ID specified in "from" or "to" is relative to *MCC*, *MNC* and *Enterprise* of the Site.
+#. The "end" value must be greater than or equal to the "start" value. If the 2 are equal then this constitutes
+ a range of size 1.
+#. The IMSI ID specified in "start" or "end" is relative to *MCC*, *MNC* and *Enterprise* of the Site.
#. The maximum value of an IMSI ID is defined by the number of **S** characters in the `format` specifier of the Site.
#. IMSI Ranges are contiguous ranges of IMSI IDs. To accommodate non contiguous IMSI IDs, add extra Ranges.
-#. IMSI Ranges can have a maximum span of 100 between "from" and "to" IMSI IDs. Break bigger spans in to many ranges.
+#. IMSI Ranges can have a maximum span of 100 between "start" and "end" IMSI IDs. Break bigger spans in to many ranges.
#. IMSI ranges within a DeviceGroup cannot not overlap.
When the entries on the DeviceGroup edit page are valid the **Update** will become available
@@ -125,14 +125,21 @@
**********
To commit the changes
-#. click on the **Basket** icon (2nd icon from top right) to see the Basket view
-#. inspect the changes to be committed (optional)
-#. click **commit** to perform the commit
-#. observe the response that's temporarily displayed that shows the success or failure of the commit
+#. Click on the **Basket** icon (2nd icon from top right) to see the Basket view
+#. Inspect the changes to be committed (optional)
+#. Click **Commit** to perform the commit
+#. Observe the response that's temporarily displayed that shows the success or failure of the commit
-.. image:: images/aether-roc-gui-basket-view-new-range.png
- :width: 635
- :alt: Basket View with some changes ready to be committed
+|BASKETVIEW-NEWRANGE|
+
+History
+*******
+If you are an Aether ROC Administrator, you will be able to see the History of changes, from the *Basket View* by
+clicking on the **History** button.
+
+|BASKETVIEW-HISTORY|
+
+.. note:: The *History* button will only be visible if you are in the **AetherROCAdmin** group.
Remove Connectivity Service from an existing UE
-----------------------------------------------
@@ -146,9 +153,10 @@
click the *trash can* icon next to that *IMSI Range* and
use the *+* icon to add new Ranges for the remaining IMSI IDs.
* Alternatively if the UE to be removed has an IMSI ID at the start or end of an existing IMSI Range:
- then adjust the *from* or *to* value accordingly.
+ then adjust the **start** or **end** value accordingly.
+* Once finished editing, proceed to the *Basket View*, inspect the changes and Commit.
- |DEVICEGROUP-EDIT|
+|DEVICEGROUP-EDIT|
.. note::
The UE may continue to have connectivity until its next detach/attach cycle.
@@ -158,20 +166,18 @@
DeviceGroups allow UEs to be grouped and configured together. Each site comes preconfigured with
a default DeviceGroup, but additional DeviceGroups may be created. For example, placing all IP
-Cameras in an my-site-ip-cameras DeviceGroup would allow you to group IP Cameras together.
+Cameras in an "my-site-ip-cameras" DeviceGroup would allow you to group IP Cameras together.
To add a DeviceGroup, navigate to the list of DeviceGroups and click `Add` in the upper right.
(This may be grayed out if you do not have appropriate permissions).
* Specify a unique **id** for the DeviceGroup
40 characters max and only alphanumeric and `-`, `_` and `.` allowed
-* Choose a *Site* from the list of preconfigured list
+* Choose a *Site* from the preconfigured list
It will not be possible to add IMSI Ranges until the Site is chosen
-* IMSI Ranges can be added at this stage or later
+* UE ID Ranges can be added at this stage or later
-.. image:: images/aether-roc-gui-devicegroup-add.png
- :width: 490
- :alt: Adding a new Device Group requires an *id* and choosing a Site
+|DEVICEGROUP-ADD|
Delete a DeviceGroup
--------------------
@@ -187,7 +193,7 @@
next to it. The deletion is added to the **Basket** directly. Navigate to the *Basket View*
to commit the change.
- |DEVICEGROUP-LIST|
+|DEVICEGROUP-LIST|
Add a DeviceGroup to a Virtual Connectivity Service (VCS)
@@ -198,7 +204,7 @@
Navigate to the *VCS* list view to see the list of VCS's and their associations to DeviceGroups.
- |VCS-LIST|
+|VCS-LIST|
To edit a *VCS* click on the *edit* button next to it in this list.
@@ -207,12 +213,10 @@
* Click the *trash can* symbol to remove a DeviceGroup from the VCS
* Click the *+* icon to add a DeviceGroup
-* Click the *Allow* slider to Allow or Disallow the DeviceGroup
- This is a way of disabling or reenabling the DeviceGroup within a VCS without having to remove it
+* Click the *Enable* slider to Enable or Disable the DeviceGroup
+ * This is a way of disabling or reenabling the DeviceGroup within a VCS without having to remove it
-.. image:: images/aether-roc-gui-vcs-edit.png
- :width: 562
- :alt: VCS Edit View in Aether ROC GUI showing DeviceGroup association editing
+|VCS-EDIT|
Remove a DeviceGroup from a Virtual Connectivity Service (VCS)
--------------------------------------------------------------
@@ -258,14 +262,34 @@
:width: 28
:alt: Monitor icon
+.. |DEVICEGROUP-ADD| image:: images/aether-roc-gui-devicegroup-add.png
+ :width: 490
+ :alt: Adding a new Device Group requires an *id* and choosing a Site
+
.. |DEVICEGROUP-LIST| image:: images/aether-roc-gui-devicegroups-list.png
- :width: 755
+ :width: 1000
:alt: Device Groups List View in Aether ROC GUI showing Site association and IMSI Range of all DeviceGroups
.. |DEVICEGROUP-EDIT| image:: images/aether-roc-gui-devicegroup-edit.png
- :width: 755
+ :width: 700
: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
+
+.. |VCS-EDIT| image:: images/aether-roc-gui-vcs-edit.png
+ :width: 700
+ :alt: VCS Edit View in Aether ROC GUI showing DeviceGroup association editing
+
+.. |BASKETVIEW-NEWRANGE| image:: images/aether-roc-gui-basket-view-new-range.png
+ :width: 635
+ :alt: Basket View with some changes ready to be committed
+
+.. |BASKETVIEW-HISTORY| image:: images/aether-roc-gui-basket-view-history.png
+ :width: 800
+ :alt: Basket View with history of last changes
+
+.. |SITE-LIST| image:: images/aether-roc-gui-sites-list.png
+ :width: 755
+ :alt: Sites List View in Aether ROC GUI showing site details
diff --git a/operations/vcs.rst b/operations/vcs.rst
index e27fee4..801f39f 100644
--- a/operations/vcs.rst
+++ b/operations/vcs.rst
@@ -10,18 +10,19 @@
To define a VCS requires it to be associated with:
-* one or more **Application**
+* an Enterprise
+* a Site
+* one or more **Filter** (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)
+* **Default Behavior** (for Application Filtering)
+* **Uplink** (data rate in bps)
+* **Downlink** (data rate in bps)
Provisioning a new VCS
----------------------
@@ -37,25 +38,29 @@
To add a new VCS, click the **Add** button in the VCS List View.
- |VCS-LIST|
+|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).
+#. Enter a VCS ID (this must be unique across the whole system).
+#. Enter a Display Name (optional).
+#. Enter a Description (optional).
+#. Choose an Enterprise (may already have been selected)
+#. Choose a Site
#. 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.
+#. Accept the Default Behavior, SD and SST, and Uplink and Downlink values or change them.
#. Choose a *UPF* from the drop down list.
+ * UPFs will previously have been added to a pool - those remaining unused will appear for selection.
+
.. 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
+One or more Filters (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:
@@ -72,24 +77,23 @@
-----------------------
When editing an existing VCS, it will not be possible to change:
-* the **id**
-* the **template** or any of the parameters beneath it
+* The **id**.
+* The **template** or the *SD* or *SST* parameters beneath it.
-Existing *Applications* or *DeviceGroups* can be removed by clicking the *trash can* icon next to it.
+Existing *Filters* 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
+Alternatively existing *Filters* 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.
+.. note:: The *DeviceGroup* or *Filter* and *UPF* here are *references*. If the underlying object 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|
+|VCS-LIST|
Monitoring a VCS
----------------
@@ -102,18 +106,11 @@
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
+* A link to the Monitoring page of each Device Group. See :ref:`monitor_device_group`.
* 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
