James Phillips
4c3b2edfed
Fixes a few bugs in the prepared query doc.
2016-03-17 23:42:27 -07:00
Andrey Kupreychik
d3bce2b1af
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
ec82388e32
Merge pull request #1803 from tylert/doc-enc-update
...
Update agent encryption doc example
2016-03-10 20:06:02 -08:00
James Phillips
ae7b45a6df
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
b2992a5e83
Adds a reference to the network ports from the security page.
2016-03-09 21:21:49 -08:00
Igor Dubinskiy
8a877c44eb
Fix doc typo
2016-03-09 12:41:49 -08:00
Tyler Tidman
df7f593747
Update agent encryption doc example
2016-03-09 11:18:48 -05:00
Igor Dubinskiy
f4edb28ef3
Make sure UDP DNS responses aren't larger than allowed
2016-03-07 16:41:17 -08: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
ecc617008a
Merge pull request #1777 from hashicorp/b-port-docfix
...
TLS example and correcting error
2016-03-01 13:02:30 -08:00
James Phillips
807769e6bd
Tweaks the address and advertise docs.
2016-03-01 13:01:13 -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
Michael Crilly
b90e77421a
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
66feca5b5f
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
800910137d
Adds documentation for WAN address translation.
2016-02-07 11:12:19 -08:00
James Phillips
4b3dede0fb
Tweaks the telemetry docs.
2016-02-06 22:07:11 -08:00
Nate Brown
541a98c9c7
Option to disable hostnames from telemetry
2016-01-29 13:44:48 -08:00
Raja Nadar
aa45c07f28
fixing small typo in json
2016-01-29 01:25:23 -08:00
Daryl
c4860cad7d
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
e110abee9b
Fix broken link
2016-01-13 19:32:30 -05:00
Seth Vargo
dc9131a732
Use HTTPS + www. where appropriate
2016-01-13 17:44:01 -05:00
James Phillips
55970248bc
Tweaks wording of reap config option section.
2016-01-06 22:29:03 -08:00
James Phillips
df361afed5
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
f861f35da7
Merge pull request #1549 from kikitux/patch-1
...
[doc] fix identation on statsd_addr
2016-01-02 06:50:56 -08:00
Peter Schaadt
5a72fe2803
Fixing typos in Coordinate documentation.
2015-12-28 16:34:09 -08:00
Ryan Uber
579a08ec20
website: add docs for dev mode
2015-12-27 09:45:59 -06:00
Alvaro Miranda
92f0164f97
fix identation on statsd_addr
...
ditto
2015-12-27 18:19:31 +13:00
Ryan Uber
0fabf273e6
website: document the static ui flag
2015-12-24 22:21:34 -05:00
James Phillips
e1d456a079
Changes sense of option to "reap" and uses nil for "not set".
2015-12-22 10:28:10 -08:00
James Phillips
1e4aa28c9d
Adds child process reaping when Consul is running as PID 1.
2015-12-21 21:47:35 -08:00
James Phillips
43808ca120
Clarifies format of stats aggregator configurations as host:port.
2015-12-18 22:53:55 -08:00
Sep Nasiri
d644ede899
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
232fc7d5fd
Adds blank line to fix Docker check formatting.
2015-12-08 00:04:55 -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
bcbf6d268e
Removes old logging doc which was empty.
2015-11-18 14:41:50 -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
talwai
3d64189bfa
Add DogStatsD configuration options to documentation source
2015-11-11 14:30:37 -05:00
Diptanu Choudhury
1e379f45f0
Some more grammer corrections and formatting to docker check docs
2015-10-28 14:56:55 -07:00
Diptanu Choudhury
b29a785614
Some changes to the docker check docs
2015-10-28 14:24:03 -07:00
Diptanu Choudhury
c3cf24d022
Added some docs for the docker check
2015-10-28 14:19:57 -07:00
Cameron Stokes
46021ab4b4
Clarify format of the -atlas agent option.
2015-10-27 14:21:05 -07:00
Victor Trac
adf4189707
Mote -> Note typo
2015-10-26 15:10:20 -05: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
Armon Dadgar
d035dbd43b
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
5f175add40
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
4ec5013811
Updates docs about new "acquire when you already have it" behavior.
2015-10-15 14:59:09 -07:00
Jeff Wang
75c21693a8
Make service lookup DNS documentation consistent
2015-09-23 23:16:34 -07:00
Jeff Wang
ac5af9bcbc
Make node lookup DNS documentation consistent
2015-09-23 23:09:52 -07:00
James Phillips
b25797a808
Merge pull request #1187 from sfncook/enable_tag_drift_03
...
Enable tag drift 03
2015-09-11 15:35:32 -07:00
Shawn Cook
451abfa206
Doc changes in response to review.
2015-09-11 15:26:30 -07:00
Shawn Cook
7d6f30da1c
Docs - add verbage to anti-entropy page.
2015-09-11 14:27:54 -07:00
Anthony Scalisi
8d733b7fca
remove various typos
2015-09-11 12:29:54 -07:00
Shawn Cook
7c85d588d5
Update documentation for service definition
2015-09-11 09:32:54 -07:00
James Phillips
c601f64c3f
Fixes a typo in the telemetry docs.
2015-09-02 21:37:31 -07:00
Ryan Breen
a013095f62
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
46e614ae70
Position it alphabetically
2015-09-02 06:28:55 +02:00
Andy Lo-A-Foe
e9ee1f9bea
Update agent options section on the website
2015-09-02 05:36:09 +02:00
Ryan Uber
10c38f8c3a
website: document precedence of Atlas endpoint inputs
2015-08-27 17:54:56 -07:00
Ryan Uber
d9210f4a0c
website: document atlas endpoint config
2015-08-27 11:31:29 -07:00
Ryan Uber
aa30194328
Merge pull request #1199 from hashicorp/f-scada-reload
...
SCADA client is reload-able
2015-08-26 11:46:50 -07:00
Ryan Uber
e533789088
website: add atlas token/infra to reloadable config
2015-08-25 17:21:29 -07:00
James Phillips
89d03026bc
Clarifies services docs a bit.
2015-08-25 16:12:19 -07:00
Cameron Stokes
92b86f0631
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
403b42af99
Document `TCP` check type
2015-07-27 10:53:52 +10:00
ketzacoatl
efc2d316c1
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
cb0043e8f8
website: adding tag/service name dns compliance docs
2015-06-25 09:08:38 -07:00
Ryan Uber
715f69cce8
Merge pull request #1004 from i0rek/advertise_addrs
...
Add advertise_addrs.
2015-06-23 12:32:07 -07:00
Hans Hasselberg
4598087df3
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
d529329944
website: link to check pass/fail endpoint docs from checks page
2015-06-22 10:21:50 -07:00
Ryan Uber
faab022f89
website: document passing ACL tokens in catalog register/deregister
2015-06-15 11:45:30 -07:00
Christian Theune
cdc00dc606
Wording.
2015-06-12 16:09:44 +02:00
Christian Theune
1bac706593
Make behaviour of keyprefixes always matching all keys in a prefix more clear.
2015-06-12 16:07:42 +02:00
Ryan Uber
cf21fb1d0c
website: document TTL check persistence
2015-06-05 17:15:57 -07:00
siddharthist
be68db0136
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
b6e31a2e6f
website: add status field for check registration in http docs
2015-05-28 13:09:33 -07:00
Ryan Uber
90f8c91761
website: document setting initial status of health checks in config
2015-05-28 13:03:01 -07:00
Armon Dadgar
2c9592c5ee
consul: lower default query time and add small stagger
2015-05-14 17:59:43 -07:00
Armon Dadgar
97c87f4e4d
website: document the new TLS changes
2015-05-11 16:22:10 -07:00
Cameron Ruatta
dfbd466c71
Adding docs about configuration directory sub-directories
2015-05-11 10:36:50 -07:00
Cameron Ruatta
0b9bc7d2f5
Adding documentation about specifying multiple configuration directories
2015-05-11 10:19:04 -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
Ryan Uber
9acc42b86e
Merge pull request #891 from hashicorp/f-token
...
ACL tokens for service/check registration
2015-05-05 22:17:31 -07:00
Armon Dadgar
0473b40df2
website: Document new ACL upsert behavior
2015-05-05 19:25:27 -07:00
Armon Dadgar
efaed93b91
Merge pull request #816 from pepov/master
...
Support different advertise address for WAN gossip
2015-05-04 15:40:25 -07:00
Ryan Uber
8ae6790b33
website: document statsite_prefix option
2015-05-03 16:54:19 -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
Armon Dadgar
f12abbe51f
Merge pull request #844 from mkostrikin/patch-1
...
Small tip for gracefull kill
2015-04-10 10:43:09 -07:00
Ryan Uber
b18d75120c
website: fix typo
2015-04-08 09:59:23 -07:00
Maxim N. Kostrikin
1bf9ece0b9
Small tip for gracefull kill
2015-04-07 13:15:48 +05:00
Ryan Breen
a817a398dc
Website: GH-831, mention that https port must be specified to start an https listener.
2015-04-03 22:12:00 -04:00
Ryan Breen
70a71b9454
Website: GH-826 fix anchor links in /docs/agent/watches.html.
2015-03-31 17:22:50 -04:00
pepov
14c8c86fee
update the docs: add advertise-wan cli and advertise_addr_wan json config
2015-03-28 16:08:20 +01:00
Ryan Uber
57da15e049
website: document minimum session TTL setting
2015-03-27 11:34:27 -07:00
Ryan Breen
60e89f0a75
Website: GH-730 for docs/agent/watches.html.
2015-03-26 14:18:51 -04:00
Ryan Breen
d43b42ab70
Website: GH-730 for docs/agent/telemetry.html.
2015-03-25 08:56:40 -04:00
Ryan Breen
240b354594
Website: GH-730 for docs/agent/encryption.html
2015-03-24 15:30:35 -04:00
Ryan Breen
2d15f2f0f4
Website: GH-730 for docs/agent/dns.html.
2015-03-23 15:48:35 -04:00
Johannes 'fish' Ziemke
78cde71a22
Add -domain command line flag to agent
...
This makes it possible to configure the domain on the command line
additionally to the config file.
2015-03-20 16:05:41 +01:00
tummychow
e83598b043
Add doc notes for HTTPS API
...
- the HTTPS API address can be configured just like any other address
- the verify_incoming setting also applies to the HTTPS API
2015-03-18 16:08:41 -07:00
Ryan Breen
ca7cd6496a
Website: cleanup for intro/getting-started/checks.html.
2015-03-17 17:50:28 -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
Ryan Breen
ad7d1b3090
Website: GH-747 change acl_master token to acl_master_token
2015-03-03 11:46:57 -05:00
Ryan Breen
ce93505a16
Website: GH-747 Add docs on acl_master_token installation.
2015-03-03 11:33:49 -05:00
Seth Vargo
e612549d45
Be consistent in docs about Consul Replicate vs consul-replicate
2015-02-24 20:29:41 -05:00
Ryan Breen
87fccbc40c
Website: Add links to options and commands referenced in docs/agent/basics.html and docs/guide/bootstrapping.html.
2015-02-24 14:11:11 -05:00
Ryan Breen
559084724a
Manually specify anchors for each LI in options.html. This is necessary because the middleman-hashicorp logic only inserts anchors if the body of the LI contains no links. For consistent presentation, we need to specify all anchors rather than relying on middleman.
2015-02-24 12:30:17 -05:00
Ryan Breen
d205512336
Website: /docs/agent/options Fix internal links in options.html to match the anchors created by middleman-hashicorp.
2015-02-23 15:34:46 -05:00
Ryan Breen
3f17f30691
Merge branch 'master' of github.com:hashicorp/consul
2015-02-23 14:45:00 -05:00
Ryan Breen
8ff0368aa4
Website: docs/agent/options.html Fix config-file reference.
2015-02-23 14:44:31 -05:00
Ryan Uber
bb85d6f331
website: document -recursor arg for agent cli
2015-02-23 10:43:15 -08:00
Ryan Breen
53afd77e2d
s/data center/datacenter/g
2015-02-19 17:45:47 -05:00
Armon Dadgar
52bdbdade9
website: Adding Atlas docs
2015-02-18 15:15:01 -08:00
Armon Dadgar
441b940280
website: Document new options
2015-02-18 15:15:01 -08:00
Ryan Breen
e13bc41d3f
Website: add some missing intra-page links in docs/agent/options
2015-02-16 20:51:04 -05:00
Ryan Breen
45a9c231be
Website: clean up a few intra-page links in docs/agent/options
2015-02-16 20:42:21 -05:00
Ryan Breen
61f1955c31
Website: add intra-page links in docs/agent/options
2015-02-16 19:48:49 -05:00
Ryan Breen
5634061a9f
Website: finalize edits for configuration file options in docs/agent/options.
2015-02-15 00:47:52 -05:00
Ryan Breen
9912be7e5f
Website: edits for configuration file options in docs/agent/options.
2015-02-15 00:43:01 -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
5cfed30179
Website: tweak cleanup for the docs/agent/options Command-line options section.
2015-02-13 15:19:17 -05:00
Ryan Breen
f234f1af67
Website: cleanup for the docs/agent/options Command-line options section.
2015-02-13 14:58:05 -05:00
Ryan Breen
48d5f49cf8
Remove language about LockDelay parsing.
2015-02-12 20:34:40 -05:00
Armon Dadgar
9ec38a1fb9
Merge pull request #692 from ryanbreen/kv
...
Website: cleanup of docs/agent/http/kv
2015-02-12 16:53:49 -08:00
Ryan Breen
443cf2dd74
More cleanup for docs/agent/http/session.
2015-02-12 15:15:53 -05:00