Skip to content

Commit c8a3dd6

Browse files
committed
added usrp manual link
Signed-off-by: Larry Peterson <[email protected]>
1 parent 67cfba9 commit c8a3dd6

File tree

1 file changed

+42
-29
lines changed

1 file changed

+42
-29
lines changed

onramp/blueprints.rst

Lines changed: 42 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -499,19 +499,19 @@ The blueprint includes the following:
499499
* Global vars file ``vars/main-oai.yml`` gives the overall blueprint
500500
specification.
501501

502-
* Inventory file ``hosts.ini`` is similar to that used throughout this
503-
Guide, except this blueprint uses label ``[oai_gnb_nodes]`` to
502+
* Inventory file ``hosts.ini`` uses label ``[oai_gnb_nodes]`` to
504503
denote the server(s) that host the gNB and label ``[oai_ue_nodes]``
505504
to denote the server(s) that host the UE. (The latter is necessary
506-
only when running in simulation mode.) The gNB and UE can can run on
507-
the same server as Kubernetes (where the 5G Core runs), although a
508-
common configuration is to co-locate the Core and gNB on one server,
509-
with the simulated UE running on a separate server.
505+
only when running in simulation mode.) One common configuration is
506+
to run both the gNB and UE on the same server as Kubernetes (where
507+
the 5G Core runs). Another common common configuration is to
508+
co-locate the gNB and UE on one server, with the 5G Core running on
509+
a separate server.
510510

511-
* New make targets, ``oai-gNb-install`` and ``oai-gNb-uninstall``, to
511+
* New make targets, ``oai-gnb-install`` and ``oai-gnb-uninstall``, to
512512
be executed along with the standard SD-Core installation (see below).
513-
When running a simulated UE, targets ``oai-uEsim-start`` and
514-
``oai-uEsim-stop`` are also available.
513+
When running a simulated UE, targets ``oai-uesim-start`` and
514+
``oai-uesim-stop`` are also available.
515515

516516
* A new submodule ``deps/oai`` (corresponding to repo ``aether-oai``)
517517
defines the Ansible Roles and Playbooks required to deploy the OAI
@@ -552,8 +552,8 @@ section:
552552
553553
Variable ``simulation`` is set to ``true`` by default, causing OnRamp
554554
to deploy the simulated UE. When set to ``false``, the simulated UE
555-
is not deployed and it is instead necessary to initialize the USRP device
556-
and configure a physical UE.
555+
is not deployed and it is instead necessary to configure the USRP and
556+
a physical UE.
557557

558558
Note that instead of downloading and compiling the latest OAI
559559
software, this blueprint pulls in the published images for both the
@@ -563,42 +563,55 @@ software, you will need to change these values accordingly. See the
563563
:doc:`Development Support </onramp/devel>` section for guidance.
564564

565565
The ``network`` block of the ``oai`` section configures the necessary
566-
tunnels. Variable ``network.data_iface`` needs to be modified in the
567-
same way as in the ``core`` and ``gnbsim`` sections, as described
568-
throughout this Guide.
566+
tunnels so the gNB can connect to the Core's user and control planes.
567+
Variable ``network.data_iface`` needs to be modified in the same way
568+
as in the ``core`` and ``gnbsim`` sections of ``vars/main.yml``, as
569+
described throughout this Guide.
569570

570571
The path names associated with variables ``oai.gnb.conf_file`` and
571572
``oai.ue.conf_file`` are OAI-specific configuration files. The two
572573
given by default are for simulation mode. The template directory for
573-
the ``gNb`` role also includes a configuration file for the USRP X310
574-
when that hardware is to be deployed; edit variable
575-
``oai.gnb.conf_file`` to point to that file instead. If you plan to
576-
use some other OAI configuration file, note that the following two
577-
variables in the ``AMF parameters`` section need to be modified to
578-
work with the Aether Core:
574+
the ``gNb`` role also includes a configuration file for when the USRP
575+
X310 hardware is to be deployed; edit variable ``oai.gnb.conf_file``
576+
to point to that file instead. If you plan to use some other OAI
577+
configuration file, note that the following two variables in the ``AMF
578+
parameters`` section need to be modified to work with the Aether Core:
579579

580580
.. code-block::
581581
582582
amf_ip_address = ({ ipv4 = "{{ core.amf.ip }}"; });
583583
584584
GNB_IPV4_ADDRESS_FOR_NG_AMF = "172.20.0.2/24";
585585
586-
To deploy the OAI blueprint (in either mode), run the following:
586+
To deploy the OAI blueprint in simulation mode, run the following:
587587

588588
.. code-block::
589589
590590
$ make k8s-install
591591
$ make 5gc-install
592-
$ make oai-gNb-install
593-
594-
If in simulation mode, next run ``make oai-uEsim-start``; if not, you
595-
are ready to bring up the physical gNB and UE. In the latter case, you
596-
need to make sure the PLMN-related values in the files specified by
592+
$ make oai-gnb-install
593+
$ make oai-uesim-start
594+
595+
To deploy the OAI blueprint with a physical gNB and UE, first
596+
configure the USRP hardware as described in the `USRP Hardware Manual
597+
<https://files.ettus.com/manual/page_usrp_x3x0.html>`__. Of
598+
particular note, you need to select whether the device is to connect
599+
to the Aether Core using its 1G or 10G interface, and make sure the
600+
OAI configuration file (corresponding to ``oai.conf_file``) sets the
601+
``sd_addrs`` variable to match the interface you select. You also need
602+
to make sure the PLMN-related values in the files specified by
597603
``core.values_file`` and ``oai.conf_file`` (along with the SIM cards
598-
you burn) are consistent. The :doc:`Physical RAN </onramp/gnb>`
599-
section can be helpful in debugging the setup, even though the gNB
600-
details are different.
604+
you burn) are consistent. Once ready, run the following Make targets:
605+
606+
.. code-block::
607+
608+
$ make k8s-install
609+
$ make 5gc-install
610+
$ make oai-gnb-install
601611
612+
The :doc:`Physical RAN </onramp/gnb>` section of this Guide can be
613+
helpful in debugging the end-to-end setup, even though the gNB details
614+
are different.
602615

603616
Guidelines for Blueprints
604617
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)