Skip to content

Commit 4d4d221

Browse files
committed
CloudMap: update documentation
An example on how to look for tags instead of attributes is provided. Signed-off-by: Elis Lulja <[email protected]>
1 parent 1558090 commit 4d4d221

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/usage.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ For more information about AWS credentials, you may take a look at aws' [documen
8383

8484
CN-WAN Reader can connect to your *etcd* nodes and watch the values that have been registered there, i.e. with `cnwan-reader watch etcd [FLAGS]` .
8585

86-
In order to work, you will need to provide the addresses of you etcd nodes with the `--endpoints` flag, optional `username` and `password` and a `prefix` in case your service registry on etcd contains one.
86+
In order to work, you will need to provide the addresses of your etcd nodes with the `--endpoints` flag, optional `username` and `password` and a `prefix` in case your service registry on etcd contains one.
8787
There is no need to insert all the nodes of your etcd cluster in `--endpoints` but just make sure you enter a few. As per `username` and `password` you can leave them empty if you don't need them to connect to etcd. Finally, `prefix` defaults to `/` in case you don't enter another value.
8888

8989
As a final note, make sure your etcd user has a role that enables it to at least *read* values in the provided prefix.
@@ -202,6 +202,12 @@ or just:
202202
cnwan-reader --conf /path/to/configuration/file.yaml
203203
```
204204

205+
#### Using tags
206+
207+
The default behavior of the CN-WAN Reader is to parse *attributes* on service instances. This behavior can be changed with `--with-tags`, which will tell the CN-WAN Reader to look for [tags](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) on services instead of attributes on instances.
208+
209+
This won't change how data is sent to the adaptor but only how it is searched and parsed on Cloud Map: if you store your metadata as attributes you may continue to use the *cloudmap* command as always; but if you register relevant metadata as *tags* -- i.e. if you register services with the CN-WAN Operator, then we recommend you to use `--with-tags`.
210+
205211
### With etcd
206212

207213
In the following example, the CN-WAN Reader watches changes in etcd with the following requirements:

0 commit comments

Comments
 (0)