Commit graph

637 commits

Author SHA1 Message Date
James Phillips 275c84a0cc Renames "debug" endpoint and structures to "explain". 2016-03-07 10:45:39 -08:00
James Phillips 8493640b09 Adds a prepared query debug endpoint. 2016-03-07 10:45:39 -08:00
James Phillips e6232a21e4 Adds basic docs for prepared query templates. 2016-03-07 10:45:39 -08:00
James Phillips 5dd137056c Fixes name of new query ACL. 2016-03-04 16:32:53 -08:00
James Phillips bd4f2ee6b7 Adds a new PUT-based TTL check update endpoint. 2016-03-02 17:54:01 -08:00
James Phillips ecc617008a Merge pull request #1777 from hashicorp/b-port-docfix
TLS example and correcting error
2016-03-01 13:02:30 -08:00
James Phillips 807769e6bd Tweaks the address and advertise docs. 2016-03-01 13:01:13 -08:00
James Phillips 72f7c08a0a Cleans up the documents. 2016-02-24 18:05:58 -08:00
James Phillips c75256ac8b Adds a check for users re-submitting the redacted token. 2016-02-24 17:35:26 -08:00
James Phillips 2f7eac8b86 Renames "prepared_query" ACL policy to "query". 2016-02-24 17:02:06 -08:00
James Phillips 0ea990f3d2 Adds an upgrade note about the new ACL behavior. 2016-02-24 01:33:10 -08:00
James Phillips a8ac27fa49 Refactors docs into a more complete state for prepared query ACLs. 2016-02-23 22:27:44 -08:00
James Phillips 633c231d67 Creates new "prepared-query" ACL type and new token capture behavior.
Prior to this change, prepared queries had the following behavior for
ACLs, which will need to change to support templates:

1. A management token, or a token with read access to the service being
   queried needed to be provided in order to create a prepared query.

2. The token used to create the prepared query was stored with the query
   in the state store and used to execute the query.

3. A management token, or the token used to create the query needed to be
   supplied to perform and CRUD operations on an existing prepared query.

This was pretty subtle and complicated behavior, and won't work for
templates since the service name is computed at execution time. To solve
this, we introduce a new "prepared-query" ACL type, where the prefix
applies to the query name for static prepared query types and to the
prefix for template prepared query types.

With this change, the new behavior is:

1. A management token, or a token with "prepared-query" write access to
   the query name or (soon) the given template prefix is required to do
   any CRUD operations on a prepared query, or to list prepared queries
   (the list is filtered by this ACL).

2. You will no longer need a management token to list prepared queries,
   but you will only be able to see prepared queries that you have access
   to (you get an empty list instead of permission denied).

3. When listing or getting a query, because it was easy to capture
   management tokens given the past behavior, this will always blank out
   the "Token" field (replacing the contents as <hidden>) for all tokens
   unless a management token is supplied. Going forward, we should
   discourage people from binding tokens for execution unless strictly
   necessary.

4. No token will be captured by default when a prepared query is created.
   If the user wishes to supply an execution token then can pass it in via
   the "Token" field in the prepared query definition. Otherwise, this
   field will default to empty.

