Merge pull request #3783 from whit537/doc-tweaks

Fix some small doc errors
This commit is contained in:
James Phillips 2018-01-04 13:54:08 -08:00 committed by GitHub
commit 968627cad5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 12 additions and 12 deletions

View File

@ -46,7 +46,7 @@ exit
``` ```
> NOTE: This demo will query the HashiCorp Checkpoint service to determine > NOTE: This demo will query the HashiCorp Checkpoint service to determine
> the the latest Consul release version and install that version by default, > the latest Consul release version and install that version by default,
> but if you need a different Consul version, set the `CONSUL_DEMO_VERSION` > but if you need a different Consul version, set the `CONSUL_DEMO_VERSION`
> environment variable before `vagrant up` like this: > environment variable before `vagrant up` like this:
> `CONSUL_DEMO_VERSION=0.6.4 vagrant up` > `CONSUL_DEMO_VERSION=0.6.4 vagrant up`

View File

@ -13,7 +13,7 @@ Consul is only a single command-line application: `consul`. This application
then takes a subcommand such as "agent" or "members". The complete list of then takes a subcommand such as "agent" or "members". The complete list of
subcommands is in the navigation to the left. subcommands is in the navigation to the left.
The `Consul` CLI is a well-behaved command line application. In erroneous The `consul` CLI is a well-behaved command line application. In erroneous
cases, a non-zero exit status will be returned. It also responds to `-h` and `--help` cases, a non-zero exit status will be returned. It also responds to `-h` and `--help`
as you'd most likely expect. And some commands that expect input accept as you'd most likely expect. And some commands that expect input accept
"-" as a parameter to tell Consul to read the input from stdin. "-" as a parameter to tell Consul to read the input from stdin.

View File

@ -61,7 +61,7 @@ Entropy is the tendency of systems to become increasingly disordered. Consul's
anti-entropy mechanisms are designed to counter this tendency, to keep the anti-entropy mechanisms are designed to counter this tendency, to keep the
state of the cluster ordered even through failures of its components. state of the cluster ordered even through failures of its components.
Consul has a clear separation between the global service catalog and the agent Consul has a clear separation between the global service catalog and the agent's
local state as discussed above. The anti-entropy mechanism reconciles these two local state as discussed above. The anti-entropy mechanism reconciles these two
views of the world: anti-entropy is a synchronization of the local agent state and views of the world: anti-entropy is a synchronization of the local agent state and
the catalog. For example, when a user registers a new service or check with the the catalog. For example, when a user registers a new service or check with the
@ -80,7 +80,7 @@ any services or checks exist in the catalog that the agent is not aware of, they
will be automatically removed to make the catalog reflect the proper set of will be automatically removed to make the catalog reflect the proper set of
services and health information for that agent. Consul treats the state of the services and health information for that agent. Consul treats the state of the
agent as authoritative; if there are any differences between the agent agent as authoritative; if there are any differences between the agent
and catalog view, the agent local view will always be used. and catalog view, the agent-local view will always be used.
### Periodic Synchronization ### Periodic Synchronization

View File

@ -107,7 +107,7 @@ The server nodes also operate as part of a WAN gossip pool. This pool is differe
as it is optimized for the higher latency of the internet and is expected to contain only as it is optimized for the higher latency of the internet and is expected to contain only
other Consul server nodes. The purpose of this pool is to allow datacenters to discover each other Consul server nodes. The purpose of this pool is to allow datacenters to discover each
other in a low-touch manner. Bringing a new datacenter online is as easy as joining the existing other in a low-touch manner. Bringing a new datacenter online is as easy as joining the existing
WAN gossip. Because the servers are all operating in this pool, it also enables cross-datacenter WAN gossip pool. Because the servers are all operating in this pool, it also enables cross-datacenter
requests. When a server receives a request for a different datacenter, it forwards it to a random requests. When a server receives a request for a different datacenter, it forwards it to a random
server in the correct datacenter. That server may then forward to the local leader. server in the correct datacenter. That server may then forward to the local leader.

