AETHER-3328 Reorganize guide for better flow; App filtering screenshots
Change-Id: I1051c3816f8c28e537b29ae1704f6faffb4bdc99
diff --git a/advanced/images/subproxy.svg b/amp/images/subproxy.svg
similarity index 100%
rename from advanced/images/subproxy.svg
rename to amp/images/subproxy.svg
diff --git a/amp/monitoring.rst b/amp/monitoring.rst
index b9d2ff4..7ce3dd5 100644
--- a/amp/monitoring.rst
+++ b/amp/monitoring.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2021 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-Monitoring and Alerts
-=====================
+Monitoring and Alert Infrastructure
+===================================
Aether leverages `Prometheus <https://prometheus.io/docs/introduction/overview/>`_ to collect
and store platform and service metrics, `Grafana <https://grafana.com/docs/grafana/latest/getting-started/>`_
diff --git a/advanced/subproxy.rst b/amp/subproxy.rst
similarity index 100%
rename from advanced/subproxy.rst
rename to amp/subproxy.rst
diff --git a/index.rst b/index.rst
index c15b90d..0ae8159 100644
--- a/index.rst
+++ b/index.rst
@@ -64,30 +64,30 @@
.. toctree::
:maxdepth: 3
- :caption: Operations
- :hidden:
- :glob:
-
- operations/procedures
- operations/gui
- operations/subscriber
- operations/slice
- operations/monitor
- advanced/appfilter
- advanced/metering
- advanced/subproxy
-
-.. toctree::
- :maxdepth: 3
:caption: Aether Management Platform
:hidden:
:glob:
amp/roc
+ amp/subproxy
amp/monitoring
.. toctree::
:maxdepth: 3
+ :caption: Operations
+ :hidden:
+ :glob:
+
+ operations/gui
+ operations/subscriber
+ operations/application
+ operations/slice
+ operations/metering
+ operations/monitor
+ operations/procedures
+
+.. toctree::
+ :maxdepth: 3
:caption: Aether Test Automation
:hidden:
:glob:
diff --git a/advanced/appfilter.rst b/operations/application.rst
similarity index 61%
rename from advanced/appfilter.rst
rename to operations/application.rst
index de0ede7..228de33 100644
--- a/advanced/appfilter.rst
+++ b/operations/application.rst
@@ -2,10 +2,10 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-Application Filtering
-=====================
+Application Management
+======================
-Application filtering allows configuration of the application endpoints that a
+Aether allows configuration of the application endpoints that a
device is allowed to connect to. Configuration is possible of not only whether an
application endpoint is reachable or not, but also what maximum bitrate and traffic
class should be associated with that endpoint.
@@ -19,12 +19,24 @@
ALLOW-ALL, DENY-ALL, or ALLOW-PUBLIC. ALLOW-PUBLIC is a special rule that denies traffic
to private IPv4 networks (as per RFC1918) and then allows everything else.
-Configuring Applications
-------------------------
+Creating Applications
+---------------------
-Begin by creating Applications. Each application has an address field which may be
+Begin by creating Applications. Start by going to the application page, and
+clicking the add button.
+
+|app-list|
+
+This will open a page where application details may be specified:
+
+|app-add|
+
+Each application has an address field which may be
set to an IPv4 address or an IPv4 subnet, which may in turn match several IPv4
-addresses. Once the address is set, move on to creating endpoints.
+addresses. Once the address is set, move on to creating endpoints. Press the plus
+button to add an endpoint.
+
+|app-add-endpoint|
Each endpoint is a port range, specified by its start and end port. A range of
exactly one port is also acceptable. The protocol may be set to either TCP or UDP. Each
@@ -32,13 +44,25 @@
maximum bitrate is per-device to the application; it is not the sum of all devices to the
application.
+Once all endpoints have been added, they will be summarized on the application page. Update
+and commit the changes.
+
+|app-add-update|
+
Adding Applications to Slices
-----------------------------
Each Slice has an application filter, which is a list of applications. Each entry
in this list has a priority and an allow|deny setting. Keep in mind that the total
number of endpoints for all applications attached to the Slice must be less than or
-equal to five.
+equal to five. Start by opening up the slice and clicking the plus button next to the
+Filter list.
+
+|app-filter-slice-edit-filter-plus|
+
+Choose an application and select a priority for it.
+
+|slice-filter-popup|
Also configurable for the Slice is the default-behavior, which will automatically
be evaluated at the lowest priority, only taking effect if no other rule matches.
@@ -61,3 +85,30 @@
traffic to all other hosts on the IPv4 subnet 10.0.0.0/24. Ports other than
8000 on 10.0.0.1 would be denied, as would protocols other than TCP. Traffic to
subnets other than 10.0.0.0/24 would be allowed.
+
+.. |app-list| image:: images/aether-roc-gui-application-list.png
+ :alt: List of applications
+ :width: 1000
+
+.. |app-add| image:: images/aether-roc-gui-application-add.png
+ :alt: Add an application
+ :width: 800
+
+.. |app-add-endpoint| image:: images/aether-roc-gui-application-add-endpoint.png
+ :alt: Add an application endpoint
+ :width: 600
+
+.. |app-add-update| image:: images/aether-roc-gui-application-add-update.png
+ :alt: Ready to update and commit the application
+ :width: 800
+
+.. |app-filter-slice-edit-filter-plus| image:: images/aether-roc-gui-slice-edit-filter-plus.png
+ :alt: Slice edit page, ready to add a filter
+ :width: 800
+
+.. |slice-filter-popup| image:: images/aether-roc-gui-slice-filter-popup.png
+ :alt: Popup to add or edit an application filter
+ :width: 600
+
+
+
diff --git a/operations/images/aether-roc-gui-application-add-endpoint.png b/operations/images/aether-roc-gui-application-add-endpoint.png
new file mode 100755
index 0000000..e783278
--- /dev/null
+++ b/operations/images/aether-roc-gui-application-add-endpoint.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-application-add-update.png b/operations/images/aether-roc-gui-application-add-update.png
new file mode 100755
index 0000000..f183be7
--- /dev/null
+++ b/operations/images/aether-roc-gui-application-add-update.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-application-add.png b/operations/images/aether-roc-gui-application-add.png
new file mode 100755
index 0000000..ef6ed2f
--- /dev/null
+++ b/operations/images/aether-roc-gui-application-add.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-application-list.png b/operations/images/aether-roc-gui-application-list.png
new file mode 100755
index 0000000..24b6c35
--- /dev/null
+++ b/operations/images/aether-roc-gui-application-list.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-slice-edit-filter-plus.png b/operations/images/aether-roc-gui-slice-edit-filter-plus.png
new file mode 100755
index 0000000..8bd6061
--- /dev/null
+++ b/operations/images/aether-roc-gui-slice-edit-filter-plus.png
Binary files differ
diff --git a/operations/images/aether-roc-gui-slice-filter-popup.png b/operations/images/aether-roc-gui-slice-filter-popup.png
new file mode 100755
index 0000000..94a731c
--- /dev/null
+++ b/operations/images/aether-roc-gui-slice-filter-popup.png
Binary files differ
diff --git a/advanced/images/qos-metering.svg b/operations/images/qos-metering.svg
similarity index 100%
rename from advanced/images/qos-metering.svg
rename to operations/images/qos-metering.svg
diff --git a/advanced/metering.rst b/operations/metering.rst
similarity index 100%
rename from advanced/metering.rst
rename to operations/metering.rst
diff --git a/operations/procedures.rst b/operations/procedures.rst
index 909ed39..0f2788e 100644
--- a/operations/procedures.rst
+++ b/operations/procedures.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-General Procedures
-==================
+Other Procedures
+================
Edge shutdown procedure
-----------------------
diff --git a/operations/subscriber.rst b/operations/subscriber.rst
index e7356ec..bcc8435 100644
--- a/operations/subscriber.rst
+++ b/operations/subscriber.rst
@@ -2,8 +2,8 @@
SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
SPDX-License-Identifier: Apache-2.0
-Subscriber and Connectivity Management
-======================================
+Subscriber and Device Management
+================================
Subscriber management includes workflows associated with provisioning new subscribers, removing
existing subscribers, and associating subscribers with slices.
@@ -130,9 +130,8 @@
*till-pos-1* and *till-pos-2*.
.. note::
- For 4G service, a Device may participate in at most one DeviceGroup, and that DeviceGroup may
- participate in at most one Slice. For 5G service, a Device can participate in many DeviceGroups, and each
- DeviceGroup may participate in many Slices.
+ A Device may participate in at most one DeviceGroup, and that DeviceGroup may
+ participate in at most one Slice.
Editing
*******
