airship/airshipctl
Code Issues Proposed changes

Update developer guide for deployment with proxy

Browse Source 
This commit updates the developers.md file with the files where proxy
have to be set. Also give an example of user-data for proxy setting
in ephemeral node.

Depends-On: https://review.opendev.org/#/c/723057/

Change-Id: I9812cee8cd76807353c05aca1dc4ff9adba62f9b
Signed-off-by: Sreejith Punnapuzha <sreejith.punnapuzha@outlook.com>
This commit is contained in:
Sreejith Punnapuzha 2020-04-24 11:35:20 -05:00
parent 486ad67cba
commit 7526c22444
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/source/developers.md
View File

@ -32,20 +32,41 @@ 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
When running the gate scripts in `tools/gate` locally, if you have not set proxy
information in user's environment or profile then you will need to add your
proxy information to
`roles/airshipctl-systemwide-executable/defaults/main.yaml`.
`playbooks/vars/local-dev.yaml`.
Apart from adding proxy information to playbook, we have to add proxy information
to site definations documents. For ephemeral iso to pull docker images behind
proxy, user-data section for ephemeral iso has to be updated in the below file
`manifests/function/ephemeral/secret.yaml`.
Add the following contents to the file in runcmd section
```
- export http_proxy=http://username:password@host:port
- export https_proxy=$http_proxy
- export HTTP_PROXY=$http_proxy
- export HTTPS_PROXY=$http_proxy
```
Add the following contents to the file in write_files section
```
- path: /etc/systemd/system/docker.service.d/http-proxy.conf
permissions: '0644'
owner: root:root
content: |
[Service]
Environment="HTTP_PROXY=http://username:password@host:port"
Environment="HTTPS_PROXY=http://username:password@host:port"
Environment="NO_PROXY=127.0.0.1,localhost,10.23.25.0/24"
```
## Building airshipctl
The simplest way to get started is: