| Verb | -Operation | -Key | -Value | -Flags | -Index | -Session | -
|---|---|---|---|---|---|---|
| set | -Sets the `Key` to the given `Value`. | -X | -X | -O | -- | - |
| cas | -Sets the `Key` to the given `Value` with check-and-set semantics. The `Key` will only be set if its current modify index matches the supplied `Index`. | -X | -X | -O | -X | -- |
| lock | -Locks the `Key` with the given `Session`. The `Key` will only obtain the lock if the `Session` is valid, and no other session has it locked. | -X | -X | -O | -- | X | -
| unlock | -Unlocks the `Key` with the given `Session`. The `Key` will only release the lock if the `Session` is valid and currently has it locked. | -X | -X | -O | -- | X | -
| get | -Gets the `Key` during the transaction. This fails the transaction if the `Key` doesn't exist. The key may not be present in the results if ACLs do not permit it to be read. | -X | -- | - | - | - |
| get-tree | -Gets all keys with a prefix of `Key` during the transaction. This does not fail the transaction if the `Key` doesn't exist. Not all keys may be present in the results if ACLs do not permit them to be read. | -X | -- | - | - | - |
| check-index | -Fails the transaction if `Key` does not have a modify index equal to `Index`. | -X | -- | - | X | -- |
| check-session | -Fails the transaction if `Key` is not currently locked by `Session`. | -X | -- | - | - | X | -
| delete | -Deletes the `Key`. | -X | -- | - | - | - |
| delete-tree | -Deletes all keys with a prefix of`Key`. | -X | -- | - | - | - |
| delete-cas | -Deletes the `Key` with check-and-set semantics. The `Key` will only be deleted if its current modify index matches the supplied `Index`. | -X | -- | - | X | -- |
- These Consul SDK are created and managed by the amazing members of the Consul community: -
-These Consul tools are created and managed by the amazing members of the Consul community: diff --git a/website/source/index.html.erb b/website/source/index.html.erb index 9424b531d2..01672f0a6f 100644 --- a/website/source/index.html.erb +++ b/website/source/index.html.erb @@ -1,6 +1,6 @@ --- description: |- - Consul is a highly available and distributed service discovery and key-value + Consul is a highly available and distributed service discovery and KV store designed with support for the modern data center to make distributed systems and configuration easy. --- @@ -70,7 +70,7 @@ description: |- <%= inline_svg "feature-config.svg", width: 85 %>
Flexible key/value store for dynamic configuration, feature flagging, coordination, leader election and more. Long poll for near-instant diff --git a/website/source/intro/getting-started/checks.html.markdown b/website/source/intro/getting-started/checks.html.markdown index 6b0a704743..d4e37c4b86 100644 --- a/website/source/intro/getting-started/checks.html.markdown +++ b/website/source/intro/getting-started/checks.html.markdown @@ -21,7 +21,7 @@ At this point, you should have a two-node cluster running. Similar to a service, a check can be registered either by providing a [check definition](/docs/agent/checks.html) or by making the -appropriate calls to the [HTTP API](/docs/agent/http/health.html). +appropriate calls to the [HTTP API](/api/health.html). We will use the check definition approach because, just like with services, definitions are the most common way to set up checks. diff --git a/website/source/intro/getting-started/kv.html.markdown b/website/source/intro/getting-started/kv.html.markdown index 0b9a30fc22..63cd751927 100644 --- a/website/source/intro/getting-started/kv.html.markdown +++ b/website/source/intro/getting-started/kv.html.markdown @@ -1,15 +1,15 @@ --- layout: "intro" -page_title: "Key/Value Data" +page_title: "KV Data" sidebar_current: "gettingstarted-kv" description: |- - In addition to providing service discovery and integrated health checking, Consul provides an easy to use Key/Value store. This can be used to hold dynamic configuration, assist in service coordination, build leader election, and enable anything else a developer can think to build. + In addition to providing service discovery and integrated health checking, Consul provides an easy to use KV store. This can be used to hold dynamic configuration, assist in service coordination, build leader election, and enable anything else a developer can think to build. --- -# Key/Value Data +# KV Data In addition to providing service discovery and integrated health checking, -Consul provides an easy to use Key/Value store. This can be used to hold +Consul provides an easy to use KV store. This can be used to hold dynamic configuration, assist in service coordination, build leader election, and enable anything else a developer can think to build. @@ -130,5 +130,5 @@ documentation, please see [Consul KV HTTP API][kv-api] or Next, we will look at the [web UI](ui.html) options supported by Consul. -[kv-api]: /docs/agent/http/kv.html +[kv-api]: /api/kv.html [kv-cli]: /docs/commands/kv.html diff --git a/website/source/intro/index.html.markdown b/website/source/intro/index.html.markdown index 40504803ba..0b1b6eb62c 100644 --- a/website/source/intro/index.html.markdown +++ b/website/source/intro/index.html.markdown @@ -31,7 +31,7 @@ key features: used by an operator to monitor cluster health, and it is used by the service discovery components to route traffic away from unhealthy hosts. -* **Key/Value Store**: Applications can make use of Consul's hierarchical key/value +* **KV Store**: Applications can make use of Consul's hierarchical key/value store for any number of purposes, including dynamic configuration, feature flagging, coordination, leader election, and more. The simple HTTP API makes it easy to use. diff --git a/website/source/layouts/_sidebar.erb b/website/source/layouts/_sidebar.erb index 8d949daf02..30b3bbd13c 100644 --- a/website/source/layouts/_sidebar.erb +++ b/website/source/layouts/_sidebar.erb @@ -8,6 +8,7 @@