View File

@ -86,7 +86,7 @@ result in the same state as a replay of old logs. This allows Raft to capture th
state at a point in time and then remove all the logs that were used to reach that state at a point in time and then remove all the logs that were used to reach that
state. This is performed automatically without user intervention and prevents unbounded state. This is performed automatically without user intervention and prevents unbounded
disk usage while also minimizing time spent replaying logs. One of the advantages of disk usage while also minimizing time spent replaying logs. One of the advantages of
using BoltDB is that it allows Consul to continue accepting new transactions even while using MemDB is that it allows Consul to continue accepting new transactions even while
old state is being snapshotted, preventing any availability issues. old state is being snapshotted, preventing any availability issues.
Consensus is fault-tolerant up to the point where quorum is available. Consensus is fault-tolerant up to the point where quorum is available.
@ -165,7 +165,7 @@ The three read modes are:
introduces an additional round-trip to all server nodes. The trade-off is introduces an additional round-trip to all server nodes. The trade-off is
always consistent reads but increased latency due to the extra round trip. always consistent reads but increased latency due to the extra round trip.
* `stale` - This mode allows any server to service the read regardless of if * `stale` - This mode allows any server to service the read regardless of whether
it is the leader. This means reads can be arbitrarily stale but are generally it is the leader. This means reads can be arbitrarily stale but are generally
within 50 milliseconds of the leader. The trade-off is very fast and scalable within 50 milliseconds of the leader. The trade-off is very fast and scalable
reads but with stale values. This mode allows reads without a leader meaning reads but with stale values. This mode allows reads without a leader meaning

View File

@ -120,10 +120,10 @@ lets the current lock holder update the key contents without having to give
up the lock and reacquire it. up the lock and reacquire it.
Once held, the lock can be released using a corresponding `release` operation, Once held, the lock can be released using a corresponding `release` operation,
providing the same session. Again, this acts like a Check-And-Set operations providing the same session. Again, this acts like a Check-And-Set operation
since the request will fail if given an invalid session. A critical note is since the request will fail if given an invalid session. A critical note is
that the lock can be released without being the creator of the session. that the lock can be released without being the creator of the session.
This is by design as it allows operators to intervene and force terminate This is by design as it allows operators to intervene and force-terminate
a session if necessary. As mentioned above, a session invalidation will also a session if necessary. As mentioned above, a session invalidation will also
cause all held locks to be released or deleted. When a lock is released, the `LockIndex` cause all held locks to be released or deleted. When a lock is released, the `LockIndex`
does not change; however, the `Session` is cleared and the `ModifyIndex` increments. does not change; however, the `Session` is cleared and the `ModifyIndex` increments.

View File

@ -18,7 +18,7 @@ state. These solutions may work in the short term, but they are rarely fault
tolerant or scalable. Besides these limitations, they require time and resources tolerant or scalable. Besides these limitations, they require time and resources
to build and maintain. to build and maintain.
Consul provides the core set of features needed by a SOA out of the box. By Consul provides the core set of features needed by an SOA out of the box. By
using Consul, organizations can leverage open source work to reduce the time using Consul, organizations can leverage open source work to reduce the time
and effort spent re-inventing the wheel and can focus instead on their business and effort spent re-inventing the wheel and can focus instead on their business
applications. applications.

View File

@ -39,5 +39,5 @@ runs an independent cluster of servers. Requests are forwarded to remote
datacenters if necessary; requests for services within a datacenter datacenters if necessary; requests for services within a datacenter
never go over the WAN, and connectivity issues between datacenters do not never go over the WAN, and connectivity issues between datacenters do not
affect availability within a datacenter. Additionally, the unavailability affect availability within a datacenter. Additionally, the unavailability
of one datacenter does not affect the service discovery of services of one datacenter does not affect the discovery of services
in any other datacenter. in any other datacenter.