185f25e356
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
69 lines
3.0 KiB
ReStructuredText
69 lines
3.0 KiB
ReStructuredText
=====================================
|
|
Running Jarvis Behind Corporate Proxy
|
|
=====================================
|
|
|
|
Environment Variables
|
|
=====================
|
|
|
|
On the host machine, ensure the following environment variables are set with the appropriate proxy information:
|
|
``HTTP_PROXY``, ``HTTPS_PROXY``, and ``NO_PROXY``. You will also need to set the environment variable ``PRIVATE_NS``
|
|
to an IP address of a corporate name server that will resolve internal URLs. ``PRIVATE_NS`` can support multiple
|
|
corporate name servers by creating a space separated list, such as ``PRIVATE_NS="172.18.0.17 172.19.0.17"``.
|
|
|
|
Certificate Authority for Corporate Proxy
|
|
=========================================
|
|
|
|
If the proxy requires a certificate to trust then:
|
|
|
|
#. Run ``mkdir ~/internal-certs/``
|
|
#. Download the required ``*.crt`` file
|
|
#. Move the ``*.crt`` file into ``~/internal-certs/``
|
|
#. Define an environment variable named ``INTERNAL_CERTS_DIR`` with the value of ``~/internal-certs/``
|
|
|
|
The ``Vagrantfile`` will handle using the internal certificates during the ``vagrant up`` process.
|
|
|
|
Vagrant Plugin
|
|
==============
|
|
|
|
To easily set up the Vagrant box's proxy setting, install the `vagrant_proxyconf`_ plugin by running:
|
|
|
|
.. code:: bash
|
|
|
|
$ 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
|
|
==========================
|
|
|
|
In the event ``NO_PROXY`` is not specified, the following default value will be used:
|
|
|
|
.. code::
|
|
|
|
localhost,127.0.0.1,10.96.0.0/12,192.168.49.0/24,192.168.99.0/24,10.0.2.15,10.244.0.0/16,172.28.0.0/30,.minikube.internal,.svc,.svc.cluster.local,jarvis.local
|
|
|
|
Please note the following will need to be accounted for to avoid traffic being routed through the proxy:
|
|
|
|
- Localhost: ``localhost`` and ``127.0.0.1``,
|
|
- Host and guest machine IP and name: ``jarvis``, ``jarvis.local``, etc.,
|
|
- Minikube specific IP ranges (e.g. ``102.168.49.0/24``). See minikube's `documentation`_ for detail,
|
|
- Minikube places ``host.minikube.internal`` and ``control-plane.minikube.internal`` into ``/etc/hosts``,
|
|
- Kubernetes services' URLs with ending of ``.svc``, ``.cluster.local`` or ``.svc.cluster.local``,
|
|
- Kubernetes service cluster IP ranges: ``10.96.0.0/12`` or what's configured via ``--service-cluster-ip-range``.
|
|
- DNSMasq subnet range: ``172.28.0.0/30``
|
|
|
|
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/
|