From 185f25e356660a187ca984c2fa4df1bafd0da2be Mon Sep 17 00:00:00 2001
From: Dustin Specker <dustin.specker@att.com>
Date: Mon, 8 Mar 2021 14:12:43 -0600
Subject: [PATCH] docs(install): add note about vpn and vagrant commands behind
 proxy

If behind a vpn, port forwarding is most likely required, so add a note.

Specify environment variables required to use a certificate for a
corporate proxy to download vagrant plugins and boxes.

Change-Id: Ie1f1e709ba9f5ab0a614daaf6d771a904e749bd6
---
 doc/source/install/jarvis/proxy.rst   | 9 +++++++++
 doc/source/install/jarvis/vagrant.rst | 5 +++++
 2 files changed, 14 insertions(+)

diff --git a/doc/source/install/jarvis/proxy.rst b/doc/source/install/jarvis/proxy.rst
index 8ecf3f5d..406f1652 100644
--- a/doc/source/install/jarvis/proxy.rst
+++ b/doc/source/install/jarvis/proxy.rst
@@ -31,6 +31,10 @@ To easily set up the Vagrant box's proxy setting, install the `vagrant_proxyconf
 
   $ vagrant plugin install vagrant-proxyconf
 
+.. note::
+  Executing the above command behind a proxy requiring a certificate will require the ``SSL_CERT_FILE`` environment variable to
+  be defined and pointing at a file that may be used to trust the proxy.
+
 ``NO_PROXY`` Configuration
 ==========================
 
@@ -55,5 +59,10 @@ Installation
 
 With the appropriate environment variables set, follow instruction :ref:`here <aio-installation>`.
 
+.. note::
+   If running behind a proxy that requires a certificate, define ``CURL_CA_BUNDLE`` environment variable
+   pointing at a file that may be used to trust the proxy when running ``vagrant up``,
+   so that vagrant may successfully download the Vagrant box.
+
 .. _vagrant_proxyconf: http://tmatilai.github.io/vagrant-proxyconf/
 .. _documentation: https://minikube.sigs.k8s.io/docs/handbook/vpn_and_proxy/
diff --git a/doc/source/install/jarvis/vagrant.rst b/doc/source/install/jarvis/vagrant.rst
index 03efc97f..5ce06f91 100644
--- a/doc/source/install/jarvis/vagrant.rst
+++ b/doc/source/install/jarvis/vagrant.rst
@@ -67,3 +67,8 @@ To access the exposed Jarvis services in the Vagrant box, update the
 
 .. note:: Replace ``jarvis.local`` with the appropriate host and domain name if
   those are overwritten.
+
+If using a corporate VPN, then port forwarding is recommended. Instead of using ``192.168.56.10`` above, use ``127.0.0.1``. After running
+``vagrant up``, open VirtualBox. Select the created VM. Click "Settings." Select the "Network" tab. Expand the "Advanced" section. Click the "Port Forwarding"
+button. Add a new Port Forwarding Rule. Specify a host port of ``443`` and a guest port of ``443``. Click "Ok" to close "Port Forwarding Rules." Click "Ok" again
+to close "Settings." Now, the above services should be accessible via a web browser once ``vagrant up`` is successful.