Remove install_yamls reference from user facing docs

Signed-off-by: Fabricio Aguiar <[email protected]>

.github/workflows/docs.yaml

@@ -38,6 +38,15 @@ jobs:
       - name: Build dev docs
         run: make docs-dev
 
+      - name: Test user docs
+        run: |
+          INSTALL_YAMLS_REF=$(grep -o install_yamls docs_build/adoption-user/index-downstream.html | wc -l)
+          if [[ $INSTALL_YAMLS_REF -gt 0 ]]; then
+              echo user facing docs should NOT mention install_yamls
+              grep install_yamls docs_build/adoption-user/index-downstream.html
+              exit 1
+          fi
+
       - name: Prepare gh-pages branch
         run: |
           git config user.name github-actions

docs_user/modules/openstack-backend_services_deployment.adoc

@@ -23,19 +23,23 @@ floating IP is set into `FIP` env var. You can use a helper script to create tha
 //xref:../docs_dev/assemblies/development_environment.adoc#virtual-machine-steps[helper script] kgilliga: Commented out because this might break the build downstream.
 * The `openstack-operator` is deployed, but `OpenStackControlPlane` is
 *not* deployed.
+ifeval::["{build}" != "downstream"]
 +
 For developer/CI environments, the openstack operator can be deployed
 by running `make openstack` inside
 https://github.com/openstack-k8s-operators/install_yamls[install_yamls]
 repo.
 +
+endif::[]
 For production environments, the deployment method will likely be
 different.
 
 * There are free PVs available to be claimed (for MariaDB and RabbitMQ).
+ifeval::["{build}" != "downstream"]
 +
 For developer/CI environments driven by install_yamls, make sure
 you've run `make crc_storage`.
+endif::[]
 
 == Variables
 
@@ -89,6 +93,7 @@ oc project openstack
 ----
 
 * Create OSP secret.
+ifeval::["{build}" != "downstream"]
 +
 The procedure for this will vary, but in developer/CI environments
 you use install_yamls:
@@ -97,7 +102,7 @@ you use install_yamls:
 # in install_yamls
 make input
 ----
-
+endif::[]
 * If the `$ADMIN_PASSWORD` is different than the already set password
 in `osp-secret`, amend the `AdminPassword` key in the `osp-secret`
 correspondingly:

docs_user/modules/openstack-ceph_backend_configuration.adoc

@@ -18,8 +18,14 @@ adopted deployment and CRs must be configured accordingly.
 Define the shell variables used in the steps below. The values are
 just illustrative, use values that are correct for your environment:
 
+[subs=+quotes]
 ----
+ifeval::["{build}" != "downstream"]
 CEPH_SSH="ssh -i ~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa [email protected]"
+endif::[]
+ifeval::["{build}" == "downstream"]
+CEPH_SSH="ssh -i *<path to SSH key>* root@*<node IP>*"
+endif::[]
 CEPH_KEY=$($CEPH_SSH "cat /etc/ceph/ceph.client.openstack.keyring | base64 -w 0")
 CEPH_CONF=$($CEPH_SSH "cat /etc/ceph/ceph.conf | base64 -w 0")
 ----

docs_user/modules/openstack-edpm_adoption.adoc

@@ -122,6 +122,7 @@ lands.
 For each compute node grab the UUID of the compute service and write it too
 the stable `compute_id` file in `/var/lib/nova/` directory.
 +
+[subs=+quotes]
 ----
 for name in "${!computes[@]}";
 do
@@ -131,14 +132,20 @@ do
   )
   echo "Writing $uuid to /var/lib/nova/compute_id on $name"
   ssh \
+ifeval::["{build}" != "downstream"]
     -i ~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa \
+endif::[]
+ifeval::["{build}" == "downstream"]
+    -i *<path to SSH key>* \
+endif::[]
     root@"${computes[$name]}" \
       "grep -qF $uuid /var/lib/nova/compute_id || (echo $uuid | sudo tee /var/lib/nova/compute_id && sudo chown 42436:42436 /var/lib/nova/compute_id && sudo chcon -t container_file_t /var/lib/nova/compute_id)"
 done
 ----
 
 * Create a https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets[ssh authentication secret] for the EDPM nodes:
 +
+[subs=+quotes]
 ----
 oc apply -f - <<EOF
 apiVersion: v1
@@ -148,7 +155,12 @@ metadata:
     namespace: openstack
 data:
     ssh-privatekey: |
+ifeval::["{build}" != "downstream"]
 $(cat ~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa | base64 | sed 's/^/        /')
+endif::[]
+ifeval::["{build}" == "downstream"]
+$(cat *<path to SSH key>* | base64 | sed 's/^/        /')
+endif::[]
 EOF
 ----
 

docs_user/modules/openstack-planning.adoc

@@ -114,6 +114,7 @@ make build
 Then configure ansible.cfg and ssh-config file according to your environment:
 
 [source,yaml]
+[subs=+quotes]
 ----
 Host *
     IdentitiesOnly yes
@@ -128,7 +129,12 @@ Host virthost
 
 Host standalone
     Hostname standalone
+ifeval::["{build}" != "downstream"]
     IdentityFile ~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa
+endif::[]
+ifeval::["{build}" == "downstream"]
+    IdentityFile *<path to SSH key>*
+endif::[]
     User root
     StrictHostKeyChecking no
     UserKnownHostsFile=/dev/null

docs_user/modules/openstack-stop_openstack_services.adoc

@@ -31,8 +31,14 @@ as:
 Define the shell variables used in the following steps. The values are illustrative and refer to a single node standalone director deployment. Use values that are correct for your environment:
 
 [source,bash]
+[subs=+quotes]
 ----
+ifeval::["{build}" != "downstream"]
 CONTROLLER1_SSH="ssh -i ~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa [email protected]"
+endif::[]
+ifeval::["{build}" == "downstream"]
+CONTROLLER1_SSH="ssh -i *<path to SSH key>* root@*<node IP>*"
+endif::[]
 CONTROLLER2_SSH=""
 CONTROLLER3_SSH=""
 ----

docs_user/modules/openstack-stop_remaining_services.adoc

@@ -20,8 +20,14 @@ Define the shell variables used in the steps below.
 Define the map of compute node name, IP pairs.
 The values are just illustrative and refer to a single node standalone director deployment, use values that are correct for your environment:
 
+[subs=+quotes]
 ----
+ifeval::["{build}" != "downstream"]
 EDPM_PRIVATEKEY_PATH="~/install_yamls/out/edpm/ansibleee-ssh-key-id_rsa"
+endif::[]
+ifeval::["{build}" == "downstream"]
+EDPM_PRIVATEKEY_PATH="*<path to SSH key>*"
+endif::[]
 declare -A computes
 computes=(
   ["standalone.localdomain"]="192.168.122.100"