airship/airshipctl
Code Issues Proposed changes

Add simple proxy guidelines

Browse Source 
There are currently no guidelines provided for using airshipctl behind a
corporate proxy server even though additional configuration is
necessary.

This change adds a simple proxy guide that outlines the requirements for
running airshipctl behind a simple proxy server.

Change-Id: I7b4959e1758ff4dfccdf3aec0e569aa77214bd3e
Signed-off-by: Drew Walters <andrew.walters@att.com>
This commit is contained in:
Drew Walters 2020-04-20 20:33:30 +00:00
parent a0cb765d73
commit edf3523138
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/developers.md
View File

@ -25,6 +25,27 @@ Additionally, there is a script in the airshipctl directory named as
`00_setup.sh`. This script will download all the required binaries and `00_setup.sh`. This script will download all the required binaries and
packages. This script can be checked [here][1]. packages. This script can be checked [here][1].
### Proxy
If your organization requires development behind a proxy server, you will need
to define the following environment variables with your organization's
information:
```
http_proxy=http://username:password@host:port
https_proxy=http://username:password@host:port
no_proxy="localhost,127.0.0.1"
HTTP_PROXY=http://username:password@host:port
HTTPS_PROXY=http://username:password@host:port
NO_PROXY="localhost,127.0.0.1"
PROXY=http://username:password@host:port
USE_PROXY=true
```
When running the gate scripts in `tools/gate` locally, you will need to add your
proxy information to
`roles/airshipctl-systemwide-executable/defaults/main.yaml`.
## Building airshipctl ## Building airshipctl
The simplest way to get started is: The simplest way to get started is: