From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Wed, 2 May 2018 20:16:31 +0000 (-0400)
Subject: Migrate LF Network docs to RST
X-Git-Tag: v0.1.0~36
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=5057100ed014a718fa9abcdda22a286ce259471f;p=releng%2Fcommon-packer.git

Migrate LF Network docs to RST

Move the LF Network portion of the README into RST. This provides
details on how to bootstrap through the LF Network for LF Staff
to initialize the first image on a new setup.

Issue: RELENG-513
Change-Id: I85bd8b298bcc330b24b6c3aa40cf71fdef527d50
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/lf-network.rst b/docs/lf-network.rst
new file mode 100644
index 0000000..14f3321
--- /dev/null
+++ b/docs/lf-network.rst
@@ -0,0 +1,42 @@
+##########
+LF Network
+##########
+
+.. note::
+
+   This doc is relevant to LF staff who have access to the VPN network.
+
+To bootstrap an image inside the LF network the packer configuration contains
+an ``ssh_proxy_host`` variable to connect to a SOCKS5 proxy through a known
+system such as Jenkins to connect to the VM instance on the network.
+
+Connect through the LF network
+==============================
+
+#. Connect to the VPN
+#. Set ``ssh_proxy_host`` to **127.0.0.1** in vars/cloud-env.json
+#. Create a SOCKS 5 proxy on port 1080
+
+   .. code-block:: bash
+
+      ssh -fND 1080 vex-yul-odl-jenkins-2.ci.codeaurora.org
+
+   Replace the server ``vex-yul-odl-jenkins-2.ci.codeaurora.org`` with a known
+   server for the relevant project.
+
+#. Run packer as usual
+
+**Bonus**
+
+If you would like to be able to ssh directly to a dynamic system inside of the
+LF Network add the following to ``~/.ssh/config``:
+
+.. code-block:: bash
+
+   Host 10.30.18*
+     ProxyCommand ssh vex-yul-acumos-jenkins-2.ci.codeaurora.org nc %h 22
+     StrictHostKeyChecking no
+     UserKnownHostsFile /dev/null
+
+Replace the server ``vex-yul-acumos-jenkins-2.ci.codeaurora.org`` with a known
+server for the relevant project.