Commit graph

103 commits

Author SHA1 Message Date
Brian Shumate af45d3463a
Remove references to the 'unknown' state.
- Remove reference to 'unknown' state in catalog endpoint docs
- Remove reference to 'unknown' state in health endpoint docs
2016-09-21 09:50:12 -04:00
James Phillips 3b1f368fe5 Adds version note to near parameter. 2016-09-06 07:50:06 -07:00
James Phillips c063a1a8d0
Updates documentation with details on the Consul operator actions. 2016-08-30 13:15:37 -07:00
James Phillips 1b7a16b7d3
Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 2016-08-30 00:02:50 -07:00
James Phillips db4666c7e4 Update acl.html.markdown 2016-08-17 10:21:59 -07:00
James Phillips db9a72dde1
Merge branch 'master' into f-deregister-critical 2016-08-16 12:53:21 -07:00
James Phillips 607595f99e
Cleans up based on code review feedback. 2016-08-16 12:52:30 -07:00
James Phillips 817d7e93e4
Adds an "lan" tagged address so we have a way to get them all.
If we didn't have this, then there would be no way to know the LAN
address if address translation was turned on.
2016-08-16 10:49:03 -07:00
James Phillips f517f9ed0d
Fixes a typo and adds an admonition about only being in Consul 0.7+. 2016-08-16 09:27:20 -07:00
James Phillips b4f981c837
Adds ability to deregister a service based on critical check state longer than a timeout. 2016-08-16 01:00:26 -07:00
James Phillips 3585b5a4cb Merge pull request #2237 from hashicorp/f-acl-replication
Adds ACL replication.
2016-08-09 11:42:16 -07:00
James Phillips 5577b8ef66
Updates documentation for ACL replication. 2016-08-05 00:23:28 -07:00
Andrei Burd 06c0663082 Added missing comma 2016-08-01 18:46:43 +03:00
James Phillips 63ff6ebc2c Adds a cautionary note about the stats in the self API. 2016-07-29 13:45:25 -07:00
James Phillips 36b2ef619e Tweaks the agent docs for EnableTagOverride. 2016-07-23 14:48:54 -07:00
shalev67 0763f1a9f5 Added api agent docs enableTagOverride var 2016-07-22 20:21:07 +03:00
akbarahmed 99c1e0051d Merge remote-tracking branch 'upstream/master' 2016-07-19 11:01:55 -07:00
akbarahmed 25f6bc9d56 Unnest TaggedAddresses. Add sentence to mention that multiple Checks may
be specified as an array. Closes hashicorp/consul#2176
2016-07-19 10:55:46 -07:00
Stu Small 6a664a4669 Fixing minor punctuation mistake. 2016-07-13 16:50:19 -06:00
Ryan Uber 53dc58ff27 website: document near parameter of prepared queries 2016-07-01 11:50:09 -07:00
Sheldon Kwok a3788d4ede Update agent.html.markdown
The documentation was not clear and I had to try with the cli to figure it out.
2016-06-09 16:48:18 -07:00
lihz b862d3f044 add tcp in service/register
I found consul /service/register interface supprt TCP check as well.
2016-06-03 19:29:05 +08:00
Sean Chittenden 67b9104daf
Fix the href target for the /v1/catalog/node/<node> endpoint. 2016-05-27 00:12:17 -07:00
Saif Abid e786aafe70 Fix json for /v1/catalog/node in markdown
add in a missing comma after the "Address" field
2016-05-19 14:41:41 -04:00
James Phillips c786e1d457 Reduces the number of operations in a transaction to 64. 2016-05-14 21:40:46 -07:00
James Phillips a11f32a1da Adds a get-tree verb to KV transaction operations. 2016-05-13 16:57:39 -07:00
James Phillips 77ae55c692 Adds some size limiting features to transactions to help prevent abuse. 2016-05-13 13:39:01 -07:00
James Phillips 5fd99b13ef Removes null results for deletes, and preps for more than one result from an operation. 2016-05-13 01:47:55 -07:00
James Phillips 2649a6336e Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
James Phillips 6daf26ada4 Adds documentation for the transaction endpoint. 2016-05-11 14:18:47 -07:00
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