Skip to content

Commit 35f0997

Browse files
Updated readme with full usage (#20)
DOC: Fixed type in readme enable by using the output of haproxy-consul-connect --help
1 parent 344011f commit 35f0997

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,28 @@ To handle intentions, HAProxy Connect, sets up a SPOE filter on the application
2323
## How to use
2424

2525
```
26-
haproxy-connect \
27-
-sidecar-for <your-service-id> \
28-
\
29-
-enable-intentions # wether or not to enbale intentions \
30-
31-
-haproxy-cfg-base-path <path> # base path to store haproxy config in, \
32-
# will generate a unique directory per run under this, \
33-
# defaults to /tmp \
34-
35-
36-
-haproxy <haproxy binary path> # no required if in your path \
37-
-dataplane <dataplane-api binary path> # no required if in your path \
38-
```
26+
./haproxy-consul-connect --help
27+
Usage of ./haproxy-consul-connect:
28+
-dataplane string
29+
Dataplane binary path (default "dataplane-api")
30+
-enable-intentions
31+
Enable Connect intentions
32+
-haproxy string
33+
Haproxy binary path (default "haproxy")
34+
-haproxy-cfg-base-path string
35+
Haproxy binary path (default "/tmp")
36+
-http-addr string
37+
Consul agent address (default "127.0.0.1:8500")
38+
-log-level string
39+
Log level (default "INFO")
40+
-sidecar-for string
41+
The consul service id to proxy
42+
-sidecar-for-tag string
43+
The consul service id to proxy
44+
-stats-addr string
45+
Listen addr for stats server
46+
-stats-service-register
47+
Register a consul service for connect stats
48+
-token string
49+
Consul ACL token./haproxy-consul-connect --help
50+
```

0 commit comments

Comments
 (0)