Skip to content

Commit

Permalink
[docs][feg] Add comments on location of control proxy and env files (#…
Browse files Browse the repository at this point in the history
…5321)

Signed-off-by: Oriol Batalla <obatalla@fb.com>
  • Loading branch information
uri200 committed Mar 8, 2021
1 parent 6d79178 commit 70adc4b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/readmes/feg/deploy_build.md
Expand Up @@ -28,6 +28,8 @@ Then go run those commands to build FeG.
```bash
cd magma/feg/gateway/docker
docker-compose build --parallel
# if build fails try with sudo and without parallelization
sudo docker-compose build
```

Note that you are building FeG from your local repository. There is no need to
Expand Down
9 changes: 7 additions & 2 deletions docs/readmes/feg/deploy_install.md
Expand Up @@ -17,7 +17,9 @@ that the Federation Gateway will connect to.
and `control_proxy` services to point toward the appropriate Orchestrator.
A sample configuration is provided below. The `bootstrap_address`,
`bootstrap_port`, `controller_address`, and `controller_port` are the
parameters that will likely need to be modified.
parameters that will likely need to be modified (check
`/magma/feg/gateway/configs/control_proxy.yml` for the most recent
format)

```
#
Expand Down Expand Up @@ -61,7 +63,8 @@ allow_http_proxy: True

* `.env` - This file provides any deployment specific environment variables used
in the `docker-compose.yml` of the Federation Gateway. A sample configuration
is provided below:
is provided below (please check `magma/feg/gateway/docker/.env` for the most
recent format):

```
# Copyright 2020 The Magma Authors.
Expand All @@ -84,6 +87,8 @@ IMAGE_VERSION=latest
ROOTCA_PATH=/var/opt/magma/certs/rootCA.pem
CONTROL_PROXY_PATH=/etc/magma/control_proxy.yml
SNOWFLAKE_PATH=/etc/snowflake
CONFIGS_DEFAULT_VOLUME=/etc/magma
CONFIGS_TEMPLATES_PATH=/etc/magma/templates
CERTS_VOLUME=/var/opt/magma/certs
CONFIGS_VOLUME=/var/opt/magma/configs
Expand Down

0 comments on commit 70adc4b

Please sign in to comment.