Merge "Update all chart docs to reflect the new installation"
diff --git a/SUMMARY.md b/SUMMARY.md
index ba9b84b..99f6b55 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -68,14 +68,14 @@
* [SEBA-in-a-Box with Fabric Switch](profiles/seba/siab-with-fabric-switch.md)
* [Scale testing with BBSim](profiles/seba/bbsim.md)
* Configure
- * [POD specific configuration](profiles/seba/configuration.md)
+ * [POD configuration](profiles/seba/configuration.md)
* Workflow specific configuration
* [Configure AT&T workflow](profiles/seba/workflows/att-configure.md)
* Operate
* [Disable/Enable an ONU](profiles/seba/operate/onu-ops.md)
* [Edit a Whitelist entry](profiles/seba/operate/whitelist-ops.md)
* [Delete an OLT](profiles/seba/operate/olt-ops.md)
- * [Fix configuration errors](profiles/seba/operate/config-ops.md)
+ * [Runtime configuration](profiles/seba/operate/config-ops.md)
* [Add a cross-connect in the AGG switch](profiles/seba/operate/agg-ops.md)
* [Try a new version of *](profiles/seba/operate/k8s-helm-ops.md)
* [Known Issues](profiles/seba/known-issues.md)
diff --git a/images/diag_overview.png b/images/diag_overview.png
new file mode 100644
index 0000000..9a059c8
--- /dev/null
+++ b/images/diag_overview.png
Binary files differ
diff --git a/navigate.md b/navigate.md
index f307986..56cb057 100644
--- a/navigate.md
+++ b/navigate.md
@@ -12,7 +12,7 @@
* **Kubernetes:** All elements of the CORD control plane run in
Kubernetes containers. CORD assumes a Kubernetes foundation,
- but does not prescribe how Kubernetes (or the underlying hardware)
+ but does not prescribe how Kubernetes or the underlying hardware
are installed.
* **Platform:** The Platform layer consists of ONOS, XOS,
@@ -20,7 +20,7 @@
all running on a Kubernetes foundation. The platform is common
to all Profiles.
-* **Profile:** Each unique CORD configuration corresponds to a
+* **Profile:** Each unique CORD configuration is defined by a
Profile. It consists of a set of services (e.g., access services,
VNFs, other cloud services), including both abstract services
on-boarded into XOS and SDN control apps running on ONOS.
@@ -29,10 +29,12 @@
* **Workflow:** A Profile includes one or more workflows, each of
which defines the business logic and state machine for one of the
- access technologies. A workflow customizes a Profile for the target
- deployment environment; it is not a layer, per se. SEBA's
- [AT&T Workflow](profiles/seba/workflows/att-install.md) is an example.
-
+ access technologies contained in the Profile. A workflow customizes
+ a Profile for the target deployment environment; it is not a
+ software layer, per se. SEBA's
+ [AT&T Workflow](profiles/seba/workflows/att-install.md)
+ is an example.
+
The diagram also shows a hardware bill-of-materials, which must be
defined for a given POD.
diff --git a/operating_cord/diag.md b/operating_cord/diag.md
index 6f45f4c..5e717d0 100644
--- a/operating_cord/diag.md
+++ b/operating_cord/diag.md
@@ -1,5 +1,25 @@
# Monitoring and Logging
CORD is usually configured with monitoring and logging capabilities,
-built around Prometheus and ELK Stack, respectively. Both work on
-events/logs posted to Kafka and display results on a Kibana dashboard.
+built around Prometheus and ELK Stack, respectively. Both consume
+events/metrics/logs posted to Kafka. The data they collect can be
+viewed on their respective dashboards:
+
+* **Metrics:** Collected by [Prometheus](https://prometheus.io/)
+ and viewable using [Grafana](http://docs.grafana.org/) at port 31300.
+
+* **Logs:** Collected by [Elk Stack](https://www.elastic.co/elk-stack)
+ and viewable using
+ [Kibana](https://www.elastic.co/guide/en/kibana/current/index.html)
+ at port 30601.
+
+The following figure give a high-level overview of the monitoring and
+logging system.
+
+![Monitoring and Logging System](../images/diag_overview.png)
+
+The monitoring and logging pipelines both share a Kafka bus, with
+event topics assigned accordingly (e.g., `component.kpis.*` and
+`component.log.*`). Components also post other events to Kafka,
+but their topics are currently ad hoc and rapidly evolving.
+Rationalizing the event schema is on the near-term roadmap.
diff --git a/profiles/seba/operate/config-ops.md b/profiles/seba/operate/config-ops.md
index 10140c8..cbef7be 100644
--- a/profiles/seba/operate/config-ops.md
+++ b/profiles/seba/operate/config-ops.md
@@ -1 +1,58 @@
-# Fixing Config Errors
+# Runtime configuration
+
+There are cases in which you may need to change the POD configuration at runtime.
+
+This page describes how to address some of the most common configuration changes.
+Note that these updates can be done either via TOSCA, GUI or REST API.
+For a reference to the TOSCA format you can look at the
+[POD configuration](../configuration.md) guide, for the REST API documentation you
+can refer to the [REST API](../../../operating_cord/rest_apis.html) documentation.
+
+## I need to change the OLT Port on the Aggregation switch
+
+If you need to connect the OLT to a different port on the aggregation switch,
+you'll need to update the OLT Device model.
+
+Navigate to `vOLT -> OLT Device` and select the OLT you want to update by clicking
+on the magnifier icon. Once you are in the detailed view, locate the `switch port`
+field and update it accordingly:
+
+![OLT Device detail view](./screenshots/olt_detail_view.png "OLT Device detail view")
+
+## I need to change the BNG facing port on the Aggregation switch
+
+If you need to change the BNG connection to the Aggregation switch you'll need to
+change the `dhcpl2relay` app configuration in ONOS as well as the crossconnect
+configuration.
+
+You can refer to the next paragraph to update the `dhcpl2relay` app config,
+while to change the Crossconnect connect configuration you can navigate to
+`Fabric Crossconnect -> BNG Port Mappings` and adjust the `switch port` field
+as shown in figure:
+
+![BNG Port Mapping](./screenshots/bng_mapping.png "BNG Port Mapping")
+
+## I need to change an ONOS App configuration
+
+If you need to change the configuration of an ONOS Application, for example the
+location of the DHCP Server you can follow these steps:
+
+Navigate to `ONOS -> ONOS Application` and select the application you need to
+configure by clicking on the magnifier icon:
+
+![ONOS apps table view](./screenshots/onos_apps_table_view.png "ONOS apps table view")
+
+Once you are in the detailed view, select the `ServiceInstanceAttribute` tab at the top
+
+![ONOS apps detail view attributes](./screenshots/onos_apps_detail_view_attributes.png "ONOS apps detail view attributes")
+
+You'll find a list of configuration associated with that particular ONOS Application,
+to modify one of those, click on the `name` and that will bring you to the detailed
+view:
+
+![ServiceInstanceAttributes detail view](./screenshots/onos_app_config.png "ServiceInstanceAttributes detail view")
+
+You can edit the JSON configuration an click `Save`. The configuration will
+be pushed to ONOS.
+
+> NOTE: Remember that the configuration must be valid JSON
\ No newline at end of file
diff --git a/profiles/seba/operate/screenshots/bng_mapping.png b/profiles/seba/operate/screenshots/bng_mapping.png
new file mode 100644
index 0000000..cbafa0b
--- /dev/null
+++ b/profiles/seba/operate/screenshots/bng_mapping.png
Binary files differ
diff --git a/profiles/seba/operate/screenshots/olt_detail_view.png b/profiles/seba/operate/screenshots/olt_detail_view.png
new file mode 100644
index 0000000..8f66cf5
--- /dev/null
+++ b/profiles/seba/operate/screenshots/olt_detail_view.png
Binary files differ
diff --git a/profiles/seba/operate/screenshots/onos_app_config.png b/profiles/seba/operate/screenshots/onos_app_config.png
new file mode 100644
index 0000000..528c616
--- /dev/null
+++ b/profiles/seba/operate/screenshots/onos_app_config.png
Binary files differ
diff --git a/profiles/seba/operate/screenshots/onos_apps_detail_view_attributes.png b/profiles/seba/operate/screenshots/onos_apps_detail_view_attributes.png
new file mode 100644
index 0000000..31506c3
--- /dev/null
+++ b/profiles/seba/operate/screenshots/onos_apps_detail_view_attributes.png
Binary files differ
diff --git a/profiles/seba/operate/screenshots/onos_apps_table_view.png b/profiles/seba/operate/screenshots/onos_apps_table_view.png
new file mode 100644
index 0000000..4cf4dfc
--- /dev/null
+++ b/profiles/seba/operate/screenshots/onos_apps_table_view.png
Binary files differ