Skip to content

Commit 3be8f58

Browse files
committed
clarification
Signed-off-by: Larry Peterson <[email protected]>
1 parent 40e575e commit 3be8f58

File tree

4 files changed

+22
-18
lines changed

4 files changed

+22
-18
lines changed

conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,6 @@ def get_version():
281281
intersphinx_mapping = {
282282
'ansible': ('https://docs.ansible.com/ansible/latest', None),
283283
'sphinx': ('https://www.sphinx-doc.org/en/master', None),
284-
'trellis': ('https://docs.trellisfabric.org/master', None),
285284
'sdcore': ('https://docs.sd-core.opennetworking.org/master', None),
286285
'sdran': ('https://docs.sd-ran.org/master', None),
287286
'sysapproach5g': ('https://5g.systemsapproach.org/', None),

onramp/blueprints.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,11 @@ OAI 5G RAN
485485
~~~~~~~~~~~~~~~~~~~~
486486

487487
Aether can be configured to work with the open source gNB from OAI.
488-
The blueprint runs in either simulation mode or with physical UEs
489-
connecting wirelessly to a USRP software-defined radio.
488+
The blueprint runs in either simulation mode or with a USRP
489+
software-defined radio connecting wirelessly to one or more
490+
off-the-shelf UEs. (OAI also supports USRP-based UEs, but this
491+
blueprint does not currently support that option; you need to deploy
492+
such a UE separately.)
490493

491494
The following assumes familiarity with the OAI 5G RAN stack, but it is
492495
**not** necessary to separately install the OAI stack. OnRamp installs

onramp/scale.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ server is to play. We'll introduce additional host groups in later
2121
sections, but for starters, there are two aspects of our deployment
2222
that scale independently. One is Aether proper: a Kubernetes cluster
2323
running the set of microservices that implement SD-Core and AMP (and
24-
optionally, other edge apps); this corresponds to a combination of the
24+
optionally, other edge apps). This corresponds to a combination of the
2525
``master_nodes`` and ``worker_nodes`` groups. The second is gNBsim:
2626
the emulated RAN that generates traffic directed at the Aether
2727
cluster, corresponding to the ``gnbsim_nodes`` host group.
@@ -91,26 +91,27 @@ connect that node to one or more physical gNBs.
9191
Allocating CPU Cores
9292
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9393

94-
Kubernetes provides a mechanism for allocating CPU cores to specific
95-
pods. OnRamp manages this capability in two steps.
94+
Kubernetes supports allocating CPU cores to specific pods. OnRamp
95+
manages this capability in two steps.
9696

9797
First, directory ``deps/k8s/roles/rke2/templates`` contains two files
9898
used to configure a Kubernetes deployment. These files are referenced
9999
in ``vars/main.yml`` as variables
100100
``k8s.rke2.config.params_file.master`` and
101-
``k8s.rke2.config.params_file.worker``; edit these variables should
102-
you elect to substitute different files. Uncomment the block
103-
labeled *"Param's for Exclusive CPU"* in both files to enable the
104-
allocation feature. You need to reinstall Kubernetes for these changes
105-
to take effect.
101+
``k8s.rke2.config.params_file.worker``. Either edit these variables to
102+
substitute different files that you have defined to your
103+
specification, or uncomment the block labeled *"Param's for Exclusive
104+
CPU"* in the two default files. Doing the latter enables the
105+
allocation feature; you also need to reinstall Kubernetes for these
106+
changes to take effect.
106107

107108
Second, edit the values override file for whatever service is to be
108109
granted an exclusive CPU core. A typical example is to allocate a core
109110
to the UPF, which can be done by editing the ``omec-user-plane``
110111
section of ``deps/5gc/roles/core/templates/sdcore-5g-values.yaml``,
111-
changing variable ``resources.enabled`` from ``false`` to
112-
``true``. Similar variables exist for other SD-Core pods. You need to
113-
reinstall the 5G Core for this change to take effect.
112+
changing variable ``resources.enabled`` to ``true``. Similar variables
113+
exist for other SD-Core pods. You need to reinstall the 5G Core for
114+
this change to take effect.
114115

115116

116117
Other Options

onramp/start.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,11 @@ four things to note:
121121
you will not need to modify the latter. Note that the ``vars``
122122
directory contains several variants of ``main.yml``, where we think
123123
of each as specifying a *blueprint* for a different configuration
124-
of Aether. The default ``main.yml`` (which is the same as
125-
``main-quickstart.yml``) gives the blueprint for the Quick Start
126-
deployment described in this section; we'll substitute the other
127-
blueprints in later sections.
124+
of Aether. The default ``main.yml`` (which is equivalent to
125+
``main-quickstart.yml``, except with non-default settings commented
126+
out) gives the blueprint for the Quick Start deployment described
127+
in this section. We'll substitute the other blueprints in later
128+
sections.
128129

129130
4. File ``hosts.ini`` (host inventory) is Ansible's way of specifying
130131
the set of servers (physical or virtual) that Ansible targets with

0 commit comments

Comments
 (0)