Skip to content

Commit af55c42

Browse files
authored
Documentation: Update ansible_host in inventory file to simplify development (#79)
* Update ansible_host in inventory file to simplify development Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Address validation issue Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Address Copilot's comments Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Alaigned documentation based on latest Onramp changes Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> --------- Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
1 parent 6c33c5e commit af55c42

3 files changed

Lines changed: 47 additions & 6 deletions

File tree

onramp/ref.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,13 @@ Each blueprint is deployed to the set of servers identified in an
169169
Ansible inventory file (``hosts.ini``). The following identifies the
170170
`host groups` that OnRamp currently supports.
171171

172+
In the default single-node inventory, the controller host is labeled
173+
``node1`` even when it resolves to ``127.0.0.1`` for local execution.
174+
The GitHub Actions workflows in the ``aether-onramp`` repository under
175+
``.github/workflows`` do not use that exact aliasing scheme: the
176+
single-node workflows generate ``hosts.ini`` with ``localhost`` and
177+
``ansible_connection=local``.
178+
172179
.. list-table::
173180
:widths: 25 50
174181
:header-rows: 1

onramp/start.rst

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,16 @@ four things to note:
135135
various installation playbooks. The default version of ``hosts.ini``
136136
included with OnRamp is simplified to run everything on a single
137137
server (the one you've cloned the repo onto), with additional lines
138-
you may eventually need for a multi-node cluster commented out.
138+
you may eventually need for a multi-node cluster commented out. In
139+
the shipped single-node example, Ansible refers to that server as
140+
``node1``; the checked-in default inventory currently maps ``node1``
141+
to ``127.0.0.1`` as a placeholder for local single-node execution.
142+
For an actual deployment, replace the loopback address and
143+
credentials with the values for your target server. The GitHub
144+
Actions workflows in the ``aether-onramp`` repository under
145+
``.github/workflows`` generate their own ``hosts.ini`` and, for
146+
single-node tests, use ``localhost ansible_connection=local``
147+
instead of this checked-in ``node1`` example.
139148

140149
Set Target Parameters
141150
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -147,15 +156,23 @@ deployment.
147156
The first set is in file ``hosts.ini``, where you will need to give the IP
148157
address and login credentials for the server you are working on. At
149158
this stage, we assume the server you downloaded OnRamp onto is the
150-
same server you will be installing Aether on.
159+
same server you will be installing Aether on. If your checkout still
160+
shows ``node1 ansible_host=127.0.0.1 ...``, that is only the local
161+
placeholder; change it to the server's reachable management address
162+
before running the playbooks remotely. The checked-in example keeps the
163+
active inventory entry minimal and shows password-based access only as
164+
an optional commented example.
151165

152166
.. code-block::
153167
154-
node1 ansible_host=10.76.28.113 ansible_user=aether ansible_password=aether ansible_sudo_pass=aether
168+
# Optional for password-based access:
169+
# node1 ansible_host=10.76.28.113 ansible_user=<username> ansible_password=<password> ansible_sudo_pass=<sudo-password>
170+
node1 ansible_host=10.76.28.113 ansible_user=aether
155171
156-
In this example, address ``10.76.28.113`` and the three occurrences
157-
of the string ``aether`` need to be replaced with the appropriate
158-
values.
172+
In this example, address ``10.76.28.113`` and the username ``aether``
173+
need to be replaced with the appropriate values. If you use password
174+
authentication instead of SSH keys, uncomment the optional example and
175+
replace the placeholder values there as well.
159176

160177
Note that if you set up your server to use SSH keys instead
161178
of passwords, update the ``hosts.ini`` with your private key (accordingly

onramp/testing.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ Blueprints </onramp/blueprints>`. These tests exercise representative
66
deployment scenarios and simulated 5G workloads used throughout this
77
guide.
88

9+
The GitHub Actions workflows in the ``aether-onramp`` repository under
10+
``.github/workflows`` build ``hosts.ini`` dynamically before running
11+
the playbooks. The single-node workflows use ``localhost`` with
12+
``ansible_connection=local`` and do not set ``ansible_host``. This
13+
lets the workflows exercise the same playbooks without requiring SSH
14+
access back into the runner itself.
15+
16+
The current integration-test inventory patterns are as follows:
17+
18+
* Quick Start, Quick Start AMP, SD-RAN, OAI, and srsRAN run as
19+
single-node tests, with both ``[master_nodes]`` and the
20+
blueprint-specific host group pointing at ``localhost``.
21+
22+
This means the checked-in inventory examples and the CI-generated
23+
inventories are similar in structure, but they do not use identical
24+
host aliases.
25+
926
Finally, note that the integration tests run a variety of simulated 5G
1027
workloads, including gNBsim, UERANSIM, OAI 5G RAN (in simulation
1128
mode), and srsRAN (in simulation mode). Of these, gNBsim provides the

0 commit comments

Comments
 (0)