status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-12 06:44:41 +00:00
Code Issues Projects Releases Wiki Activity

Bootstrap Consul on Windows VMs instructions

Browse Source
This commit is contained in:
boruszak 2022-09-27 15:16:39 -05:00
parent 84f8b87967
commit b0cbecae7d
1 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
website/content/docs/connect/proxies/envoy.mdx
View File

@ -112,7 +112,7 @@ Envoy requires an initial bootstrap configuration file. The easiest way to
create this is using the [`consul connect envoy` create this is using the [`consul connect envoy`
command](/commands/connect/envoy). The command can either output the command](/commands/connect/envoy). The command can either output the
bootstrap configuration directly to stdout, or generate the configuration and issue an `exec` command bootstrap configuration directly to stdout, or generate the configuration and issue an `exec` command
to the Envoy binary as a convenience wrapper. to the Envoy binary as a convenience wrapper. For more information about using `exec` to bootstrap Envoy, refer to [Exec Security Details](/consul/commands/connect/envoy#exec-security-details).
Because some Envoy configuration options, such as metrics and tracing sinks, can only be Because some Envoy configuration options, such as metrics and tracing sinks, can only be
specified via the bootstrap configuration, Connect as of Consul 1.5.0 adds specified via the bootstrap configuration, Connect as of Consul 1.5.0 adds
@ -174,6 +174,33 @@ definition](/docs/connect/registration/service-registration) or
The [Advanced Configuration](#advanced-configuration) section describes additional configurations that allow incremental or complete control over the bootstrap configuration generated. The [Advanced Configuration](#advanced-configuration) section describes additional configurations that allow incremental or complete control over the bootstrap configuration generated.
### Bootstrap Consul on Windows VMs
If you are running Consul on a Windows VM, the `consul connect envoy` command returns the following output:
```shell-session hideClipboard
Directly running Envoy is only supported on linux and macOS since envoy itself doesn't build on other plataforms currently.
Use the -bootstrap option to generate the JSON to use when running envoy on a supported OS or via a container or VM.
```
To bootstrap Envoy on Windows VMs, you must generate the bootstrap configuration as a .json file and then manually edit it to add both your ACL token and a valid access log path.
First, add the `-bootstrap` option to the command and save the output to a file:
```shell-session
$ consul connect envoy -bootstrap > bootstrap.json
```
Then, open `bootstrap.json` and add your ACL token and log path to the file.
To complete the bootstrap process, start Envoy and include the path to `bootstrap.json`:
```shell-session
envoy -c <C://path/to/bootstrap.json>
```
~> **Tip**: The `bootstrap.json` file contains your ACL token. Because the file is no longer needed after bootstrapping is complete, delete it to protect your network.
## Dynamic Configuration ## Dynamic Configuration
Consul automatically generates Envoy's dynamic configuration based on its Consul automatically generates Envoy's dynamic configuration based on its