Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1907 from robszumski/dash-note

Browse Source 
docs: make clear that dashboard is a module
This commit is contained in:
Xiang Li 2014-12-10 16:50:55 -08:00
commit a729c829a5
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/modules.md
View File

@ -3,7 +3,7 @@
etcd has a number of modules that are built on top of the core etcd API. etcd has a number of modules that are built on top of the core etcd API.
These modules provide things like dashboards, locks and leader election (removed). These modules provide things like dashboards, locks and leader election (removed).
**Warning**: Modules are deprecated from v0.4 until we have a solid base we can apply them back onto. **Warning**: Modules and dashboard are deprecated from v0.4 until we have a solid base we can apply them back onto.
For now, we are choosing to focus on raft algorithm and core etcd to make sure that it works correctly and fast. For now, we are choosing to focus on raft algorithm and core etcd to make sure that it works correctly and fast.
And it is time consuming to maintain these modules in this period, given that etcd's API changes from time to time. And it is time consuming to maintain these modules in this period, given that etcd's API changes from time to time.
Moreover, the lock module has some unfixed bugs, which may mislead users. Moreover, the lock module has some unfixed bugs, which may mislead users.
@ -11,6 +11,8 @@ But we also notice that these modules are popular and useful, and plan to add th
### Dashboard ### Dashboard
**Other Dashboards**: There are other dashboards available on [Github](https://github.com/henszey/etcd-browser) that can be run [in a container](https://registry.hub.docker.com/u/tomaskral/etcd-browser/).
An HTML dashboard can be found at `http://127.0.0.1:4001/mod/dashboard/`. An HTML dashboard can be found at `http://127.0.0.1:4001/mod/dashboard/`.
This dashboard is compiled into the etcd binary and uses the same API as regular etcd clients. This dashboard is compiled into the etcd binary and uses the same API as regular etcd clients.