Commit Graph

521 Commits

Author SHA1 Message Date
Ryan Uber 01b28b9581 website: document near parameter of prepared queries 2016-07-01 11:50:09 -07:00
James Phillips af30e17dcd Merge pull request #2123 from hashicorp/f-key-metrics
Adds a key metrics section to the telemetry guide.
2016-06-18 04:01:15 +01:00
James Phillips 4c82c45ee9 Adds a key metrics section to the telemetry guide. 2016-06-17 18:57:42 +01: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
Michael Barrow 9c3e2f1aef Fix typo
Simple typo fix.
2016-05-29 10:24:44 -07:00
Sean Chittenden 446d76b432
Fix the href target for the `/v1/catalog/node/<node>` endpoint. 2016-05-27 00:12:17 -07:00
Sean Kilgore edc31a9391 docs: clarify address specification for telemetry
Earlier on this page, under `addresses`, we say "For TCP addresses, these should simply be an IP address without the port. For example: 10.0.0.1, not 10.0.0.1:8500." Since we expect the port to be included for `_address` for telemetry, call it out specifically.
2016-05-24 12:55:23 -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 0f5aabcbbd Merge pull request #2028 from hashicorp/f-atomic-kv
Adds support for atomic transactions spanning multiple KV entries.
2016-05-15 13:46:05 -07:00
Sean Chittenden 92298e3d02
Speling police 2016-05-15 09:13:52 -07: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 c6bde826a4 Fixes and clarifies the only_passing docs. 2016-04-27 14:55:38 -07:00
James Phillips ceac68c5eb Merge pull request #1762 from mshean/script-timeout
Add Timeout field to CheckMonitor
2016-04-24 23:08:06 -07:00
Sean Chittenden 0c7f697244 Tweak discussion regarding reaping to advise against adjusting these
values.
2016-04-21 14:24:41 -07:00
Sean Chittenden bb7c3b75a3 Fix broken markdown 2016-04-20 18:46:01 -04:00
James Phillips c11e1506c5 Merge pull request #1935 from hashicorp/f-reap-time
Makes reap time configurable for LAN and WAN.
2016-04-20 13:50:21 -07:00
James Phillips cf00c11221 Sets an anti-footgun floor for the configurable reap time. 2016-04-20 13:49:51 -07:00
Matt Shean fa575db15c Update documentation for CheckMonitor timeout 2016-04-20 11:43:49 -07:00
James Phillips 963916e990 Clarifies default behavior of blank service addresses. 2016-04-20 10:16:06 -07:00
Ryan Uber 8855ec0e2d website: mention 4K output limit for checks 2016-04-14 14:35:35 -07:00
James Phillips 724707649c Merge pull request #1891 from romansky/patch-1
clerify RPC usage
2016-04-12 02:10:15 -07:00
James Phillips 7f55f9825f Updates some docs that say reaping is not configurable. 2016-04-11 00:56:03 -07:00
James Phillips eedeba682b Makes reap time configurable for LAN and WAN. 2016-04-11 00:38:25 -07:00
Sean Chittenden bd05093986 Add a note re: pre-0.7 behavior 2016-03-31 18:06:58 -07:00
Sean Chittenden 5994c9efbf skip_leave_on_int's default changes based on agent mode
`skip_leave_on_int`'s behavior now changes based on whether or not the agent is acting as a client or server.

