Move vSphere/OpenStack socks5 proxy NOTE to partial

appuio · Oct 26, 2023 · 0059b62 · 0059b62
1 parent cfe98b3
commit 0059b62
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 16 deletions.
diff --git a/docs/modules/ROOT/pages/how-tos/vsphere/install.adoc b/docs/modules/ROOT/pages/how-tos/vsphere/install.adoc
@@ -129,22 +129,7 @@ include::partial$install/prepare-syn-config.adoc[]
 
 === Provision the cluster
 
-[NOTE]
-====
-The steps in this section must be run on a host which can reach the vSphere API.
-If you can't reach the vSphere API directly, you can setup a SOCKS5 proxy with the following commands:
-
-[source,bash]
-----
-export JUMPHOST_FQDN=<jumphost fqdn or alias from your SSH config> <1>
-ssh -D 12000 -q -f -N ${JUMPHOST_FQDN} <2>
-export https_proxy=socks5://localhost:12000 <3>
-export CURL_OPTS="-xsocks5h://localhost:12000"
-----
-<1> The FQDN or SSH alias of the host which can reach the vSphere API
-<2> This command expects that your SSH config is setup so that `ssh ${JUMPHOST_FQDN}` works without further configuration
-<3> The `openshift-install` tool respects the `https_proxy` environment variable
-====
+include::partial$install/socks5-proxy.adoc[]
 
 . Trust the vSphere CA certificate
 +

diff --git a/docs/modules/ROOT/partials/install/socks5-proxy.adoc b/docs/modules/ROOT/partials/install/socks5-proxy.adoc
@@ -0,0 +1,24 @@
+:provider-display: UNKNOWN
+ifeval::["{provider}" == "vsphere"]
+:provider-display: vSphere
+endif::[]
+ifeval::["{provider}" == "openstack"]
+:provider-display: OpenStack
+endif::[]
+
+[NOTE]
+====
+The steps in this section must be run on a host which can reach the {provider-display} API.
+If you can't reach the {provider-display} API directly, but a SSH jumphost is available, you can setup a SOCKS5 proxy with the following commands:
+
+[source,bash]
+----
+export JUMPHOST_FQDN=<jumphost fqdn or alias from your SSH config> <1>
+ssh -D 12000 -q -f -N ${JUMPHOST_FQDN} <2>
+export https_proxy=socks5://localhost:12000 <3>
+export CURL_OPTS="-xsocks5h://localhost:12000"
+----
+<1> The FQDN or SSH alias of the host which can reach the {provider-display} API
+<2> This command expects that your SSH config is setup so that `ssh ${JUMPHOST_FQDN}` works without further configuration
+<3> The `openshift-install` tool respects the `https_proxy` environment variable
+====