From 1eaa9c989981927d3756fbdadcca90d79f833fed Mon Sep 17 00:00:00 2001 From: Yicheng Qin Date: Wed, 16 Apr 2014 23:15:26 -0700 Subject: [PATCH] docs: record module deprecation --- Documentation/api.md | 9 +++++++-- Documentation/modules.md | 3 +++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/Documentation/api.md b/Documentation/api.md index 95a8e2c6b..4bb8fff46 100644 --- a/Documentation/api.md +++ b/Documentation/api.md @@ -843,12 +843,14 @@ The client is told the write was successful and the keyspace is updated. Meanwhile F2 has partitioned from the network and will have an out-of-date version of the keyspace until the partition resolves. Since F2 missed the most recent write, a client reading from F2 will have an out-of-date version of the keyspace. -## Lock Module +## Lock Module (*Deprecated*) The lock module is used to serialize access to resources used by clients. Multiple clients can attempt to acquire a lock but only one can have it at a time. Once the lock is released, the next client waiting for the lock will receive it. +**Warning:** This module is deprecated at v0.4, and will be back later. See [Modules][modules] for more details. + ### Acquiring a Lock @@ -990,10 +992,13 @@ If you specify a field other than `index` or `value` then you'll receive the fol ``` -## Leader Module +## Leader Module (*Deprecated*) The leader module wraps the lock module to provide a simple interface for electing a single leader in a cluster. +**Warning:** This module is deprecated at v0.4, and will be back later. See [Modules][modules] for more details. +[modules]: https://github.com/coreos/etcd/blob/master/Documentation/modules.md + ### Setting the Leader diff --git a/Documentation/modules.md b/Documentation/modules.md index 9507c3235..eb1e34ba4 100644 --- a/Documentation/modules.md +++ b/Documentation/modules.md @@ -3,6 +3,9 @@ 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. +**Warning**: Modules is deprecated from v0.4, and is expected to be added back in the near future. +For now, we have to focus on raft algorithm and etcd core to make sure that it works correctly and fast. And etcd's API changes from time to time, which is painful to maintain these modules. Moreover, the implementation of lock module has some flaws, which may mislead users. But we also notice that these modules are popular and useful, and plan to add them back with full functionality as soon as possible. + ### Dashboard An HTML dashboard can be found at `http://127.0.0.1:4001/mod/dashboard/`.