Brian Shumate
2c9501a1b0
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
0a34741d72
Adds version note to near parameter.
2016-09-06 07:50:06 -07:00
James Phillips
2c9885d10d
Updates documentation with details on the Consul operator actions.
2016-08-30 13:15:37 -07:00
James Phillips
e5850d8a26
Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands.
2016-08-30 00:02:50 -07:00
James Phillips
9d154a55ad
Update acl.html.markdown
2016-08-17 10:21:59 -07:00
James Phillips
4c7a0ed3b0
Merge branch 'master' into f-deregister-critical
2016-08-16 12:53:21 -07:00
James Phillips
ba60afd5d8
Cleans up based on code review feedback.
2016-08-16 12:52:30 -07:00
James Phillips
fbdd021ab9
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
231f5a957f
Fixes a typo and adds an admonition about only being in Consul 0.7+.
2016-08-16 09:27:20 -07:00
James Phillips
4a3d7db24f
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
95930e3cb7
Merge pull request #2237 from hashicorp/f-acl-replication
...
Adds ACL replication.
2016-08-09 11:42:16 -07:00
James Phillips
c499c4e7d3
Updates documentation for ACL replication.
2016-08-05 00:23:28 -07:00
Andrei Burd
094d7cb9e0
Added missing comma
2016-08-01 18:46:43 +03:00
James Phillips
85bd2a5459
Adds a cautionary note about the stats in the self API.
2016-07-29 13:45:25 -07:00
James Phillips
4fb97a2ef9
Tweaks the agent docs for `EnableTagOverride`.
2016-07-23 14:48:54 -07:00
shalev67
f66bf3114a
Added api agent docs enableTagOverride var
2016-07-22 20:21:07 +03:00
akbarahmed
79dd717f41
Merge remote-tracking branch 'upstream/master'
2016-07-19 11:01:55 -07:00
akbarahmed
591f6ca3ef
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
450d3dbe91
Fixing minor punctuation mistake.
2016-07-13 16:50:19 -06:00
Ryan Uber
01b28b9581
website: document near parameter of prepared queries
2016-07-01 11:50:09 -07:00
Sheldon Kwok
14abdbf5ad
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
392c2605f3
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
446d76b432
Fix the href target for the `/v1/catalog/node/<node>` endpoint.
2016-05-27 00:12:17 -07:00
Saif Abid
8211555d0d
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
653387637a
Reduces the number of operations in a transaction to 64.
2016-05-14 21:40:46 -07:00
James Phillips
778b975e7a
Adds a get-tree verb to KV transaction operations.
2016-05-13 16:57:39 -07:00
James Phillips
570d46aa5f
Adds some size limiting features to transactions to help prevent abuse.
2016-05-13 13:39:01 -07:00
James Phillips
fbfb90a694
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
a37bf9de56
Adds a read-only optimized path for transactions.
2016-05-13 00:34:05 -07:00
James Phillips
17cd0ac4ec
Adds documentation for the transaction endpoint.
2016-05-11 14:18:47 -07:00
James Phillips
963916e990
Clarifies default behavior of blank service addresses.
2016-04-20 10:16:06 -07:00
James Phillips
77ad084229
Fixes JSON in wildcard query example.
2016-03-23 14:33:20 -07:00
James Phillips
6b2ace6f6b
Fixes a few bugs in the prepared query doc.
2016-03-17 23:42:27 -07:00
James Phillips
aa8cd2619d
Fixes broken example JSON.
2016-03-07 10:45:39 -08:00
James Phillips
eb7004f2b8
Renames "debug" endpoint and structures to "explain".
2016-03-07 10:45:39 -08:00
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
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
James Phillips
590ab94d8d
Adds documentation for WAN address translation.
2016-02-07 11:12:19 -08:00
Raja Nadar
cd17cdc03d
fixing small typo in json
2016-01-29 01:25:23 -08:00
Seth Vargo
f5ffa8fb79
Fix broken link
2016-01-13 19:32:30 -05:00
Peter Schaadt
b15d02e431
Fixing typos in Coordinate documentation.
2015-12-28 16:34:09 -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
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
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
James Phillips
36c78f5042
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
89c7203f31
Adds coordinate sorting support to catalog queries for nodes and service nodes.
2015-10-23 15:23:01 -07:00
James Phillips
dc05fb728a
Updates docs about new "acquire when you already have it" behavior.
2015-10-15 14:59:09 -07:00
James Phillips
103fe83b4a
Clarifies services docs a bit.
2015-08-25 16:12:19 -07:00
Peter Fern
916ff7e5fa
Document `TCP` check type
2015-07-27 10:53:52 +10:00
Ryan Uber
c8f76b5e2c
website: document passing ACL tokens in catalog register/deregister
2015-06-15 11:45:30 -07:00
Ryan Uber
32820fc9d2
website: add status field for check registration in http docs
2015-05-28 13:09:33 -07:00
Ryan Uber
dd57071240
website: Document peers api consistency. Fixes #880
2015-05-06 12:13:28 -07:00
Armon Dadgar
f3a8f907fb
Merge pull request #909 from hashicorp/f-create
...
Support ACL upsert behavior
2015-05-06 11:22:11 -07:00
Armon Dadgar
c0f92c3256
website: Document new ACL upsert behavior
2015-05-05 19:25:27 -07:00
Ryan Uber
8d2834fb12
website: document service and check acl options
2015-04-28 14:28:06 -07:00
Vasily Vasilkov
3f5e767c30
Fix invalid link to sessions page
2015-04-22 12:40:27 +03:00
Cameron Ruatta
c7d560bd7e
Caps not necessary here
2015-04-20 20:59:45 -07:00
Cameron Ruatta
b3c084382e
Updating the docs to include information about registering a check with
...
a serviceid.
2015-04-20 20:56:26 -07:00
Ryan Breen
17c2644e39
Website: minor fix for docs/agent/http/agent.html.
2015-04-17 11:43:02 -04:00
Bob Potter
7386c49fd6
website: default health check is 'serfHealth'
2015-03-05 17:38:28 -08:00
Ryan Breen
57a9928d48
Website: GH-751 Link to anti-entropy doc everywhere that the term is used.
2015-03-04 10:22:53 -05:00
Seth Vargo
a022dfcb32
Be consistent in docs about Consul Replicate vs consul-replicate
2015-02-24 20:29:41 -05:00
Armon Dadgar
9791cb1298
Merge pull request #695 from ryanbreen/session
...
Website: cleanup for docs/agent/http/session
2015-02-13 17:21:24 -08:00
Ryan Breen
679c5ddc50
Remove language about LockDelay parsing.
2015-02-12 20:34:40 -05:00
Armon Dadgar
20e936ead7
Merge pull request #692 from ryanbreen/kv
...
Website: cleanup of docs/agent/http/kv
2015-02-12 16:53:49 -08:00
Ryan Breen
f325791590
More cleanup for docs/agent/http/session.
2015-02-12 15:15:53 -05:00
Ryan Breen
d2bc6f156d
Website: cleanup for docs/agent/http/session.
2015-02-12 14:50:54 -05:00
Ryan Breen
22162efccf
Website: finalize cleanup of docs/agent/http/kv
2015-02-11 23:44:10 -05:00
Ryan Breen
1b6b1e09bd
Website: cleanup of docs/agent/http/kv
2015-02-11 21:54:03 -05:00
Ryan Breen
03fad82b09
Website: finalize cleanup for docs/agent/http/health.
2015-02-10 15:52:22 -05:00
Ryan Breen
01c74378a5
Website: cleanup for docs/agent/http/health.
2015-02-10 15:49:21 -05:00
Armon Dadgar
c6ec9dd844
Merge pull request #678 from ryanbreen/agent
...
Cleanup for docs/agent/http/agent.
2015-02-09 09:54:53 -08:00
Armon Dadgar
d3df3673fa
Merge pull request #681 from ryanbreen/catalog
...
Website: cleanup of docs/agent/http/catalog
2015-02-09 09:53:57 -08:00
Ryan Breen
6c9edb4eba
Website: cleanup for docs/agent/http/event.
2015-02-09 11:24:23 -05:00
Ryan Breen
b8beec0311
Website: finalize cleanup of docs/agent/http/catalog.
2015-02-08 12:49:02 -05:00
Ryan Breen
3df08cb7ab
Website: edits for docs/agent/http/catalog.
2015-02-08 12:44:36 -05:00
Ryan Breen
75f9327fe4
Finalize cleanup of docs/agent/http/agent.
2015-02-07 17:43:43 -05:00
Ryan Breen
b90fa33929
Cleanup for docs/agent/http/agent.
2015-02-07 17:36:10 -05:00
Ryan Breen
9e54778fbe
Fixes for docs/agent/http/status
2015-02-06 13:47:32 -05:00
Ryan Breen
a02bd2f586
Finalize cleanups for docs/agent/http/acl.
2015-02-05 12:02:03 -05:00
Ryan Breen
1fcded43af
Cleanups for docs/agent/http/acl.
2015-02-05 11:52:29 -05:00
Emil Hessman
6f3215f0a8
website: fix minor typos in docs
2015-01-23 22:11:15 +01:00
Ryan Uber
52ff08b6c0
website: document reason flag for http api
2015-01-21 14:33:01 -08:00
Ryan Uber
f4f9b5c94b
website: update maintenance mode endpoint
2015-01-21 11:15:15 -08:00