Commit Graph

697 Commits

Author SHA1 Message Date
James Phillips 6b2ace6f6b Fixes a few bugs in the prepared query doc. 2016-03-17 23:42:27 -07:00
James Phillips 6711662676 Adds a note about template query ACLs. 2016-03-17 08:21:58 -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 cce0ace53a Fixes name of new query ACL. 2016-03-04 16:32:53 -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 b64f19bb08 Adds an upgrade note about the new ACL behavior. 2016-02-24 01:33:10 -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
csawyerYumaed 5026a40ec1 Update documentation - add Network Ports.
Update security.html.markdown add section on Network Port usage.
TODO: add Atlas port usage.
2016-02-23 11:27:15 -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
Kim Toms 7e8e11aea3 Update leader-election.html.markdown
Remove duplicate 'leader'
2016-02-14 09:32:23 -05: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 03602779c6 Fixes a typo. 2016-02-09 16:37:06 -08:00
James Phillips d2cc2801fa Merge pull request #1698 from hashicorp/pr-1547-slackpad
Implements WAN address translation.
2016-02-07 14:26:04 -08:00
James Phillips 590ab94d8d Adds documentation for WAN address translation. 2016-02-07 11:12:19 -08:00
James Phillips eb8ee9fce0 Merge pull request #1609 from kevinsimper/patch-1
Updating dns forwarding
2016-02-06 22:21:00 -08:00
James Phillips d2d6b51fe4 Tweaks the telemetry docs. 2016-02-06 22:07:11 -08:00
James Phillips d60be51f01 Merge pull request #1284 from nbrownus/telemetry
Option to disable hostnames from telemetry
2016-02-06 22:00:14 -08:00
James Phillips 64ec6d7d73 Adds a warning about DoS-ing the cluster with consul exec. 2016-02-05 17:36:19 -08:00
Sean Chittenden 7db70cfcb6 Iterate on the DNS forwarding docs
Specifically:

* add Dnsmasq examples for reverse DNS for most of the RFC1918, 5735, and 6598 netblocks.
* Highlight some example options for dnsmasq that are probably of interest.
* Add a small section on reverse DNS testing
* Break out BINDs troubleshooting with Dnsmasq's troubleshooting

