Commit Graph

73 Commits

Author SHA1 Message Date
James Phillips 24c2bc44f1 Clarifies default behavior of blank service addresses. 2016-04-20 10:16:06 -07:00
James Phillips 0f23210628 Fixes JSON in wildcard query example. 2016-03-23 14:33:20 -07:00
James Phillips 4c3b2edfed Fixes a few bugs in the prepared query doc. 2016-03-17 23:42:27 -07:00
James Phillips e634e91ae6 Fixes broken example JSON. 2016-03-07 10:45:39 -08:00
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 bd4f2ee6b7 Adds a new PUT-based TTL check update endpoint. 2016-03-02 17:54:01 -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 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
James Phillips 800910137d Adds documentation for WAN address translation. 2016-02-07 11:12:19 -08:00
Raja Nadar aa45c07f28 fixing small typo in json 2016-01-29 01:25:23 -08:00
Seth Vargo e110abee9b Fix broken link 2016-01-13 19:32:30 -05:00
Peter Schaadt 5a72fe2803 Fixing typos in Coordinate documentation. 2015-12-28 16:34:09 -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 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 b3b1c6940b Updates docs for network coordinates. 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
James Phillips 4ec5013811 Updates docs about new "acquire when you already have it" behavior. 2015-10-15 14:59:09 -07:00
James Phillips 89d03026bc Clarifies services docs a bit. 2015-08-25 16:12:19 -07:00
Peter Fern 403b42af99 Document `TCP` check type 2015-07-27 10:53:52 +10:00
Ryan Uber faab022f89 website: document passing ACL tokens in catalog register/deregister 2015-06-15 11:45:30 -07:00
Ryan Uber b6e31a2e6f website: add status field for check registration in http docs 2015-05-28 13:09:33 -07:00
Ryan Uber 5d94a6bb7d website: Document peers api consistency. Fixes #880 2015-05-06 12:13:28 -07:00
Armon Dadgar e474e34528 Merge pull request #909 from hashicorp/f-create
Support ACL upsert behavior
2015-05-06 11:22:11 -07:00
Armon Dadgar 0473b40df2 website: Document new ACL upsert behavior 2015-05-05 19:25:27 -07:00
Ryan Uber af74095584 website: document service and check acl options 2015-04-28 14:28:06 -07:00
Vasily Vasilkov a7efaf061c Fix invalid link to sessions page 2015-04-22 12:40:27 +03:00
Cameron Ruatta b637683ffa Caps not necessary here 2015-04-20 20:59:45 -07:00
Cameron Ruatta a9761dca33 Updating the docs to include information about registering a check with
a serviceid.
2015-04-20 20:56:26 -07:00
Ryan Breen 1ac70f6179 Website: minor fix for docs/agent/http/agent.html. 2015-04-17 11:43:02 -04:00
Bob Potter 23cef6202e website: default health check is 'serfHealth' 2015-03-05 17:38:28 -08:00
Ryan Breen b3f2bbe753 Website: GH-751 Link to anti-entropy doc everywhere that the term is used. 2015-03-04 10:22:53 -05:00
Seth Vargo e612549d45 Be consistent in docs about Consul Replicate vs consul-replicate 2015-02-24 20:29:41 -05:00
Armon Dadgar 65bdd83187 Merge pull request #695 from ryanbreen/session
Website: cleanup for docs/agent/http/session
2015-02-13 17:21:24 -08:00
Ryan Breen 48d5f49cf8 Remove language about LockDelay parsing. 2015-02-12 20:34:40 -05:00