Skip to content

Commit

Permalink
Merge pull request #37 from opennetworkinglab/maintenance
Browse files Browse the repository at this point in the history
scrub omec
  • Loading branch information
llpeterson authored Dec 5, 2024
2 parents 0359617 + 5378587 commit 99596c3
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
4 changes: 2 additions & 2 deletions onramp/devel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ as an example. Consider the following two blocks from the playbook
kubernetes.core.helm:
update_repo_cache: true
name: sd-core
release_namespace: omec
release_namespace: aether-5gc
create_namespace: true
chart_ref: "{{ core.helm.chart_ref }}"
chart_version: "{{ core.helm.chart_version }}"
Expand All @@ -174,7 +174,7 @@ These two tasks correspond to the following three ``helm`` commands:
--install \
--version $CHART_VERSION \
--wait \
--namespace omec \
--namespace aether-5gc \
--values $VALUES_FILE \
sd-core
Expand Down
10 changes: 6 additions & 4 deletions onramp/directory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,21 @@ Source Repos
Source code for Aether and all of its subsystems can be found in
the following repositories:

* GitHub repository for the OMEC Project
* GitHub repository for the Aether Core
(https://github.com/omec-project): Microservices for SD-Core, plus
the emulator (gNBsim) that subjects SD-Core to RAN workloads.

* GitHub repository for the ONOS Project
(https://github.com/onosproject): Microservices for SD-RAN and ROC,
plus the YANG models used to generate the Aether API.

* GitHub repository for the ONF
* GitHub repository for the Aether Project
(https://github.com/opennetworkinglab): OnRamp documentation and
playbooks for deploying Aether.

Anyone wanting to participate in Aether's ongoing development will
want to learn how to contribute new features to these source repos.
Note that ``omec-project`` and ``opennetworkinglab`` are historical
artifacts related to Aether's origin at the Open Networking Foundation
(ONF).

Artifact Repos
~~~~~~~~~~~~~~~~
Expand All @@ -57,6 +58,7 @@ Helm Charts
Docker Images

| https://registry.aetherproject.org
| https://hub.docker.com
Note that as of version 1.20.8, Kubernetes uses the `Containerd
<https://containerd.io/>`__ runtime system instead of Docker. This is
Expand Down
10 changes: 5 additions & 5 deletions onramp/inspect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,17 +139,17 @@ containers running as part of the ``upf-0`` pod:

.. code-block::
$ kubectl logs -n omec -p upf-0 bessd
$ kubectl logs -n aether-5gc -p upf-0 bessd
While ``kubectl`` works just fine for tasks like this, you may also
want to install `k9s <https://k9scli.io/>`__\ , a terminal-based UI
that provides a convenient alternative for interacting with Kubernetes.
Once installed, the following command brings up the UI for the OMEC
Once installed, the following command brings up the UI for the
namespace that implements SD-Core.

.. code-block::
$ k9s -n omec
$ k9s -n aether-5gc
:numref:`Figure %s <fig-k9s>` shows an example k9s display, where you
can scroll up and down, and then invoke one of the listed
Expand All @@ -161,7 +161,7 @@ the selected pod.
:width: 700px
:align: center

Screenshot of k9s's UI for the OMEC namespace, with the AMF pod
Screenshot of k9s's UI for the ``aether-5gc`` namespace, with the AMF pod
currently selected.


Expand Down Expand Up @@ -200,7 +200,7 @@ you learned from ``kubectl`` in place of ``amf-5887bbf6c5-pc9g2``.

.. code-block::
$ kubectl sniff -n omec amf-5887bbf6c5-pc9g2 -o - | tshark -r -
$ kubectl sniff -n aether-5gc amf-5887bbf6c5-pc9g2 -o - | tshark -r -
Of course, you'll also need to restart the RAN emulator to generate
workload for this tool to capture.
4 changes: 2 additions & 2 deletions onramp/network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ the container image that implements the UPF, and ``access`` and

.. code-block::
$ kubectl -n omec exec -ti upf-0 bessd -- ip addr
$ kubectl -n aether-5gc exec -ti upf-0 bessd -- ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
Expand Down Expand Up @@ -121,7 +121,7 @@ the UPF's ``bessd`` container will look something like this:

.. code-block::
$ kubectl -n omec exec -ti upf-0 -c bessd -- ip route
$ kubectl -n aether-5gc exec -ti upf-0 -c bessd -- ip route
default via 169.254.1.1 dev eth0
default via 192.168.250.1 dev core metric 110
10.76.28.0/24 via 192.168.252.1 dev access
Expand Down
7 changes: 3 additions & 4 deletions onramp/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,12 +306,12 @@ that, type:
$ make aether-5gc-install
``kubectl`` will now show the ``omec`` namespace running (in addition
``kubectl`` will now show the ``aether-5gc`` namespace running (in addition
to ``kube-system``), with output similar to the following:

.. code-block::
$ kubectl get pods -n omec
$ kubectl get pods -n aether-5gc
NAME READY STATUS RESTARTS AGE
amf-5887bbf6c5-pc9g2 1/1 Running 0 6m13s
ausf-6dbb7655c7-42z7m 1/1 Running 0 6m13s
Expand Down Expand Up @@ -341,8 +341,7 @@ state, a reset usually corrects the problem. Type:
Once running, you will recognize pods that correspond to many of the
microservices discussed is `Chapter 5
<https://5g.systemsapproach.org/core.html>`__. For example,
``amf-5887bbf6c5-pc9g2`` implements the AMF. Note that for historical
reasons, the Aether Core is called ``omec`` instead of ``sd-core``.
``amf-5887bbf6c5-pc9g2`` implements the AMF.

.. admonition:: Troubleshooting Hint

Expand Down

0 comments on commit 99596c3

Please sign in to comment.