Fixes: 1687
2016-03-31 17:45:14 -07:00
Roman Landenband 2a034373ed fix correct RPC entity 2016-03-30 12:21:52 +03:00
Sean Chittenden fe0a7283d3 Reword `udp_answer_limit` for the better. 2016-03-29 23:48:22 -07:00
Sean Chittenden fcee9779ae Use industry jargon re: DNS round-robin
s/randomized DNS round-robin/round-robin DNS/
2016-03-29 23:07:42 -07:00
Sean Chittenden d4f7f143f2 Whitespace, indent markdown correctly 2016-03-29 19:27:36 -07:00
Sean Chittenden c5c8daf07a Trim UDP responses per configuration 2016-03-29 19:27:21 -07:00
Sean Chittenden 4b5674bee3 Merge branch 'b-dns-single-record' of ssh://github.com/hashicorp/consul into b-dns-single-record
# Conflicts:
#	command/agent/dns.go
2016-03-29 19:24:53 -07:00
Sean Chittenden 9fb64ab114 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-03-29 19:23:56 -07:00
Roman Landenband aebae0349b clerify RPC usage 2016-03-29 15:10:28 +03:00
James Phillips 77ad084229 Fixes JSON in wildcard query example. 2016-03-23 14:33:20 -07:00
James Phillips e60a095207 Merge pull request #1839 from foxel/patch-1
Clarification for advertise_addrs.rpc
2016-03-21 16:14:17 -07:00
Sean Chittenden f33b2722d8 Update the docs slightly re: only_passing
Signed-off by: @slackpad
2016-03-21 16:07:56 -07:00
Sayalic bb9ddee4a0 add inline code segment to enableTagOverride 2016-03-20 11:09:12 +08:00
Wim b5d45322b4 Allow [::] as a bind address (binds to first public IPv6 address) 2016-03-18 23:59:44 +01:00
Miquel Sabaté Solà 4567963d8e command: deprecated the -dc flag in the agent CLI
The `-dc` flag from the agent CLI command has been deprecated in favor of
`-datacenter`. This is done this way because:

- Other CLI commands used `-datacenter`. See: event, exec and watch.
- The agent configuration file uses `datacenter`.

Signed-off-by: Miquel Sabaté Solà <msabate@suse.com>
2016-03-18 15:44:35 +01:00
James Phillips 6b2ace6f6b Fixes a few bugs in the prepared query doc. 2016-03-17 23:42:27 -07:00
Andrey Kupreychik f4cc8e7620 Clarification for advertise_addrs.rpc
Clarification for advertise_addrs.rpc as it sets the server RPC port (default 8300)
2016-03-16 12:10:54 +05:00
James Phillips adea7cda81 Merge pull request #1803 from tylert/doc-enc-update
Update agent encryption doc example
2016-03-10 20:06:02 -08:00
James Phillips 01ae1e7dfe Merge pull request #1820 from hashicorp/f-port-docs
Adds a reference to the network ports from the security guide.
2016-03-09 21:22:41 -08:00
James Phillips c1de5b7a13 Adds a reference to the network ports from the security page. 2016-03-09 21:21:49 -08:00
Igor Dubinskiy bc7b65452c Fix doc typo 2016-03-09 12:41:49 -08:00
Tyler Tidman 43312b4a69 Update agent encryption doc example 2016-03-09 11:18:48 -05:00
Igor Dubinskiy 3a25860270 Make sure UDP DNS responses aren't larger than allowed 2016-03-07 16:41:17 -08: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 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
Sean Chittenden d2745081f3 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 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
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
Armon Dadgar 6a350d5d19 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
David Adams b7bcb2a414 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 dc05fb728a Updates docs about new "acquire when you already have it" behavior. 2015-10-15 14:59:09 -07:00
Jeff Wang 0488dfd366 Make service lookup DNS documentation consistent 2015-09-23 23:16:34 -07:00
Jeff Wang ce66db8157 Make node lookup DNS documentation consistent 2015-09-23 23:09:52 -07:00
James Phillips 2f9ebdb135 Merge pull request #1187 from sfncook/enable_tag_drift_03
Enable tag drift 03
2015-09-11 15:35:32 -07:00
Shawn Cook 1f330add02 Doc changes in response to review. 2015-09-11 15:26:30 -07:00
Shawn Cook 598526eba2 Docs - add verbage to anti-entropy page. 2015-09-11 14:27:54 -07:00
Anthony Scalisi 10e028d599 remove various typos 2015-09-11 12:29:54 -07:00
Shawn Cook 4caf049c4c Update documentation for service definition 2015-09-11 09:32:54 -07:00
James Phillips 1387aba91b Fixes a typo in the telemetry docs. 2015-09-02 21:37:31 -07:00
Ryan Breen 80d26f9156 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
Andy Lo-A-Foe bb5422af14 Position it alphabetically 2015-09-02 06:28:55 +02:00
Andy Lo-A-Foe 00b906774b Update agent options section on the website 2015-09-02 05:36:09 +02:00
Ryan Uber 4adc0b5c66 website: document precedence of Atlas endpoint inputs 2015-08-27 17:54:56 -07:00
Ryan Uber b8e82eee1c website: document atlas endpoint config 2015-08-27 11:31:29 -07:00
Ryan Uber b0fcb6c234 Merge pull request #1199 from hashicorp/f-scada-reload
SCADA client is reload-able
2015-08-26 11:46:50 -07:00
Ryan Uber 96e7b1869c website: add atlas token/infra to reloadable config 2015-08-25 17:21:29 -07:00
James Phillips 103fe83b4a Clarifies services docs a bit. 2015-08-25 16:12:19 -07:00
Cameron Stokes 23db28a5db Added detail about left/failed nodes and 72h reaping
Ref: https://groups.google.com/forum/#!searchin/consul-tool/left/consul-tool/KVl0u91uCdw/bfzrUO4r-1QJ
2015-08-06 17:37:48 -07:00
Peter Fern 916ff7e5fa Document `TCP` check type 2015-07-27 10:53:52 +10:00
ketzacoatl b63041c3b0 Minor improvement to `acl_master_token` docs
Confirm the expected format, and what happens if not provided.
2015-07-01 15:34:35 -04:00
Ryan Uber 6290cb93bd website: adding tag/service name dns compliance docs 2015-06-25 09:08:38 -07:00
Ryan Uber d0348d1291 Merge pull request #1004 from i0rek/advertise_addrs
Add advertise_addrs.
2015-06-23 12:32:07 -07:00
Hans Hasselberg 267e0caf81 Implement advertise_addrs for SerfLan, SerfWan and RPC.
Fixes #550.
This will make it possible to configure the advertised adresses for
SerfLan, SerfWan and RPC. It will enable multiple consul clients on a
single host which is very useful in a container environment.

