From edf352313839b5a254cb8faf6fdb14ac2be2c7bc Mon Sep 17 00:00:00 2001 From: Drew Walters Date: Mon, 20 Apr 2020 20:33:30 +0000 Subject: [PATCH] Add simple proxy guidelines 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 --- docs/source/developers.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/source/developers.md b/docs/source/developers.md index 1047042fd..d8a2f60b7 100644 --- a/docs/source/developers.md +++ b/docs/source/developers.md @@ -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 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 The simplest way to get started is: