Document cleanup
Change-Id: Ie7478317eedd34d2bf5786dfcbbfa3c1ebc071a1
diff --git a/developer/aiab.rst b/developer/aiab.rst
index 4f7a05a..9dda2f6 100644
--- a/developer/aiab.rst
+++ b/developer/aiab.rst
@@ -4,12 +4,11 @@
.. _aiab-guide:
-================
-Aether In a Box
-================
+Aether In a Box - 4G
+====================
-Setting Up Aether-in-a-Box
-__________________________
+Setting Up Aether-in-a-Box - 4G
+________________________________
Aether-in-a-Box (AiaB) provides an easy way to deploy Aether’s SD-CORE
components and run basic tests to validate the installation. This guide
@@ -29,15 +28,14 @@
AiaB can be run on a bare metal machine or VM. System prerequisites:
-* Ubuntu 18.04
+* Ubuntu 18.04 or later
* Kernel 4.15 or later
* Haswell CPU or newer
Clone Repositories
__________________
-To initialize the AiaB environment, first clone the following repository using
-your Gerrit ID::
+To initialize the AiaB environment, first clone the following repository::
cd ~
git clone "https://gerrit.opencord.org/aether-in-a-box"
@@ -52,10 +50,10 @@
Kubernetes cluster. Subsequent builds will be much faster if you follow below steps
to delete & redeploy SD-Core (4G/5G) without destroying the Kubernetes
-Using 4G SD-CORE
+Running 4G Test
________________
-To deploy 4G SD-CORE::
+To deploy 4G SD-CORE using local helm charts::
make 4g-core
@@ -68,40 +66,28 @@
After updating config in *sd-core-4g-values.yaml* you can reset deployment and run
the test again.
-Using 5G SD-CORE
-________________
-
-To deploy 5G SD-CORE::
-
- make 5g-core
-
-To deploy and test 5G SD-CORE::
-
- make 5g-test
-
-The above step uses gNBSim to perform Registration + UE-Initiated PDU Session
-Establishment + User Data Packets. To test other procedures, modify *gnb.conf*
-in *~/aether-in-a-box/sd-core-5g-values.yaml* (refer gNBSim documentation :ref:`gNB-Simulator`)
-
Developer Loop
______________
-Suppose you wish to test a new build of a 5G SD-CORE services. You can deploy
-custom images by editing ~/aether-in-a-box/sd-core-5g-values.yaml, for example::
+Suppose you wish to test a new build of a 4G SD-CORE services. You can deploy
+custom images by editing ~/aether-in-a-box/sd-core-4g-values.yaml, for example::
images:
tags:
- webui: omecproject/5gc-webui:master-7f96cfd
+ spgwc: omecproject/spgw:master-e419062
-To upgrade a running 5G SD-CORE with the new image, or to deploy the 5G SD-CORE
+To upgrade a running 4G SD-CORE with the new image, or to redeploy the 4G SD-CORE
with the image::
- make reset-5g-test # delete 5G deployment if it was already started before updating image
- make 5g-core #now this deployment will use new webui image
+ make reset-test # delete 4G deployment if it was already started before updating image
+ make 4g-test #now this deployment will use new webui image
Troubleshooting / Known Issues
______________________________
+Deployment Status
+""""""""""""""""""
+
If you suspect a problem, first verify that all pods are in Running state::
kubectl -n omec get pods
@@ -109,16 +95,10 @@
If the pods are stuck in ImagePullBackOff state, then it’s likely an issue
with image name.
-4G Test Fails
-_____________
+Test Failure
+""""""""""""
Occasionally make 4g-core (for 4G) fails for unknown reasons; this is true
regardless of which Helm charts are used. If this happens, first try
cleaning up AiaB and re-running the test. If make 4g-core fails consistently,
then try to debug the issue by looking at spgwc, mme logs.
-
-5G Test Fails
-_____________
-
-If make 5g-test fails consistently, then try to debug the issue by looking
-at logs at amf, smf.
diff --git a/developer/aiab5g.rst b/developer/aiab5g.rst
new file mode 100644
index 0000000..e380f06
--- /dev/null
+++ b/developer/aiab5g.rst
@@ -0,0 +1,101 @@
+..
+ SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
+ SPDX-License-Identifier: Apache-2.0
+
+.. _aiab5g-guide:
+
+Aether In a Box - 5G
+====================
+
+Setting Up Aether-in-a-Box - 5G
+________________________________
+
+Aether-in-a-Box (AiaB) provides an easy way to deploy Aether’s SD-CORE
+components and run basic tests to validate the installation. This guide
+describes the steps to set up AiaB.
+
+AiaB can be set up with a 4G or 5G SD-CORE. We use SimApp to configure
+the required subscribers & network slices in SD-CORE for testing core
+functionality.
+
+Helm charts are the primary method of installing the SD-CORE resources.
+AiaB offers a great deal of flexibility regarding which Helm chart
+versions to install:
+
+* Local definitions of charts (for testing Helm chart changes)
+* Latest published charts (for deploying a development version of Aether)
+* Specified versions of charts (for deploying a specific Aether release)
+
+AiaB can be run on a bare metal machine or VM. System prerequisites:
+
+* Ubuntu 18.04 or later
+* Kernel 4.15 or later
+* Haswell CPU or newer
+
+Clone Repositories
+__________________
+
+To initialize the AiaB environment, first clone the following repository::
+your Gerrit ID::
+
+ cd ~
+ git clone "https://gerrit.opencord.org/aether-in-a-box"
+
+ mkdir -p ~/cord
+ cd ~/cord
+ git clone "https://gerrit.opencord.org/sdcore-helm-charts"
+
+.. note::
+ Only one version of the SD-CORE (4G or 5G) can be installed in AIAB environment
+ at a time. The first time you build AiaB, it takes a while because it sets up the
+ Kubernetes cluster. Subsequent builds will be much faster if you follow below steps
+ to delete & redeploy SD-Core (4G/5G) without destroying the Kubernetes
+
+Running 5G Test
+________________
+
+To deploy 5G SD-CORE using local helm charts::
+
+ make 5g-core
+
+To deploy and test 5G SD-CORE using local helm charts::
+
+ make 5g-test
+
+The above step uses gNBSim to perform Registration + UE-Initiated PDU Session
+Establishment + User Data Packets. To test other procedures, modify *gnb.conf*
+in *~/aether-in-a-box/sd-core-5g-values.yaml* (refer gNBSim documentation :ref:`gNB-Simulator`)
+
+Developer Loop
+______________
+
+Suppose you wish to test a new build of a 5G SD-CORE services. You can deploy
+custom images by editing ~/aether-in-a-box/sd-core-5g-values.yaml, for example::
+
+ images:
+ tags:
+ webui: omecproject/5gc-webui:master-7f96cfd
+
+To upgrade a running 5G SD-CORE with the new image, or to redeploy the 5G SD-CORE
+with the image::
+
+ make reset-5g-test # delete 5G deployment if it was already started before updating image
+ make 5g-core #now this deployment will use new webui image
+
+Troubleshooting / Known Issues
+______________________________
+
+Deployment Status
+""""""""""""""""""
+If you suspect a problem, first verify that all pods are in Running state::
+
+ kubectl -n omec get pods
+
+If the pods are stuck in ImagePullBackOff state, then it’s likely an issue
+with image name.
+
+Test Failure
+""""""""""""
+
+If make 5g-test fails consistently, then try to debug the issue by looking
+at logs at amf, smf.
diff --git a/developer/gnbsim.rst b/developer/gnbsim.rst
index 9c769b7..e09deb7 100644
--- a/developer/gnbsim.rst
+++ b/developer/gnbsim.rst
@@ -12,7 +12,7 @@
-------------------------------------------------
- This is default mode of deployment for gNB Simulator
-- Multus cni needs to be enabled on cluster. Required for bess-upf & gNB
+- Multus cni needs to be enabled on cluster. Required for bess-upf & gNBSim
- `make 5gc` will by default deploy gNB Simulator in this mode
- One interface is used for user plane traffic towards UPF
- Second interface is used to send traffic towards control plane (i.e. AMF).
@@ -160,7 +160,7 @@
$ make 5g-test
- (refer AiaB documentation :ref:`aiab-guide`)
+ (refer AiaB documentation :ref:`aiab5g-guide`)
* Alternatively, once 5G SD-CORE is up, you can enter into the gNBSim pod by
running:
@@ -211,6 +211,6 @@
$ make 5g-test
- (refer AiaB documentation :ref:`aiab-guide`)
+ (refer AiaB documentation :ref:`aiab5g-guide`)