Adding Documentation for use of proxies in magnum.

This patch adds documentation for using a proxy when running magnum
behind a firewall. Currently this feature only works with Swarm
bays.

Co-Authored By: Adrian Otto <adrian.otto@rackspace.com>
Change-Id: If3f53978b11b6558b304a5c369b85fd9aa1e4a52
Partially-Implements: blueprint add-proxy
This commit is contained in:
Manjeet Singh Bhatia 2015-09-28 17:29:45 -04:00 committed by Adrian Otto
parent 2d76ef7cf5
commit b3c6dad3e0
2 changed files with 56 additions and 0 deletions

View File

@ -350,6 +350,12 @@ as the coe::
--flavor-id m1.small \
--coe swarm
Note: If you are using Magnum behind a firewall then see:
.. _Using_Magnum_Behind_Firewall:
http://docs.openstack.org/developer/magnum/magnum-proxy.rst
Finally, create the bay. Use the baymodel 'swarmbaymodel' as a template for
bay creation. This bay will result in one swarm manager node and two extra
agent nodes::

View File

@ -0,0 +1,50 @@
=================================================
Using Proxies in magnum if running under firewall
=================================================
If you are running magnum behind a firewall then you may need a proxy
for using services like docker, kubernetes and mesos. Use these steps
when your firewall will not allow you to use those services without a
proxy.
NOTE: This feature only works with Swarm bays.
Proxy Parameters to define before use
=====================================
1. http-proxy
Address of a proxy that will receive all HTTP requests and relay
them. The format is a URL including a port number. For example:
http://10.11.12.13:8000 or http://abcproxy.com:8000
2. https-proxy
Address of a proxy that will receive all HTTPS requests and relay
them. The format is a URL including a port number. For example:
https://10.11.12.13:8000 or https://abcproxy.com:8000
3. no-proxy
A comma separated list of IP addresses or hostnames that should bypass
your proxy, and make conenctions directly.
NOTE: You may not express networks/subnets. It only accepts names
and ip addresses. Bad example: 192.168.0.0/28.
Steps to to configure proxies.
==============================
You can specify all three proxy parameteres while creating baymodel of any
coe type. All of proxy parameters are optional.
magnum baymodel-create --name swarmbaymodel \
--image-id fedora-21-atomic-5 \
--keypair-id testkey \
--external-network-id public \
--dns-nameserver 8.8.8.8 \
--flavor-id m1.small \
--coe swarm \
--http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \
--no-proxy <172.24.4.4,172.24.4.9,172.24.4.8>