This option might override advertise_addr and advertise_addr_wan
depending on the configuration.

It will be configureable with advertise_addrs. Example:

{
  "advertise_addrs": {
    "serf_lan": "10.0.120.91:4424",
    "serf_wan": "201.20.10.61:4423",
    "rpc": "10.20.10.61:4424"
  }
}
2015-06-23 21:23:45 +02:00
Ryan Uber c8b3e48cbf website: link to check pass/fail endpoint docs from checks page 2015-06-22 10:21:50 -07:00
Ryan Uber c8f76b5e2c website: document passing ACL tokens in catalog register/deregister 2015-06-15 11:45:30 -07:00
Christian Theune 74ac30c601 Wording. 2015-06-12 16:09:44 +02:00
Christian Theune 7211876688 Make behaviour of keyprefixes always matching all keys in a prefix more clear. 2015-06-12 16:07:42 +02:00
Ryan Uber e872587e19 website: document TTL check persistence 2015-06-05 17:15:57 -07:00
siddharthist 0dac1ea126 Clarify how intervals are parsed
Current docs only show second intervals and do not specify
other valid options, this commit specifically outlines how the times are
parsed.
2015-06-03 12:53:09 -05:00
Ryan Uber 32820fc9d2 website: add status field for check registration in http docs 2015-05-28 13:09:33 -07:00
Ryan Uber 1ae7710024 website: document setting initial status of health checks in config 2015-05-28 13:03:01 -07:00
Armon Dadgar ab3632e409 consul: lower default query time and add small stagger 2015-05-14 17:59:43 -07:00
Armon Dadgar 90d6204a1a website: document the new TLS changes 2015-05-11 16:22:10 -07:00
Cameron Ruatta 587cd35c6c Adding docs about configuration directory sub-directories 2015-05-11 10:36:50 -07:00
Cameron Ruatta 9271d94532 Adding documentation about specifying multiple configuration directories 2015-05-11 10:19:04 -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
Ryan Uber 739d1fdf03 Merge pull request #891 from hashicorp/f-token
ACL tokens for service/check registration
2015-05-05 22:17:31 -07:00
Armon Dadgar c0f92c3256 website: Document new ACL upsert behavior 2015-05-05 19:25:27 -07:00
Armon Dadgar a86f31517b Merge pull request #816 from pepov/master
Support different advertise address for WAN gossip
2015-05-04 15:40:25 -07:00