status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-11 14:24:39 +00:00
Code Issues Projects Releases Wiki Activity

Minor Session / Lock Related Documentation Fixes (#5037)

Browse Source 
* website: specify value of acquire/release params for kv

* website: clarify leader election usage in TTL docs

* website: document minimal value of lockdelay

I believe it uses the default when parsing 0 as it
views that as an empty parameter in this case.
This commit is contained in:
Jack Pearkes 2019-04-03 08:54:21 -07:00 committed by GitHub
parent 2d870b9297
commit e7c295e552
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -182,8 +182,8 @@ The table below shows this endpoint's support for
index is non-zero, the key is only set if the index matches the `ModifyIndex` index is non-zero, the key is only set if the index matches the `ModifyIndex`
of that key. of that key.
- `acquire` `(string: "")` - Specifies to use a lock acquisition operation. This - `acquire` `(string: "")` - Supply a session ID to use in a lock acquisition operation.
is useful as it allows leader election to be built on top of Consul. If the This is useful as it allows leader election to be built on top of Consul. If the
lock is not held and the session is valid, this increments the `LockIndex` and lock is not held and the session is valid, this increments the `LockIndex` and
sets the `Session` value of the key in addition to updating the key contents. sets the `Session` value of the key in addition to updating the key contents.
A key does not need to exist to be acquired. If the lock is already held by A key does not need to exist to be acquired. If the lock is already held by
@ -196,7 +196,7 @@ The table below shows this endpoint's support for
For an example of how to use the lock feature, see the [Leader Election Guide] For an example of how to use the lock feature, see the [Leader Election Guide]
(/docs/guides/leader-election.html). (/docs/guides/leader-election.html).
- `release` `(string: "")` - Specifies to use a lock release operation. This is - `release` `(string: "")` - Supply a session ID to use in a 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`
of the key. The key must be held by this session to be unlocked. of the key. The key must be held by this session to be unlocked.

8
website/source/api/session.html.md
View File

@ -35,7 +35,8 @@ The table below shows this endpoint's support for
the datacenter of the agent being queried. This is specified as part of the the datacenter of the agent being queried. This is specified as part of the
URL as a query parameter. Using this across datacenters is not recommended. URL as a query parameter. Using this across datacenters is not recommended.
- `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay. - `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay. This
must be greater than `0`.
- `Node` `(string: "<agent>")` - Specifies the name of the node. This must refer - `Node` `(string: "<agent>")` - Specifies the name of the node. This must refer
to a node that is already registered. to a node that is already registered.
@ -55,8 +56,9 @@ The table below shows this endpoint's support for
- `TTL` `(string: "")` - Specifies the number of seconds (between 10s and - `TTL` `(string: "")` - Specifies the number of seconds (between 10s and
86400s). If provided, the session is invalidated if it is not renewed before 86400s). If provided, the session is invalidated if it is not renewed before
the TTL expires. The lowest practical TTL should be used to keep the number of the TTL expires. The lowest practical TTL should be used to keep the number of
managed sessions low. When locks are forcibly expired, such as during a leader managed sessions low. When locks are forcibly expired, such as when following
election, sessions may not be reaped for up to double this TTL, so long TTL the [leader election pattern](/docs/guides/leader-election.html) in an application,
sessions may not be reaped for up to double this TTL, so long TTL
values (> 1 hour) should be avoided. values (> 1 hour) should be avoided.
### Sample Payload ### Sample Payload