AETHER-2098 Update AIAB docs
Change-Id: Ie64a24cddb7f4c907d62f8ba9bf4cb2b2a78cd6a
diff --git a/developer/aiab.rst b/developer/aiab.rst
new file mode 100644
index 0000000..fe9e64f
--- /dev/null
+++ b/developer/aiab.rst
@@ -0,0 +1,112 @@
+.. vim: syntax=rst
+
+Setting Up Aether-in-a-Box
+==========================
+
+Aether-in-a-Box (AiaB) provides an easy way to deploy the Aether software stack and
+run basic tests. This guide describes the steps to set up AiaB.
+
+AiaB can be run on a bare metal machine or VM. Prerequisites:
+
+* Ubuntu 18.04
+* Kernel 4.15 or later
+* Haswell CPU or newer
+
+Clone Repositories
+------------------
+
+Clone the following repositories, using your gerrit ids as necessary::
+
+ mkdir -p ~/cord # need to clone below 2 repos in this directory
+ git clone "ssh://<username>@gerrit.opencord.org:29418/helm-charts"
+ git clone "ssh://<username>@gerrit.opencord.org:29418/aether-helm-charts"
+
+ cd ~ # go back to home directory
+ git clone "ssh://<username>@gerrit.opencord.org:29418/aether-in-a-box"
+
+Set up Authentication Tokens
+----------------------------
+
+Edit the file *aether-in-a-box/configs/authentication*.
+
+Fill out REGISTRY_USERNAME and REGISTRY_CLI_SECRET as follows:
+
+* Log into the `Aether Harbor Registry <https://registry.aetherproject.org>`_ using your Crowd credentials
+* Select *User Profile* from the drop-down menu in the upper right corner
+* For REGISTRY_USERNAME, use the *Username* in your profile
+* Copy the *CLI secret* to the clipboard and paste to REGISTRY_CLI_SECRET
+
+If you want to install using Aether's published Helm charts rather than the local charts
+checked out in the previous step, fill out REPO_USERNAME and REPO_PASSWORD with the
+information needed to authenticate with Aether's Helm chart repository. This step is optional.
+
+Start the 4G Core
+-----------------
+
+Deploy Aether-in-a-Box and start the 4G core::
+
+ cd aether-in-a-box
+
+ make test # create K8s cluster, start 4G network functions, and run ping test
+
+By default, the installation uses the local charts that were checked out earlier. However the
+files in the *configs/* directory can be used to install AiaB using charts published to the Aether Helm
+chart repository. For example, the file *configs/rc-1.5* can be used to install the Aether 1.5 release candidate.
+To install AiaB using the chart versions specified in this file, set the *CHARTS* variable when invoking *make*::
+
+ CHARTS=rc-1.5 make test
+
+Once you are done with the test, stop the 4G Core as follows::
+
+ make reset-test # this does not destroy K8s cluster
+
+Start the 5G Core
+-----------------
+
+Deploy Aether-in-a-Box and start the 5G core::
+
+ cd aether-in-a-box
+
+ make 5gc # start all 5G network functions with default images
+
+ kubectl get pods -n omec # verify that all 5g pods are started
+
+Sample output::
+
+ NAME READY STATUS RESTARTS AGE
+ amf-7d6f649b4f-jzd9r 1/1 Running 0 41s
+ ausf-8dd5d7465-xrjdl 1/1 Running 0 41s
+ gnbsim-0 1/1 Running 0 25s
+ mongodb-55555bc884-wqcrh 1/1 Running 0 41s
+ nrf-ddd7d8d5b-vjv84 1/1 Running 0 41s
+ nssf-7978bb74cc-zct9v 1/1 Running 0 41s
+ pcf-5bbbff96d6-l54f6 1/1 Running 0 41s
+ smf-86b6fd5674-tq8h9 1/1 Running 0 41s
+ udm-5fdf9cf56d-76hlt 1/1 Running 0 41s
+ udr-d8f855c6b-jj8lw 1/1 Running 0 41s
+ upf-0 4/4 Running 0 55s
+ webui-79c8b7dfc7-wn6st 1/1 Running 0 41s
+
+You can use *gnbsim* to test 5G functionality. For example, to run the 5G user registration::
+
+ kubectl -n omec exec gnbsim-0 -- /go/src/gnbsim/gnbsim register
+
+
+SD-CORE Developer Loop
+----------------------
+
+Tips for SD-CORE developers:
+
+Deploy custom images by editing `~/aether-in-a-box/aether-in-a-box-values.yaml`::
+
+ images:
+ tags:
+ webui: registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-roc-935305f
+ pullPolicy: IfNotPresent
+ pullSecrets:
+ - name: "aether.registry"
+
+Stop the 5G Core and start it again::
+
+ make reset-5g-test
+ make 5gc
diff --git a/developer/roc.rst b/developer/roc.rst
index a2fc67e..07c9d3a 100644
--- a/developer/roc.rst
+++ b/developer/roc.rst
@@ -418,8 +418,8 @@
4. Try POSTing a change via the API. Observe the ``sdcore-adapter-v3`` log
file and see that the adapter attempts to push the change.
-5. Deploy a 5G Aether-in-a-Box (See :doc:`Aether SD-Core Developer Guide
- <sdcore>`), modify the mega-patch to specify the URL for the Aether-in-a-Box
+5. Deploy a 5G Aether-in-a-Box (See :doc:`Setting Up Aether-in-a-Box
+ <aiab>`), modify the mega-patch to specify the URL for the Aether-in-a-Box
``webui`` container, POST the mega-patch, and observe that the changes were
correctly pushed via the ``sdcore-adapter-v3`` into the ``sd-core``’s
``webui`` container (``webui`` container log will show configuration as it
diff --git a/developer/sdcore.rst b/developer/sdcore.rst
deleted file mode 100644
index 6b0f2f3..0000000
--- a/developer/sdcore.rst
+++ /dev/null
@@ -1,96 +0,0 @@
-.. vim: syntax=rst
-
-Aether SD-Core Developer Guide
-==============================
-
-Clone Repositories
-------------------
-
-Clone the following repositories, using your gerrit ids as necessary::
-
- mkdir -p ~/cord #need to clone below 2 repos in this directory
- git clone "ssh://<username>@gerrit.opencord.org:29418/helm-charts"
- git clone "ssh://<username>@gerrit.opencord.org:29418/aether-helm-charts"
-
- cd ~ #go back to home directory
- git clone "ssh://<username>@gerrit.opencord.org:29418/aether-in-a-box"
-
-Start the 4G Core
------------------
-
-Deploy Aether-in-a-Box and start the 4G core::
-
- cd aether-in-a-box
-
- #create K8s cluster for you and also start 4G network functions and carry out 1 ping test
- make test
-
-Create the pull secret
-----------------------
-
-The deployment may fail and leave pods in ImagePullBackoff status if the
-necessary secret is not present. To create the pull secret, follow these
-steps:
-
-* Log into the `Aether Harbor Registry <https://registry.aetherproject.org>`_ using your Crowd credentials
-* Select *User Profile* from the drop-down menu in the upper right corner
-* Copy the *CLI secret* to the clipboard
-
-Then run the following command, replacing the bracketed fields with the information
-from your User Profile::
-
- kubectl -n omec create secret docker-registry aether.registry \
- --docker-server=https://registry.aetherproject.org \
- --docker-username=<your-username> \
- --docker-password=<pasted-cli-secret> \
- --docker-email=<your-email>
-
-
-
-Transition from 4G Core to 5G Core
-----------------------------------
-
-Before starting the 5G core, the 4G Core must be stopped::
-
- make reset-test #this does not destroy K8s cluster.
-
-Now, start the 5G Core::
-
- make 5gc #this will start all 5G network functions with default images.
-
- kubectl get pods -n omec #verify that all 5g pods are started.
-
-Sample output::
-
- NAME READY STATUS RESTARTS AGE
- amf-7d6f649b4f-jzd9r 1/1 Running 0 41s
- ausf-8dd5d7465-xrjdl 1/1 Running 0 41s
- gnbsim-0 1/1 Running 0 25s
- mongodb-55555bc884-wqcrh 1/1 Running 0 41s
- nrf-ddd7d8d5b-vjv84 1/1 Running 0 41s
- nssf-7978bb74cc-zct9v 1/1 Running 0 41s
- pcf-5bbbff96d6-l54f6 1/1 Running 0 41s
- smf-86b6fd5674-tq8h9 1/1 Running 0 41s
- udm-5fdf9cf56d-76hlt 1/1 Running 0 41s
- udr-d8f855c6b-jj8lw 1/1 Running 0 41s
- ue-setup-if-mftrm 0/1 Completed 0 23d
- ue-teardown-if-whbvm 0/1 Completed 0 23d
- upf-0 4/4 Running 0 55s
- webui-79c8b7dfc7-wn6st 1/1 Running 0 41s
-
-Developer Loop
---------------
-
-Deploy custom images by editing `~/aether-in-a-box/aether-in-a-box-values.yaml`::
-
- images:
- tags:
- webui: registry.aetherproject.org/omecproject/5gc-webui:onf-release3.0.5-roc-935305f
- pullPolicy: IfNotPresent
- pullSecrets:
- - name: "aether.registry"
-
-Stop the 5G Core and start it again::
-
- make reset-5g-test
- make 5gc
diff --git a/dict.txt b/dict.txt
index 55e6446..aed47a4 100644
--- a/dict.txt
+++ b/dict.txt
@@ -17,6 +17,7 @@
GitOps
Github
Grafana
+Haswell
IPMI
IaC
IaaC
@@ -84,6 +85,7 @@
gNMI
gRPC
gerrit
+gnbsim
gw
hoc
hostname
diff --git a/edge_deployment/overview.rst b/edge_deployment/overview.rst
index c78e99c..5e1a233 100644
--- a/edge_deployment/overview.rst
+++ b/edge_deployment/overview.rst
@@ -20,7 +20,7 @@
For users looking for a development or fully software-simulated environment,
there is ``Aether-in-a-Box (AiaB)`` - instructions for running this can be
-found in the :doc:`Aether SD-Core Developer Guide </developer/sdcore>`. AiaB
+found in the :doc:`Setting Up Aether-in-a-Box </developer/aiab>`. AiaB
is only suitable for testing and developing software, and can't connect to
physical hardware, but is a good choice for learning about the different
software components within Aether.
diff --git a/index.rst b/index.rst
index 6fac7d1..0296599 100644
--- a/index.rst
+++ b/index.rst
@@ -83,7 +83,7 @@
:hidden:
:glob:
- developer/sdcore
+ developer/aiab
developer/roc
developer/roc-api