feat: Add endpoints.yaml to hyperconverged lab script to enable external OpenStack Access (rackerlabs#986)

Author: OpenStackKen

docs/build-test-envs.md

@@ -9,7 +9,7 @@ of deploying a test environment on an OpenStack cloud in a simple three node con
 The following script will deploy a hyperconverged lab environment on an OpenStack cloud. The script can be found at
 [`scripts/hyperconverged-lab.sh`](https://raw.githubusercontent.com/rackerlabs/genestack/refs/heads/main/scripts/hyperconverged-lab.sh).
 
-??? "View the Hyper-converged Lab Script"
+??? "View the  Hyper-converged Lab Script"
 
     ``` shell
     --8<-- "scripts/hyperconverged-lab.sh"
@@ -110,6 +110,71 @@ After the deployment is complete, the script will output the internal and extern
 
 With this information, operators can login to the Genestack instance and begin to explore the platform.
 
+!!! Genestack
+    Genestack uses DNS to route services in Kubernetes, which may be a bit different from what you might be used to in other lab environments, where
+    IP addresses are used heavily.  To be able to access OpenStack externally from the jumpbox, set `GATEWAY_DOMAIN` to a DNS domain that you control.
+
+### Setting up DNS for a Hyper-Converged Lab
+
+At the end of the hyper-converged lab script run, you will see output that looks like this:
+
+```
+The lab is now ready for use and took 1298 seconds to complete.
+This is the jump host address WW.XX.YY.ZZ, write this down.
+This is the VIP address internally 192.168.100.NN with public address AA.BB.CC.DD within MetalLB, write this down.
+```
+
+To make DNS correctly resolve the OpenStack services in the lab, you will need to set some DNS entries for the `GATEWAY_DOMAIN` you specified when building the lab.  Using the "cluster.local" default example domain, you should configure something like this:
+
+```
+jumpbox.cluster.local       A       WW.XX.YY.ZZ
+cluster.local               A       AA.BB.CC.DD
+*.cluster.local             CNAME   cluster.local
+```
+
+!!! Warning
+    Do **NOT** use `cluster.local` as your domain.  You will need to use a domain that you control and you will need to set the `GATEWAY_DOMAIN` variable to this prior to building your hyper-converged lab.
+
+### Accessing your Hyper-Converged Lab
+
+When generating your hyper-converged lab, the script creates an SSH key pair and puts it into your `$HOME/.ssh` directory.  The name of the key is derived from the `LAB_NAME_PREFIX` variable, and the default is `hyperconverged`.
+
+To access the lab, you can SSH into the jumpbox using this key as the default user of the OpenStack Glance image you specified.  The default image is Ubuntu 24.04 LTS which has a default user of `ubuntu`.  In this case, the SSH command would be as follows:
+
+```bash
+bash$ ssh -i $HOME/.ssh/hyperconverged-key.pem [email protected]
+```
+
+The jumpbox user has passwordless sudo if configured in the Glance image. (The Ubuntu 24.04 LTS image has this.)
+
+If you sudo to the `root` user, and look at the `clouds.yaml` file for that user, you will be able to see the OpenStack `admin` user password:
+
+```
+bash$ sudo su - root
+bash# cat $HOME/.config/openstack/clouds.yaml
+cache:
+  auth: true
+  expiration_time: 3600
+clouds:
+  default:
+    auth:
+      auth_url: http://keystone-api.openstack.svc.cluster.local:5000/v3
+      project_name: admin
+      tenant_name: default
+      project_domain_name: default
+      username: admin
+      password: <PASSWORD>
+      user_domain_name: default
+    region_name: RegionOne
+    interface: internal
+    identity_api_version: "3"
+```
+
+This can be used to login to the Skyline web console.  To access the Skyline web console, you can just enter `https://skyline.cluster.local` (again, using `cluster.local` as an example) and access it from your web browser.
+
+!!! Note
+    If you get SSL errors, wait a bit. Cert Manager takes time to generate all the SSL certs it using with Let's Encrypt.
+
 ## Demo
 
 [![asciicast](https://asciinema.org/a/706976.svg)](https://asciinema.org/a/706976)