5. At execution time, we will use the captured token if it exists with the
   prepared query definition, otherwise we will use the token that's passed
   in with the request, just like we do for other RPCs (or you can use the
   agent's configured token for DNS).

6. Prepared queries with no name (accessible only by ID) will not require
   ACLs to create or modify (execution time will depend on the service ACL
   configuration). Our argument here is that these are designed to be
   ephemeral and the IDs are as good as an ACL. Management tokens will be
   able to list all of these.

These changes enable templates, but also enable delegation of authority to
manage the prepared query namespace.
2016-02-23 17:12:43 -08:00
csawyerYumaed 793195b7d8 Update documentation - add Network Ports.
Update security.html.markdown add section on Network Port usage.
TODO: add Atlas port usage.
2016-02-23 11:27:15 -08:00
Michael Crilly b90e77421a TLS example and correcting error
The example configuration file omits TLS support in the HTTP API. This is fine, but a second example demonstrating how to enable TLS over the HTTP API is harmless and, in fact, should be default practice.

Using the format `ip:port` in the "addresses" block will cause Consul to crash on reload/start. See issue (#1727)[https://github.com/hashicorp/consul/issues/1727#issuecomment-184980751]
2016-02-17 15:24:37 +10:00
Kim Toms a3f49a1f21 Update leader-election.html.markdown
Remove duplicate 'leader'
2016-02-14 09:32:23 -05:00
Sean Chittenden 66feca5b5f Allow adjusting the number of DNS records in a response...
Based on work done by @fusiondog in #1583, extend the concept to use an integer instead of a boolean.

Fixes: #1583 && #1481
2016-02-12 12:18:25 -08:00
James Phillips 48a29b5a31 Fixes a typo. 2016-02-09 16:37:06 -08:00
James Phillips 9fabd05157 Merge pull request #1698 from hashicorp/pr-1547-slackpad
Implements WAN address translation.
2016-02-07 14:26:04 -08:00
James Phillips 800910137d Adds documentation for WAN address translation. 2016-02-07 11:12:19 -08:00
James Phillips 498c8e1d9c Merge pull request #1609 from kevinsimper/patch-1
Updating dns forwarding
2016-02-06 22:21:00 -08:00
James Phillips 4b3dede0fb Tweaks the telemetry docs. 2016-02-06 22:07:11 -08:00
James Phillips a599e88507 Merge pull request #1284 from nbrownus/telemetry
Option to disable hostnames from telemetry
2016-02-06 22:00:14 -08:00
James Phillips 43a8eb8189 Adds a warning about DoS-ing the cluster with consul exec. 2016-02-05 17:36:19 -08:00
Sean Chittenden c1c3daed9a Iterate on the DNS forwarding docs
Specifically:

* add Dnsmasq examples for reverse DNS for most of the RFC1918, 5735, and 6598 netblocks.
* Highlight some example options for dnsmasq that are probably of interest.
* Add a small section on reverse DNS testing
* Break out BINDs troubleshooting with Dnsmasq's troubleshooting

Not an exhaustive sweep, but should be helpful when introducing consul to new environments.
2016-02-02 15:06:25 -08:00
Nate Brown 541a98c9c7 Option to disable hostnames from telemetry 2016-01-29 13:44:48 -08:00
Raja Nadar aa45c07f28 fixing small typo in json 2016-01-29 01:25:23 -08:00
Daryl c4860cad7d Correcting count of checks
I saw there were 5 checks listed - script, tcp, http, ttl, docker.
2016-01-19 22:50:27 -05:00
Kevin Simper 759e535f54 Updating dns forwarding
It is not really clear that you only have to do one of the following and not all three.
2016-01-14 22:53:14 +01:00
Jon Benson d79139760a Fix semaphore typo 2016-01-13 16:56:40 -08:00
Seth Vargo e110abee9b Fix broken link 2016-01-13 19:32:30 -05:00
Seth Vargo dc9131a732 Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
James Phillips 6d35366228 Adds a note about 2X memory provisioning. 2016-01-08 19:15:42 -08:00
James Phillips 6bfc266657 Adds a cautionary note about data fitting into RAM. 2016-01-08 18:49:31 -08:00
James Phillips 55970248bc Tweaks wording of reap config option section. 2016-01-06 22:29:03 -08:00
James Phillips 6dd0835319 Makes the timeout behavior more intuitive.
Previously, it would try once "up to" the timeout, but in practice it would
just fall through. This modifies the behavior to block until the timeout has
been reached.
2016-01-06 09:40:20 -08:00
James Phillips 87dd758199 Defaults monitor retries to 3 retries @ 1s for the consul lock command. 2016-01-05 18:34:22 -08:00
James Phillips 9323276b58 Adds monitor retries to the consul lock command. 2016-01-05 18:22:36 -08:00
James Phillips 3348cf4c0b Adds "try" support to locks and semaphores. 2016-01-05 18:22:36 -08:00
James Phillips df361afed5 Merge pull request #1550 from hashicorp/f-devmode
Add a `-dev` mode for easy prototyping
2016-01-05 10:01:41 -08:00
James Phillips f861f35da7 Merge pull request #1549 from kikitux/patch-1
[doc] fix identation on statsd_addr
2016-01-02 06:50:56 -08:00
Peter Schaadt 5a72fe2803 Fixing typos in Coordinate documentation. 2015-12-28 16:34:09 -08:00
Ryan Uber 579a08ec20 website: add docs for dev mode 2015-12-27 09:45:59 -06:00
Alvaro Miranda 92f0164f97 fix identation on statsd_addr
ditto
2015-12-27 18:19:31 +13:00
Ryan Uber 0fabf273e6 website: document the static ui flag 2015-12-24 22:21:34 -05:00
James Phillips e1d456a079 Changes sense of option to "reap" and uses nil for "not set". 2015-12-22 10:28:10 -08:00
James Phillips 1e4aa28c9d Adds child process reaping when Consul is running as PID 1. 2015-12-21 21:47:35 -08:00
James Phillips 09b1924cce Tweaks RTT command docs. 2015-12-21 15:16:48 -08:00
James Phillips 9e3c171648 Merge pull request #1522 from sboily/patch-1
Update documentation to use consul rtt command with https
2015-12-21 15:14:57 -08:00
James Phillips 43808ca120 Clarifies format of stats aggregator configurations as host:port. 2015-12-18 22:53:55 -08:00
Sylvain Boily 726fde8e02 Update documentation to use rtt with https 2015-12-17 13:24:42 -05:00
James Phillips 6b82b69da9 Adds a note about the new web UI layout. 2015-12-15 15:17:11 -08:00
Sep Nasiri d644ede899 Change example filename to use .json instead of .js
Since only .json files are loaded using .js as an example here is confusing.
2015-12-08 18:42:32 -08:00
James Phillips 232fc7d5fd Adds blank line to fix Docker check formatting. 2015-12-08 00:04:55 -08:00
James Phillips 0fb6e9b7f6 Adds some more upgrade notes for Consul 0.6. 2015-12-07 17:58:43 -08:00
nftw 07e367972c Update atlas.html.markdown
Fixed minor typo
2015-12-07 17:06:11 +00:00
James Phillips 1ff4357cc5 Updates the version specific instructions for 0.6.0. 2015-12-02 10:32:00 -08:00
Ryan Breen 3c9e983800 Update health.html.markdown
Correct json syntax in example.
2015-11-23 09:39:05 -05:00
Arnout Engelen ab22325b87 Include 'Service'/'Address' field in example
Add the `Service`/`Address` field to the example output for the `/v1/health/service/\<service\>` endpoint.

Even though it's an optional value, this is probably the one consumers are looking for (rather than the `Node` address)
2015-11-23 15:01:24 +01:00
James Phillips 1144846ed0 Fixes a typo in the prepared queries doc. 2015-11-20 21:44:24 -08:00
James Phillips bcbf6d268e Removes old logging doc which was empty. 2015-11-18 14:41:50 -08:00
James Phillips 23536f2b97 Adds Docker checks support to client API.
Also changed `DockerContainerId` to `DockerContainerID`, and updated the agent
API docs to reflect their support for Docker checks.
2015-11-18 07:40:02 -08:00
Sean Chittenden dde0d26e18 Fix markdown's markup: 2^(64-1) != 2^(64)-1 2015-11-17 15:21:47 -08:00
James Phillips 9e29bb4238 Adds and updates docs for prepared queries. 2015-11-15 17:06:00 -08:00
James Phillips 26cf0a2974 Extends the session TTL max to 24 hours, and adds a warning to the docs. 2015-11-15 16:51:00 -08:00
James Phillips 1a3c523816 Adds a note about the new acquire behavior into the sessions internals guide. 2015-11-14 10:28:14 -08:00
talwai 3d64189bfa Add DogStatsD configuration options to documentation source 2015-11-11 14:30:37 -05:00
James Phillips c2fab40aee Fixes a typo. 2015-10-30 23:50:11 -07:00
Diptanu Choudhury 1e379f45f0 Some more grammer corrections and formatting to docker check docs 2015-10-28 14:56:55 -07:00
Diptanu Choudhury b29a785614 Some changes to the docker check docs 2015-10-28 14:24:03 -07:00
Diptanu Choudhury c3cf24d022 Added some docs for the docker check 2015-10-28 14:19:57 -07:00
Cameron Stokes 46021ab4b4 Clarify format of the -atlas agent option. 2015-10-27 14:21:05 -07:00
Victor Trac adf4189707 Mote -> Note typo 2015-10-26 15:10:20 -05:00
James Phillips b3b1c6940b Updates docs for network coordinates. 2015-10-23 15:23:01 -07:00
James Phillips c48e3e1179 Defaults second node to agent if not given. Removes -short option and tweaks output formatting. 2015-10-23 15:23:01 -07:00
James Phillips a51e170eef Cleans up after code review, adds a -short option to "consul rtt" command. 2015-10-23 15:23:01 -07:00
James Phillips 43df5c6784 Adds a "consul rtt" command. 2015-10-23 15:23:01 -07:00
James Phillips 3f11bfaea4 Adds coordinate of agent to self endpoint. 2015-10-23 15:23:01 -07:00
James Phillips a2bcef00a0 Adds endpoints for raw network coordinates. 2015-10-23 15:23:01 -07:00
James Phillips fecd639b02 Changes ?near=self to a safer ?near=_agent, which is also clearer about what it does. 2015-10-23 15:23:01 -07:00
James Phillips ee1cf1e13b Adds distance sorting to health endpoint. Cleans up unit tests. 2015-10-23 15:23:01 -07:00
James Phillips 1724b9a6be Adds a magic "self" node name to distance queries. 2015-10-23 15:23:01 -07:00
James Phillips 033e8e6625 Adds sort of DCs in catalog queries based on RTT. Cleans up.
* Makes the catalog endpoint respect disabling coordinates for all
  RTT-sorting query types.
2015-10-23 15:23:01 -07:00
James Phillips b63909cf67 Adds coordinate sorting support to catalog queries for nodes and service nodes. 2015-10-23 15:23:01 -07:00
Armon Dadgar d035dbd43b Merge pull request #1318 from daveadams/f-http-header-token
Allow specifying Consul token in an HTTP request header
2015-10-22 13:33:47 -07:00
James Phillips 3500c4781a Gets rid of LMDB reference in the FAQ. 2015-10-20 13:39:11 -07:00
David Adams 5f175add40 Add HTTP request header X-Consul-Token
Add support for an X-Consul-Token HTTP request header to specify the
token with which this request should be fulfilled. The header would have
precedence over the responding Agent's default token, but would have
lower precedence than a token specified in the query string.
2015-10-19 11:26:01 -05:00
James Phillips 4ec5013811 Updates docs about new "acquire when you already have it" behavior. 2015-10-15 14:59:09 -07:00
Ryan Uber b46f878747 Merge pull request #1309 from hashicorp/f-remove-migrate
Removes consul-migrate for 0.6
2015-10-15 14:50:19 -07:00
Ryan Uber c31ac806f8 website: add note for consul migrate utility. 2015-10-15 14:42:46 -07:00
Ryan Breen 9d489331e3 Update datacenters.html.markdown
Fix GH-1305.
2015-10-15 14:36:54 -04:00
Jeff Wang 75c21693a8 Make service lookup DNS documentation consistent 2015-09-23 23:16:34 -07:00
Jeff Wang ac5af9bcbc Make node lookup DNS documentation consistent 2015-09-23 23:09:52 -07:00
James Phillips b25797a808 Merge pull request #1187 from sfncook/enable_tag_drift_03
Enable tag drift 03
2015-09-11 15:35:32 -07:00
Shawn Cook 451abfa206 Doc changes in response to review. 2015-09-11 15:26:30 -07:00
Shawn Cook 7d6f30da1c Docs - add verbage to anti-entropy page. 2015-09-11 14:27:54 -07:00
Anthony Scalisi 8d733b7fca remove various typos 2015-09-11 12:29:54 -07:00
Shawn Cook 7c85d588d5 Update documentation for service definition 2015-09-11 09:32:54 -07:00
James Phillips c601f64c3f Fixes a typo in the telemetry docs. 2015-09-02 21:37:31 -07:00
Ryan Breen a013095f62 Merge pull request #1167 from railsguru/master
Add -http-port option to change the HTTP API port
2015-09-02 01:15:55 -04:00