Skip to content

Commit 4c444f9

Browse files
authored
Merge pull request #172 from stackhpc/update-readme
Update readme
2 parents 9be32e9 + b294197 commit 4c444f9

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

README.rst

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ are interested in, and follow the README.
1818
Requirements
1919
============
2020

21-
For this workshop we require the use of a single server, configured as a
21+
For this workshop, we require the use of a single server, configured as a
2222
*seed hypervisor*. This server should be a bare metal node or VM running
23-
CentOS Stream 8 or Ubuntu 20.04, with the following minimum requirements:
23+
Ubuntu Jammy or Rocky 9, with the following minimum requirements:
2424

2525
* 64GB RAM (more is recommended when growing the lab deployment)
2626
* 100GB disk
@@ -31,7 +31,7 @@ configured for the login user.
3131
Exercise
3232
========
3333

34-
On the seed hypervisor we will deploy three VMs:
34+
On the seed hypervisor, we will deploy three VMs:
3535

3636
* 1 seed
3737
* 1 controller
@@ -58,10 +58,10 @@ There are four parts to this guide:
5858
*Preparation* has instructions to prepare the seed hypervisor for the
5959
exercise, and fetching the necessary source code.
6060

61-
*Deploying a Seed* includes all instructions necessary to download and
62-
install the Kayobe prerequisites on a plain CentOS 8 cloud image, including
63-
provisioning and configuration of a seed VM. Optionally, snapshot the
64-
instance after this step to reduce setup time in future.
61+
*Deploying a Seed* includes all instructions necessary to download and install
62+
the Kayobe prerequisites on a plain Rocky 9 or Ubuntu Jammy cloud image,
63+
including provisioning and configuration of a seed VM. Optionally, snapshot the
64+
instance after this step to reduce setup time in the future.
6565

6666
*A Universe from a Seed* contains all instructions necessary to deploy from
6767
a host running a seed VM. An image suitable for this can be created
@@ -73,10 +73,9 @@ some ideas for what to try next.
7373
Preparation
7474
-----------
7575

76-
This shows how to prepare the seed hypervisor for the exercise. It assumes
77-
you have created a seed hypervisor instance fitting the requirements
78-
above and have already logged in (e.g. ``ssh centos@<ip>``
79-
or ``ssh ubuntu@<ip>``).
76+
This shows how to prepare the seed hypervisor for the exercise. It assumes you
77+
have created a seed hypervisor instance fitting the requirements above and have
78+
already logged in (e.g. ``ssh rocky@<ip>``, or ``ssh ubuntu@<ip>``).
8079

8180
.. code-block:: console
8281
@@ -128,10 +127,10 @@ or ``ssh ubuntu@<ip>``).
128127
Deploying a Seed
129128
----------------
130129

131-
This shows how to create an image suitable for deploying Kayobe.
132-
It assumes you have created a seed hypervisor instance fitting the requirements
133-
above and have already logged in (e.g. ``ssh centos@<ip>``), and performed the
134-
necessary `Preparation`_.
130+
This shows how to create an image suitable for deploying Kayobe. It assumes you
131+
have created a seed hypervisor instance fitting the requirements above and have
132+
already logged in (e.g. ``ssh rocky@<ip>``, or ``ssh ubuntu@<ip>``), and
133+
performed the necessary `Preparation`_.
135134

136135
.. code-block:: console
137136
@@ -166,13 +165,13 @@ necessary `Preparation`_.
166165
# Optional: Shutdown the seed VM if creating a seed snapshot.
167166
sudo virsh shutdown seed
168167
169-
If required, add any additional SSH public keys to /home/centos/.ssh/authorized_keys
168+
If required, add any additional SSH public keys to ~/.ssh/authorized_keys
170169

171170
Optional: Creating a Seed Snapshot
172171
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
173172

174173
If necessary, take a snapshot of the hypervisor instance at this point to speed up this
175-
process in future.
174+
process in the future.
176175

177176
You are now ready to deploy a control plane using this host or snapshot.
178177

@@ -185,7 +184,7 @@ pre-deployed seed VM, or a host that has run through the steps in
185184

186185
Having a snapshot image saves us some time if we need to repeat the deployment.
187186
If working from a snapshot, create a new instance with the same dimensions as
188-
the Seed image and log in to it.
187+
the Seed image and log into it.
189188
Otherwise, continue working with the instance from `Deploying a Seed`_.
190189

191190
.. code-block:: console
@@ -298,8 +297,8 @@ Here's some ideas for things to explore with the deployment:
298297
Exploring the Deployment
299298
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
300299

301-
Once each of the VMs becomes available, they should be accessible
302-
via SSH as the ``centos`` or ``stack`` user at the following IP addresses:
300+
Once each of the VMs becomes available, they should be accessible via SSH as
301+
the ``rocky``, ``ubuntu`` or ``stack`` user at the following IP addresses:
303302

304303
=========== ================
305304
Host IP
@@ -422,7 +421,6 @@ The new containers can be seen running on the controller node:
422421
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
423422
fad79f29afbc 192.168.33.5:4000/openstack.kolla/opensearch-dashboards:2024.1-rocky-9 "dumb-init --single-…" 6 hours ago Up 6 hours (healthy) opensearch_dashboards
424423
64df77adc709 192.168.33.5:4000/openstack.kolla/opensearch:2024.1-rocky-9 "dumb-init --single-…" 6 hours ago Up 6 hours (healthy) opensearch
425-
...
426424
427425
We can see the log indexes in OpenSearch:
428426

0 commit comments

Comments
 (0)