status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add a link to the leader election guide in the lock API docs

This commit is contained in:
Kyle Havlovitz 2018-02-22 15:57:46 -08:00
parent 1e11082709
commit 5956e778db
No known key found for this signature in database
GPG Key ID: 8A5E6B173056AD6C
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/source/api/kv.html.md
View File

@ -190,6 +190,9 @@ The table below shows this endpoint's support for
that does not include the acquire parameter will proceed normally even if another that does not include the acquire parameter will proceed normally even if another
session has locked the key.** session has locked the key.**
For an example of how to use the lock feature, see the [Leader Election Guide]
(/docs/guides/leader-election.html).
- `release` `(string: "")` - Specifies to use a lock release operation. This is - `release` `(string: "")` - Specifies to use a lock release operation. This is
useful when paired with `?acquire=` as it allows clients to yield a lock. This useful when paired with `?acquire=` as it allows clients to yield a lock. This
will leave the `LockIndex` unmodified but will clear the associated `Session` will leave the `LockIndex` unmodified but will clear the associated `Session`