Documentation updates.

This commit is contained in:
Kyle Isom 2023-04-12 17:26:43 +00:00
parent 792dd139ca
commit b54784146d
2 changed files with 24 additions and 3 deletions

View File

@ -14,11 +14,14 @@ There are some assumptions made:
2. The primary target for this setup is Ubuntu 22.04. This needs to be
validated still.
There are three types of systems:
There are three physical types of systems:
- ``dev`` indicates DEV compute blades.
- ``tpm`` indicates TPM compute blades.
- ``gw`` indicates the gateway system, which may perform other functions.
- ``adm`` indicates an admin system, which will likely be a CM4 carrier board
in non-blade form. I foresee two types of systems: ``adm`` runs administrative
services (such as a PXE boot server) and ``gw`` managing networking with the
outside world.
The `computeblade docs <https://docs.computeblade.com/>`_ has a description of
the different blade types.
@ -89,4 +92,3 @@ the gateway system as the storage machine if needed.
+----------------------------+----------+----------------------------------------+
| Netgear GS316PP | 1 | 16-port PoE+ (183W) |
+----------------------------+----------+----------------------------------------+

View File

@ -3,6 +3,22 @@ packer
`packer <https://www.packer.io/>`_ is used to generate the base images for the cluster.
Quick workflow
--------------
All of these instructions assume you are in the ``packer`` directory.
The first time, make sure dependencies are installed and run ``./install-packer.sh``.
1. If updates to the image spec are needed, edit `ubuntu-boards.yml` and run
.. shell ::
bazel run //packer:ubuntu-board-gen -f $(pwd)/ubuntu-boards.yml -o $(pwd)/boards
This will place the board with a default name in the ``boards`` directory.
2. Run ``./build-imagesh``. The image will be in the ``build/`` directory.
Build scripts
-------------
@ -108,4 +124,7 @@ provisioners available. A longer example would look like
The order of precedence for provisioners is local scripts (which might be used
to generate files), files, and then scripts.
Any generated files should be placed in ``build/``, and any scripts should be
placed in ``scripts/`` for consistency.
.. _boards: https://github.com/mkaczanowski/packer-builder-arm/tree/master/boards