diff options
Diffstat (limited to 'docs/part-2/2_xds-agent.md')
| -rw-r--r-- | docs/part-2/2_xds-agent.md | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/docs/part-2/2_xds-agent.md b/docs/part-2/2_xds-agent.md index ce03ae7..1429715 100644 --- a/docs/part-2/2_xds-agent.md +++ b/docs/part-2/2_xds-agent.md @@ -12,6 +12,7 @@ used to remotely cross build applications. ## Configuration xds-agent configuration is driven by a JSON config file. + The tarball mentioned in previous section includes this file with default settings. Here is the logic to determine which conf file will be used: @@ -52,7 +53,9 @@ below corresponds to the default values): } ``` ->**Note:** environment variables are supported by using `${MY_VAR}` syntax. +>**Note:** +> +>environment variables are supported by using `${MY_VAR}` syntax. ## Start-up @@ -62,7 +65,9 @@ Simply to start `xds-agent` executable ./xds-agent & ``` ->**Note:** if need be, you can increase log level by setting option +>**Note:** +> +>If need be, you can increase log level by setting option `--log <level>`, supported *level* are: panic, fatal, error, warn, info, debug. You can now use XDS dashboard and check that connection with `xds-agent` is up. @@ -94,7 +99,9 @@ And to install xds-agent (by default in `/usr/local/bin`): make install ``` ->**Note:** Used `DESTDIR` to specify another install directory +>**Note:** +> +>Used `DESTDIR` to specify another install directory >```bash >make install DESTDIR=$HOME/opt/xds-agent >``` @@ -158,10 +165,15 @@ The agent part is written in *Go* and the webapp / dashboard is in *typescript + Visual Studio Code launcher settings can be found into `.vscode/launch.json`. ->**Tricks:** To debug both `xds-agent` and `xds-server` or common code -`xds-common`, it may be useful use the same local sources. -So you should replace `xds-server` + `xds-common` in `vendor` directory by a symlink. -So clone first `xds-server` + `xds-common` sources next to `xds-agent` directory. +>**Tricks:** +> +>To debug both `xds-agent` and `xds-server` or common code +>`xds-common`, it may be useful use the same local sources. +> +>So you should replace `xds-server` + `xds-common` in `vendor` directory by a symlink. +> +>So clone first `xds-server` + `xds-common` sources next to `xds-agent` directory. + You should have the following tree: ```bash |