Merge pull request #230 from shiftstack/readme-updates

mandre · web-flow · commit e13bf850b8cb · 2024-09-04T09:44:36.000+02:00
Add troubleshooting section and rework README
diff --git a/README.md b/README.md
@@ -1,14 +1,15 @@
 # dev-install
 
-dev-install installs [TripleO standalone](https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/standalone.html) on a remote system for development use.
+`dev-install` installs [TripleO standalone](https://docs.openstack.org/project-deploy-guide/tripleo-docs/latest/deployment/standalone.html) on a remote system for development use.
 
 ## Host configuration
 
-dev-install requires that:
-* an appropriate OS has already been installed
+`dev-install` requires that:
+
+* An appropriate OS has already been installed
 * EPEL repositories aren't deployed, they aren't compatible with OpenStack repositories
-* the machine running dev-install can SSH to the standalone host as either root or a user with passwordless sudo access
-* this machine has Ansible installed, and some dependencies like python3-netaddr.
+* The machine running `dev-install` can SSH to the standalone host as either root or a user with passwordless sudo access
+* This machine has Ansible installed, and some dependencies like `python3-netaddr`.
 
 You need to deploy the right RHEL version depending on which OSP version you want:
 
@@ -17,33 +18,34 @@ You need to deploy the right RHEL version depending on which OSP version you wan
 | 16.2         | 8.4          |
 | 17.1*        | 9.2          |
 
-> * Current default in dev-install
+> Current default.
 
-There is no need to do any other configuration prior to running dev-install.
+There is no need to do any other configuration prior to running `dev-install`.
 When deploying on TripleO from upstream, you need to deploy on CentOS Stream. If CentOS is not Stream, dev-install will migrate it.
 
 ## Local pre-requisites
 
-dev-install requires up to date versions of `ansible` and `make`, both of which must be installed manually before invoking dev-install.
+`dev-install` requires up to date versions of `ansible` and `make`, both of which must be installed manually before invoking `dev-install`.
 
-If installing OSP 16.2 with official rhel 8.4 cloud images, it is required that the cloud-init service be disabled before deployment as per [THIS](https://review.opendev.org/c/openstack/tripleo-heat-templates/+/764933)
+If installing OSP 16.2 with official RHEL 8.4 cloud images, it is required that the `cloud-init` service be disabled before deployment as per [THIS](https://review.opendev.org/c/openstack/tripleo-heat-templates/+/764933)
 
-At present the deployment depends on a valid DHCP source for the external interface (br-ex) as per [THIS](https://github.com/shiftstack/dev-install/blob/main/playbooks/templates/dev-install_net_config.yaml.j2#L9)
+At present the deployment depends on a valid DHCP source for the external interface (`br-ex`) as per [THIS](https://github.com/shiftstack/dev-install/blob/main/playbooks/templates/dev-install_net_config.yaml.j2#L9)
 
-All other requirements should be configured automatically by ansible. Note that dev-install does require root access (or passwordless sudo) on the machine it is invoked from to install certificate management tools (simpleca) in addition to the remote host.
+All other requirements should be configured automatically by Ansible. Note that `dev-install` does require root access (or passwordless sudo) on the machine it is invoked from to install certificate management tools (simpleca) in addition to the remote host.
 
 ## Running dev-install
 
-dev-install is invoked using its Makefile. The simplest invocation is:
+`dev-install` is invoked using its `Makefile`. The simplest invocation is:
 
+```console
+make config host=<standalone host>
+make osp_full
 ```
-$ make config host=<standalone host>
-$ make osp_full
-```
 
-`make config` initialises 2 local statefiles:
-* `inventory` - this is an ansible inventory file, initialised such that `standalone` is an alias for your target host.
-* `local-overrides.yaml` - this is an ansible vars file containing configuration which overrides the defaults in `playbooks/vars/defaults.yaml`.
+`make config` initialises two local state files:
+
+* `inventory` - this is an Ansible inventory file, initialised such that `standalone` is an alias for your target host.
+* `local-overrides.yaml` - this is an Ansible vars file containing configuration which overrides the defaults in `playbooks/vars/defaults.yaml`.
 
 Both of these files can be safely modified.
 
@@ -54,32 +56,29 @@ and then use it when deploying with `make osp_full overrides=local-overrides-<na
 
 ## Accessing OpenStack from your workstation
 
-By default, dev-install configures OpenStack to use the default public IP of the
-host. To access this you just need a correct clouds.yaml, which dev-install
-configures with:
+By default, `dev-install` configures OpenStack to use the default public IP of the host.
+To access this you just need a correct `clouds.yaml`, which `dev-install` configures with:
 
-```
+```console
 make local_os_client
 ```
 
-This will configure your local clouds.yaml with 2 entries:
+This will configure your local `clouds.yaml` with two entries:
+
 * `standalone` - The admin user
-* `standalone_openshift` - The appropriately configured non-admin openshift user
+* `standalone_openshift` - The appropriately configured non-admin `openshift` user
 
-You can change the name of these entries by editing `local-overrides.yaml` and
-setting `local_cloudname` to something else.
+You can change the name of these entries by editing `local-overrides.yaml` and setting `local_cloudname` to something else.
 
 ## Validating the installation
 
-dev-install provides an additional playbook to validate the fresh deployment.
-This can be run with:
+`dev-install` provides an additional playbook to validate the fresh deployment. This can be run with:
 
-```
+```console
 make prepare_stack_testconfig
 ```
 
-This can be used to configure some helpful defaults for validating your
-cluster, namely:
+This can be used to configure some helpful defaults for validating your cluster, namely:
 
 - Configure SSH access
 - Configure routers and security groups to allow external network connectivity
@@ -88,55 +87,42 @@ cluster, namely:
 
 ## Network configuration
 
-dev-install will create a new OVS bridge called br-ex and move the host's
-external interface on to that bridge. This bridge is used to provide the
-`external` provider network if `external_fip_pool_start` and
-`external_fip_pool_end` are defined in `local-overrides.yaml`.
+`dev-install` will create a new OVS bridge called `br-ex` and move the host's external interface on to that bridge.
+This bridge is used to provide the `external` provider network if `external_fip_pool_start` and `external_fip_pool_end` are defined in `local-overrides.yaml`.
 
-In addition it will create OVS bridges called br-ctlplane and br-hostonly. The
-former is used internally by OSP. The latter is a second provider network which
-is only routable from the host.
+In addition it will create OVS bridges called `br-ctlplane` and `br-hostonly`. The former is used internally by OSP. The latter is a second provider network which is only routable from the host.
 
-Note that we don't enable DHCP on provider networks by default, and it is not
-recommended to enable DHCP on the external network at all. To enable DHCP on the
-hostonly network after installation, run:
+Note that we don't enable DHCP on provider networks by default, and it is not recommended to enable DHCP on the external network at all. To enable DHCP on the `hostonly` network after installation, run:
 
-```
+```console
 OS_CLOUD=standalone openstack subnet set --dhcp hostonly-subnet
 ```
 
-`make local_os_client` will write a
-[sshuttle](https://github.com/sshuttle/sshuttle) script to
-`scripts/sshuttle-standalone.sh` which will route to the hostonly provider
-network over ssh.
+`make local_os_client` will write a [sshuttle](https://github.com/sshuttle/sshuttle) script to `scripts/sshuttle-standalone.sh` which will route to the `hostonly` provider network over ssh.
 
 ## Configuration
 
-dev-install is configured by overriding variables in `local-overrides.yaml`. See
-the [default variable
-definitions](https://github.com/shiftstack/dev-install/blob/master/playbooks/vars/defaults.yaml)
-for what can be overridden.
+`dev-install` is configured by overriding variables in `local-overrides.yaml`.
+See the [default variable definitions](https://github.com/shiftstack/dev-install/blob/master/playbooks/vars/defaults.yaml) for what can be overridden.
 
 ## Sizing
 
 When idle, a standalone deployment uses approximately:
+
 * 16GB RAM
-* 15G on /
-* 3.5G on /home
-* 3.6G on /var/lib/cinder
-* 3.6G on /var/lib/nova
+* 15G on `/`
+* 3.5G on `/home`
+* 3.6G on `/var/lib/cinder`
+* 3.6G on `/var/lib/nova`
 
-There is no need to mount /var/lib/cinder and /var/lib/nova separately if / is large enough for your workload.
+There is no need to mount `/var/lib/cinder` and `/var/lib/nova` separately if `/` is large enough for your workload.
 
 ## Advanced features
 
 ### NFV enablement
 
-This section contains configuration procedures for single root input/output virtualization (SR-IOV)
-for network functions virtualization infrastructure (NFVi) in 
-your Standalone OpenStack deployment. 
-Unfortunately, most of these parameters don't have default values nor can be automatically figured out in
-a Standalone type environment.
+This section contains configuration procedures for single root input/output virtualization (SR-IOV) for network functions virtualization infrastructure (NFVi) in your Standalone OpenStack deployment. 
+Unfortunately, most of these parameters don't have default values nor can they be automatically calculated in a Standalone-type environment.
 
 #### SR-IOV Variables
 
@@ -145,11 +131,11 @@ To understand how the SR-IOV configuration works, please have a look at this [up
 | Name              | Default Value       | Description          |
 |-------------------|---------------------|----------------------|
 | `sriov_services` | `['OS::TripleO::Services::NeutronSriovAgent', 'OS::TripleO::Services::BootParams']` | List of TripleO services to add to the default Standalone role |
-| `sriov_interface` | `[undefined]` | Name of the SR-IOV capable interface. Must be enabled in BIOS. e.g. `ens1f0` |
+| `sriov_interface` | `[undefined]` | Name of the SR-IOV capable interface. Must be enabled in BIOS (e.g. `ens1f0`) |
 | `sriov_nic_numvfs` | `[undefined]` | Number of Virtual Functions that the NIC can handle. |
-| `sriov_nova_pci_passthrough` | `[undefined]` | List of PCI Passthrough whitelist parameters. [Guidelines](https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html/configuring_the_compute_service_for_instance_creation/configuring-pci-passthrough#guidelines-for-configuring-novapcipassthrough-osp) to configure it. |
+| `sriov_nova_pci_passthrough` | `[undefined]` | List of PCI Passthrough allowlist parameters. [Guidelines](https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html/configuring_the_compute_service_for_instance_creation/configuring-pci-passthrough#guidelines-for-configuring-novapcipassthrough-osp) to configure it. |
 
-Note: when SR-IOV is enabled, a dedicated provider network will be created and binded to the SR-IOV interface.
+Note: when SR-IOV is enabled, a dedicated provider network will be created and bound to the SR-IOV interface.
 
 #### Kernel Variables
 
@@ -168,10 +154,11 @@ It is possible to configure the deployment to be ready for DPDK:
 |-------------------|---------------------|----------------------|
 | `dpdk_services` | `['OS::TripleO::Services::ComputeNeutronOvsDpdk']` | List of TripleO services to add to the default Standalone role |
 | `dpdk_interface` | `[undefined]` | Name of the DPDK capable interface. Must be enabled in BIOS. e.g. `ens1f0` |
-| `tuned_isolated_cores` | `[undefined]` | List of logical CPU ids which need to be isolated from the host processes. This input is provided to the tuned profile cpu-partitioning to configure systemd and repin interrupts (IRQ repinning). |
+| `tuned_isolated_cores` | `[undefined]` | List of logical CPU ids which need to be isolated from the host processes. This input is provided to the tuned profile CPU-partitioning to configure systemd and repin interrupts (IRQ repinning). |
 
 When deploying DPDK, it is suggested to configure these options:
-```
+
+```yaml
 extra_heat_params:
   # A list or range of host CPU cores to which processes for pinned instance
   # CPUs (PCPUs) can be scheduled:
@@ -206,66 +193,74 @@ It is possible to deploy Edge-style environments, where multiple AZ are configur
 
 ##### Deploy the Central site
 
-Deploy a regular cloud with dev-install, and make sure you set these parameters: 
+Deploy a regular cloud with `dev-install`, and make sure you set these parameters: 
 
 * `dcn_az`: has to be `central`.
 * `tunnel_remote_ips`: list of known public IPs of the AZ nodes.
 
-Once this is done, you need to collect the content from `/home/stack/exported-data` into a local directory
-on the host where dev-install is executed.
+Once this is done, you need to collect the content from `/home/stack/exported-data` into a local directory on the host where `dev-install` is executed.
 
 ##### Deploy the "AZ" sites
 
-Before deploying OSP, you need to scp the content from `exported-data` into the remote hosts into
-`/opt/exported-data`.
-Once this is done, you can deploy the AZ sites with a regular config for dev-install, except that you'll need to set
-these parameters:
+Before deploying OSP, you need to `scp` the content from `exported-data` into the remote hosts into `/opt/exported-data`.
+Once this is done, you can deploy the AZ sites with a regular config for `dev-install`, except that you'll need to set these parameters:
 
-* `dcn_az`: must contains "az" in the string (e.g. az0, az1)
-* `local_ip`: choose an available IP in the control plane subnet, (e.g. 192.168.24.10)
-* `control_plane_ip`: same as for `local_ip`, pick one that is available (e.g. 192.168.24.11)
-* `hostonly_gateway`: if using provider networks, you'll need to select an available IP (e.g. 192.168.25.2)
-* `tunnel_remote_ips`: the list of known public IPs that will be used to establish the VXLAN tunnels.
-* `hostname`: you got to make sure both central and AZ doesn't use the default hostname (`standalone`), so set it at least on the compute. E.g. `compute1`.
-* `octavia_enabled`: set to `false`.
+* `dcn_az`: must contains `az` in the string (e.g. `az0`, `az1`)
+* `local_ip`: choose an available IP in the control plane subnet (e.g. `192.168.24.10`)
+* `control_plane_ip`: same as for `local_ip`, pick one that is available (e.g. `192.168.24.11`)
+* `hostonly_gateway`: if using provider networks, you'll need to select an available IP (e.g. `192.168.25.2`)
+* `tunnel_remote_ips`: the list of known public IPs that will be used to establish the VXLAN tunnels
+* `hostname`: you must make sure both central and AZ doesn't use the default hostname (`standalone`), so set it at least on the compute (e.g. `compute1`)
+* `octavia_enabled`: set to `false`
 
 Notes:
 
-* Control plane IPs (192.168.24.x) are arbitrary, if in doubt just use the example ones.
+* Control plane IPs (`192.168.24.x`) are arbitrary, if in doubt just use the example ones.
 * The control plane bridges will be connected thanks to VXLAN tunnels, which is why we need to select control plane IP for AZ nodes that were not taken on the Central site.
-* If you deploy the clouds in OpenStack, you need to make sure that the security groups allow VXLAN (udp/4789).
-* If the public IPs aren't predictable, you'll need to manually change the MTU on the br-ctlplane and br-hostonly on the central
-  site and the AZ sites where needed. You can do it by editing the os-net-config configuration file and run os-net-config to apply
+* If you deploy the clouds in OpenStack, you need to make sure that the security groups allow VXLAN (`udp/4789`).
+* If the public IPs aren't predictable, you'll need to manually change the MTU on the `br-ctlplane` and `br-hostonly` on the central
+  site and the AZ sites where needed. You can do it by editing the `os-net-config` configuration file and run `os-net-config` to apply
   it.
 
-After the installation you can "join" AZs to just have a regular multinode cloud. E.g.:
-```
+After the installation you can "join" AZs to just have a regular multi-node cloud. E.g.:
+
+```console
 openstack aggregate remove host az0 compute1.shiftstack
 openstack aggregate add host central compute1.shiftstack
 ```
 
 Then if you're using OVN (you probably are) you got to execute this on compute nodes:
-```
+
+```console
 ovs-vsctl set Open_vSwitch . external-ids:ovn-cms-options="enable-chassis-as-gw,availability-zones=central"
 ```
 
 #### Post Deployment Stack Updates
 
 It is possible to perform stack updates on an ephemeral standalone stack.
 
-Copying the generated tripleo_deploy.sh in your deployment users folder (eg. /home/stack/tripleo_deploy.sh) to tripleo_update.sh and add the parameter --force-stack-update.  This will allow you to modify the stack configuration without needing to redeploy the entire cloud which can save you considerable time.
+Copying the generated `tripleo_deploy.sh` in your deployment users folder (e.g. `/home/stack/tripleo_deploy.sh`) to `tripleo_update.sh` and add the parameter `--force-stack-update`.
+This will allow you to modify the stack configuration without needing to redeploy the entire cloud which can save you considerable time.
 
 #### Post install script
 
 It is possible to run any script in post-install with `post_install` parameter:
-```
+
+```yaml
 post_install: |
   export OS_CLOUD=standalone
   openstack flavor set --property hw:mem_page_size=large m1.smal
 ```
 
 And then run `make post_install`.
 
-## Tools
+## Troubleshooting
 
-You can find tools helping to work with DSAL machines in `tools/dsal` directory.
+If installation fails, examine the Ansible logs for more information.
+Failures will usually occur early in the process or during the `tripleo_deploy` stage. If the latter, you can look at the logs in `/home/stack/standalone_deploy.log`.
+Once the issue has been addressed, you can resume the deployment by stopping `heat` and running the `openstack tripleo deploy` command again via the `tripleo_deploy.sh` script:
+
+```console
+sudo pkill -9 heat-all
+./triple_deploy.sh
+```