Not an exhaustive sweep, but should be helpful when introducing consul to new environments.
2016-02-02 15:06:25 -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
Kevin Simper 72353c5ad3 Updating dns forwarding
It is not really clear that you only have to do one of the following and not all three.
2016-01-14 22:53:14 +01:00
Jon Benson dcd01d1858 Fix semaphore typo 2016-01-13 16:56:40 -08: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 28ea3dff91 Adds a note about 2X memory provisioning. 2016-01-08 19:15:42 -08:00
James Phillips 891cba3899 Adds a cautionary note about data fitting into RAM. 2016-01-08 18:49:31 -08:00
James Phillips 203d8101eb Tweaks wording of reap config option section. 2016-01-06 22:29:03 -08:00
James Phillips 49342dc973 Makes the timeout behavior more intuitive.
Previously, it would try once "up to" the timeout, but in practice it would
just fall through. This modifies the behavior to block until the timeout has
been reached.
2016-01-06 09:40:20 -08:00
James Phillips 1d733f4c36 Defaults monitor retries to 3 retries @ 1s for the consul lock command. 2016-01-05 18:34:22 -08:00
James Phillips 4afeddacc8 Adds monitor retries to the consul lock command. 2016-01-05 18:22:36 -08:00
James Phillips 8caa9e4c7e Adds "try" support to locks and semaphores. 2016-01-05 18:22:36 -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 3a619ff4bf Tweaks RTT command docs. 2015-12-21 15:16:48 -08:00
James Phillips f3db4501c3 Merge pull request #1522 from sboily/patch-1
Update documentation to use consul rtt command with https
2015-12-21 15:14:57 -08:00
James Phillips 63b3e7f16a Clarifies format of stats aggregator configurations as host:port. 2015-12-18 22:53:55 -08:00
Sylvain Boily 9c2aadc5cb Update documentation to use rtt with https 2015-12-17 13:24:42 -05:00
James Phillips ec5d9463bc Adds a note about the new web UI layout. 2015-12-15 15:17:11 -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
James Phillips f64249e955 Adds some more upgrade notes for Consul 0.6. 2015-12-07 17:58:43 -08:00
nftw 8f1e91576b Update atlas.html.markdown
Fixed minor typo
2015-12-07 17:06:11 +00:00
James Phillips 3cb33792e9 Updates the version specific instructions for 0.6.0. 2015-12-02 10:32:00 -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
James Phillips 86f56ee4a1 Adds a note about the new acquire behavior into the sessions internals guide. 2015-11-14 10:28:14 -08:00
talwai 0a5434f2a0 Add DogStatsD configuration options to documentation source 2015-11-11 14:30:37 -05:00
James Phillips cf1b9fe074 Fixes a typo. 2015-10-30 23:50:11 -07: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 99cfbb8a47 Defaults second node to agent if not given. Removes -short option and tweaks output formatting. 2015-10-23 15:23:01 -07:00
James Phillips 88845f7d71 Cleans up after code review, adds a -short option to "consul rtt" command. 2015-10-23 15:23:01 -07:00
James Phillips fb8900156a Adds a "consul rtt" command. 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
James Phillips ff1eec015f Gets rid of LMDB reference in the FAQ. 2015-10-20 13:39:11 -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
Ryan Uber d6af59cded Merge pull request #1309 from hashicorp/f-remove-migrate
Removes consul-migrate for 0.6
2015-10-15 14:50:19 -07:00
Ryan Uber 3872e57b3b website: add note for consul migrate utility. 2015-10-15 14:42:46 -07:00
Ryan Breen 8ecf4d1f6e Update datacenters.html.markdown
Fix GH-1305.
2015-10-15 14:36:54 -04: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
James Phillips 26ce9d16be Merge pull request #1200 from ryotarai/lock-pass-stdin
command/lock: Pass stdin to child process when -pass-stdin passed.
2015-08-31 21:14:45 -07:00
Ryota Arai b2755d026e website: description of -pass-stdin option 2015-09-01 11:00:26 +09:00
Ryan Breen 8e8526de8f Cleanup for guides/forwarding.html 2015-08-30 12:01:49 -04:00
Marc Tamsky 0db9346ecc Explain 'recursors' behavior with an example. 2015-08-28 18:27:26 -07:00
Marc Tamsky b71a51e277 add dnsmasq example, add pointer to 'recursors' 2015-08-28 18:10:37 -07: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
James Phillips 88c15e5bbd Fixes a typo in the event docs, and twiddles the formatting. 2015-08-13 17:26:41 -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
Jack Pearkes 25f0f3cb37 website: fix broken link on acl page 2015-07-31 12:14:28 -07:00
Armon Dadgar 4a9b91f2a2 Merge pull request #1130 from pdf/check_socket
Add Socket check type
2015-07-27 14:21:24 -07:00
Peter Fern 916ff7e5fa Document `TCP` check type 2015-07-27 10:53:52 +10:00
Ryan Uber 38175f450b website: docs for keyring ACLs 2015-07-07 11:45:49 -06:00
Ryan Uber e37b5ecb69 Merge pull request #1046 from hashicorp/f-event-acl
Event ACLs
2015-07-02 07:02:07 -07: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 7e63572df6 website: document -token parameter for exec/event commands 2015-06-22 17:19:07 -07: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 84a47947d7 website: fix event acl policy docs 2015-06-19 12:18:09 -07:00
Ryan Uber 1e5a2a8960 website: add docs for user event acls 2015-06-18 18:13:29 -07:00
Ryan Uber 0381e1a253 website: fix mention of read-only policy for service acls 2015-06-18 18:13:01 -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 e7125213ca website: add a note in the upgrade notes for 0.6 discovery ACLs 2015-06-11 17:48:08 -07:00
Ryan Uber 9285ec1891 website: add note about anonymous token and discovery ACLs 2015-06-11 17:39:01 -07:00
Ryan Uber 96746fb1c1 website: document service discovery ACLs 2015-06-11 14:45:52 -07: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
Andrew Ortman 4bf6babea5 Update upgrade instructions for 0.5.2
The docs were confusing as to whether or not 0.5.2 includes the migration tool, which it does. This edit should make it more clear for the end user
2015-06-02 13:02:35 -05:00
Clint Shryock dcb2d9e5ac fix typo 2015-06-01 08:34:54 -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