You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-18
Original file line number
Diff line number
Diff line change
@@ -158,34 +158,39 @@ out the values that were used. The environment variable are as follows.
158
158
Defaults are in bold at the end of the line:
159
159
160
160
*`SIDECAR_LOGGING_LEVEL`: The logging level to use (debug, info, warn, error)
161
-
*info**
161
+
**info**
162
162
*`SIDECAR_LOGGING_FORMAT`: Logging format to use (text, json) **text**
163
163
*`SIDECAR_DISCOVERY`: Which discovery backends to use as a csv array
164
-
(static, docker) *`[ docker ]`**
164
+
(static, docker) **`[ docker ]`**
165
+
*`SIDECAR_SEEDS`: csv array of IP addresses used to seed the cluster.
166
+
*`SIDECAR_CLUSTER_NAME`: The name of the Sidecar cluster. Restricts membership
167
+
to hosts with the same cluster name.
168
+
*`SIDECAR_ADVERTISE_IP`: Manually override the IP address Sidecar uers for
169
+
cluster membership.
165
170
*`SIDECAR_EXCLUDE_IPS`: csv array of IPs to exclude from interface selection
166
-
*`[ 192.168.168.168 ]`**
171
+
**`[ 192.168.168.168 ]`**
167
172
*`SIDECAR_STATS_ADDR`: An address to send performance stats to. **none**
168
173
*`SIDECAR_PUSH_PULL_INTERVAL`: How long to wait between anti-entropy syncs.
169
-
*20s**
174
+
**20s**
170
175
*`SIDECAR_GOSSIP_MESSAGES`: How many times to gather messages per round. **15**
171
176
*`SIDECAR_DEFAULT_CHECK_ENDPOINT`: Default endpoint to health check services
172
-
on *`/version`**
177
+
on **`/version`**
173
178
174
179
*`SERVICES_NAMER`: Which method to use to extract service names. In both
175
-
cases it will fall back to image name. (docker_label, regex) *`docker_label`**.
180
+
cases it will fall back to image name. (`docker_label`, `regex`) **`docker_label`**.
176
181
*`SERVICES_NAME_MATCH`: The regexp to use to extract the service name
177
182
from the container name.
178
183
*`SERVICES_NAME_LABEL`: The Docker label to use to identify service names
179
184
`ServiceName`
180
185
181
186
*`DOCKER_URL`: How to connect to Docker if Docker discovery is enabled.
182
-
*`unix:///var/run/docker.sock`**
187
+
**`unix:///var/run/docker.sock`**
183
188
184
189
*`STATIC_CONFIG_FILE`: The config file to use if static discovery is enabled
185
-
*`static.json`**
190
+
**`static.json`**
186
191
187
-
*`LISTENER_URLS`: If we want to statically configure any even listeners, the
188
-
URLs should go in a csv array here. See ***Listeners**** section below for more
192
+
*`LISTENER_URLS`: If we want to statically configure any event listeners, the
193
+
URLs should go in a csv array here. See **Listeners** section below for more
189
194
on dynamic listeners.
190
195
191
196
*`HAPROXY_DISABLE`: Disable management of HAproxy entirely. This is useful if
@@ -196,23 +201,25 @@ Defaults are in bold at the end of the line:
196
201
*`HAPROXY_VERIFY_COMMAND`: The verify command to use for HAproxy **sane defaults**
197
202
*`HAPROXY_BIND_IP`: The IP that HAproxy should bind to on the host **192.168.168.168**
198
203
*`HAPROXY_TEMPLATE_FILE`: The source template file to use when writing HAproxy
199
-
configs. This is a Go text template. *`views/haproxy.cfg`**
204
+
configs. This is a Go text template. **`views/haproxy.cfg`**
200
205
*`HAPROXY_CONFIG_FILE`: The path where the `haproxy.cfg` file will be written. Note
201
206
that if you change this you will need to update the verify and reload commands.
202
-
*`/etc/haproxy.cfg`**
207
+
**`/etc/haproxy.cfg`**
203
208
*`HAPROXY_PID_FILE`: The path where HAproxy's PID file will be written. Note
204
209
that if you change this you will need to update the verify and reload commands.
205
-
*`/var/run/haproxy.pid`**
210
+
**`/var/run/haproxy.pid`**
206
211
*`HAPROXY_USER`: The Unix user under which HAproxy should run **haproxy**
207
-
*`HAPROXY_GROUP`: The Unix group under which HAproxy shoudl run **haproxy**
212
+
*`HAPROXY_GROUP`: The Unix group under which HAproxy should run **haproxy**
208
213
*`HAPROXY_USE_HOSTNAMES`: Should we write hostnames in the HAproxy config instead
209
-
of IP addresses? *false**
214
+
of IP addresses? **`false`**
210
215
211
216
## Discovery
212
217
213
218
Sidecar supports both Docker-based discovery and a discovery mechanism where
214
-
you publish services into a JSON file locally, called "static". These can then be advertised as running services just like they would be from a Docker host. These are configured with the `SIDECAR_DISCOVERY` environment variable. Using both would
215
-
look like:
219
+
you publish services into a JSON file locally, called "static". These can then
220
+
be advertised as running services just like they would be from a Docker host.
221
+
These are configured with the `SIDECAR_DISCOVERY` environment variable. Using
222
+
both would look like:
216
223
217
224
```bash
218
225
export SIDECAR_DISCOVERY=static,docker
@@ -227,7 +234,7 @@ Sidecar currently accepts a single option for Docker-based discovery, the URL
227
234
to use to connect to Docker. Ideally this will be the same machine that Sidecar
228
235
runs on because it makes assumptions about addresses. By default it will use
229
236
the standard Docker Unix domain socket. You can change this with the
230
-
`DOCKER_URL` env var. This needs to be a url that works with teh Docker client.
237
+
`DOCKER_URL` env var. This needs to be a url that works with the Docker client.
231
238
232
239
Note that Sidecar only supports a *single* URL, unlike the Docker CLI tool.
0 commit comments