Update documentation and remove unesessary configuration #3591
Conversation
zipkin-server/README.md
Outdated
|
|
||
| ## Configuration | ||
| We support ENV variable configuration, such as `STORAGE_TYPE=cassandra3`, as they are familiar to | ||
| We support ENV variable configuration, such as `ZIPKIN_STORAGE=cassandra`, as they are familiar to |
There was a problem hiding this comment.
| We support ENV variable configuration, such as `ZIPKIN_STORAGE=cassandra`, as they are familiar to | |
| We support ENV variable configuration, such as `ZIPKIN_STORAGE=cassandra3`, as they are familiar to |
I think we consistent with previous. Could you rechecck?
There was a problem hiding this comment.
Update the names to cassandra3
zipkin-server/README.md
Outdated
| * `ZIPKIN_STORAGE_BANYANDB_HOST`: The host of BanyanDB. Defaults to `127.0.0.1`. | ||
| * `ZIPKIN_STORAGE_BANYANDB_PORT`: The port of BanyanDB. Defaults to `17912`. |
There was a problem hiding this comment.
These should be merged as targets. Could you recheck your dependency version of OAP and sync the doc?
There was a problem hiding this comment.
The configuration and documentation have been updated.
zipkin-server/README.md
Outdated
| ### Legacy (v1) storage components | ||
| The following components are no longer encouraged, but exist to help aid | ||
| transition to supported ones. These are indicated as "v1" as they use | ||
| data layouts based on Zipkin's V1 Thrift model, as opposed to the | ||
| simpler v2 data model currently used. |
There was a problem hiding this comment.
Do we need this statement? I think the new of v3 includes making MySQL and PG back to be available.
| @@ -92,14 +92,13 @@ accordingly. | |||
|
|
|||
| Ex. If your link name is "storage" for an Elasticsearch container: | |||
| ``` | |||
| ES_HOSTS=http://$STORAGE_PORT_9200_TCP_ADDR:9200 | |||
| ZIPKIN_STORAGE_ES_CLUSTER_NODES=$STORAGE_PORT_9200_TCP_ADDR:9200 | |||
There was a problem hiding this comment.
Can we maintain both variables and deprecate the former? As far as I understand we want to keep retrocompatibility for ease migration.
There was a problem hiding this comment.
We could keep some consistent with before. But things like storage selector, it is very skywalking style, can't be aligned with true/false style.
Features of Zipkin v3 have been almost developed, so this pull request is intended for updating the documentation and removing unnecessary configuration items.