365 Commits

Author SHA1 Message Date
James Phillips
d7288e3a5e Adds a prepared query debug endpoint. 2016-03-07 10:45:39 -08:00
James Phillips
fbd8e40cd5 Adds basic docs for prepared query templates. 2016-03-07 10:45:39 -08:00
James Phillips
7ebad899da Adds a new PUT-based TTL check update endpoint. 2016-03-02 17:54:01 -08:00
James Phillips
ef1a588b7a Merge pull request #1777 from hashicorp/b-port-docfix
TLS example and correcting error
2016-03-01 13:02:30 -08:00
James Phillips
b92243d8d0 Tweaks the address and advertise docs. 2016-03-01 13:01:13 -08:00
James Phillips
dca480e284 Cleans up the documents. 2016-02-24 18:05:58 -08:00
James Phillips
7d392118d2 Adds a check for users re-submitting the redacted token. 2016-02-24 17:35:26 -08:00
James Phillips
483898abe5 Renames "prepared_query" ACL policy to "query". 2016-02-24 17:02:06 -08:00
James Phillips
880cd21667 Refactors docs into a more complete state for prepared query ACLs. 2016-02-23 22:27:44 -08:00
James Phillips
67de77482e 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
Michael Crilly
4c8725ef63 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
James Phillips
590ab94d8d Adds documentation for WAN address translation. 2016-02-07 11:12:19 -08:00
James Phillips
d2d6b51fe4 Tweaks the telemetry docs. 2016-02-06 22:07:11 -08:00
Nate Brown
43a4f3fe02 Option to disable hostnames from telemetry 2016-01-29 13:44:48 -08:00
Raja Nadar
cd17cdc03d fixing small typo in json 2016-01-29 01:25:23 -08:00
Daryl
b2f8ef9f32 Correcting count of checks
I saw there were 5 checks listed - script, tcp, http, ttl, docker.
2016-01-19 22:50:27 -05:00
Seth Vargo
f5ffa8fb79 Fix broken link 2016-01-13 19:32:30 -05:00
Seth Vargo
cae0ff354a Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
James Phillips
203d8101eb Tweaks wording of reap config option section. 2016-01-06 22:29:03 -08:00
James Phillips
c1fe9092ed 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
ebad52ffc2 Merge pull request #1549 from kikitux/patch-1
[doc] fix identation on statsd_addr
2016-01-02 06:50:56 -08:00
Peter Schaadt
b15d02e431 Fixing typos in Coordinate documentation. 2015-12-28 16:34:09 -08:00
Ryan Uber
c4e73275b0 website: add docs for dev mode 2015-12-27 09:45:59 -06:00
Alvaro Miranda
bbf67d83fb fix identation on statsd_addr
ditto
2015-12-27 18:19:31 +13:00
Ryan Uber
e040616df1 website: document the static ui flag 2015-12-24 22:21:34 -05:00
James Phillips
0b1c346990 Changes sense of option to "reap" and uses nil for "not set". 2015-12-22 10:28:10 -08:00
James Phillips
2b257c922e Adds child process reaping when Consul is running as PID 1. 2015-12-21 21:47:35 -08:00
James Phillips
63b3e7f16a Clarifies format of stats aggregator configurations as host:port. 2015-12-18 22:53:55 -08:00
Sep Nasiri
48c2f68edc 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
4c47f2d57f Adds blank line to fix Docker check formatting. 2015-12-08 00:04:55 -08:00
Ryan Breen
4d42ff66e3 Update health.html.markdown
Correct json syntax in example.
2015-11-23 09:39:05 -05:00
Arnout Engelen
afc77a4634 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
d861f87851 Fixes a typo in the prepared queries doc. 2015-11-20 21:44:24 -08:00
James Phillips
ab63122a32 Removes old logging doc which was empty. 2015-11-18 14:41:50 -08:00
James Phillips
95c708f65e 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
e4d7bfee6a Fix markdown's markup: 2^(64-1) != 2^(64)-1 2015-11-17 15:21:47 -08:00
James Phillips
800e946bf1 Adds and updates docs for prepared queries. 2015-11-15 17:06:00 -08:00
James Phillips
f1f9d30ade Extends the session TTL max to 24 hours, and adds a warning to the docs. 2015-11-15 16:51:00 -08:00
talwai
0a5434f2a0 Add DogStatsD configuration options to documentation source 2015-11-11 14:30:37 -05:00
Diptanu Choudhury
c25d0f044f Some more grammer corrections and formatting to docker check docs 2015-10-28 14:56:55 -07:00
Diptanu Choudhury
1633cf9d1c Some changes to the docker check docs 2015-10-28 14:24:03 -07:00
Diptanu Choudhury
e4f2887ba3 Added some docs for the docker check 2015-10-28 14:19:57 -07:00
Cameron Stokes
442461b030 Clarify format of the -atlas agent option. 2015-10-27 14:21:05 -07:00
Victor Trac
2b00e1cd6a Mote -> Note typo 2015-10-26 15:10:20 -05:00
James Phillips
cef9402ab9 Updates docs for network coordinates. 2015-10-23 15:23:01 -07:00
James Phillips
f9da231a1c Adds coordinate of agent to self endpoint. 2015-10-23 15:23:01 -07:00
James Phillips
33e3505aea Adds endpoints for raw network coordinates. 2015-10-23 15:23:01 -07:00
James Phillips
9c9195746f 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
9caa5b3653 Adds distance sorting to health endpoint. Cleans up unit tests. 2015-10-23 15:23:01 -07:00
James Phillips
e47eea3f3a Adds a magic "self" node name to distance queries. 2015-10-23 15:23:01 -07:00