📝 Update documentation

This commit is contained in:
Neill Cox 2023-10-19 16:26:55 +11:00
parent 23de20b1e5
commit f930b5f746
4 changed files with 133 additions and 7 deletions

View file

@ -1,6 +1,4 @@
A quick and dirty script to help set up a RHOSP AIO
This has grown a bit. At some point I will make this a proper readme, but for now a few notes:
A set of quick and dirty scripts to help set up a RHOSP AIO
The goal is to build a VM (although you could use baremetal) and deploy a RHOSP AIO to it. Then to add a project, flavors, images, networks to support testing os-migrate.
@ -8,20 +6,38 @@ After that create a VM to migrate, a conversion host to do the migration.
This may well be useful for other things, but this is the current aim.
There are/will be example scripts in the examples directory
Everything is a bit of a mess but here's a brief overview:
## create_aio_vm.py
Uses virt-install to build a VM to deploy a RHOSP 16 AIO on.
I am primarily targetting RHEL8.4 and RHOSP16.2. As a result I'm tied to virt-install v3.2.0 which makes using cloud-init for configuring network on the AIO VM a little annoying. Later versions allow you to pass in a network config, but 3.2.0 means I have to use nmcli and bootcmd to get the network configure.
There is a vestigial network-config.tpl in the virt-install directory but it is not actually used yet.
EVerything is a bit of a mess but here's a brief overview:
## os_migrate_setup.py
main.py - original script. Generates the yaml files and a dploy script to deploy a RHOSP AIO. Assumes a VM to run on. Don't run this on your laptop. You'll be sorry if you do.
build the OSP infrastructure to allow testing os-migrate.
os_migrate_setup.py - build the OSP infrastructure to allow testing os-migrate.
## os_migrate_teardown.py
os_migrate_teardown.py - remove that infrastructure (to allow for refinement/iteration)
remove that infrastructure (to allow for refinement/iteration)
virt-install/create_aio_vm.py - use virt-install to create and configure a VM to run the other scripts on.
## prepare-deployment
Original script. Generates the yaml files and a dploy script to deploy a RHOSP AIO. Assumes a VM to run on. Don't run this on your laptop. You'll be sorry if you do.
## os_migrate_validate.py
Check that the necessary infrastructure has been deployed.
# Remember to mask and disable cloud-init if installing on a VM
```
usage: main.py [-h] -u USERNAME -p PASSWORD -a ADDRESS [-i INTERFACE]
[-m NETMASK] -d DNS [DNS ...] [-D DOMAIN]