Commit graph

959 commits

Author SHA1 Message Date
Nicholas Capo e9fb85d675 Update HTTP Check documentation: 503 -> 429 2015-01-13 00:10:05 +00:00
Evan Broder b5e1de165b Add "only_passing" option to DNS config
This excludes nodes from DNS results if their healthchecks are in any
non-passing state, not just if they're critical.
2015-01-10 13:17:11 +01:00
Nicholas Capo f2649edcfc command/agent: Add simple HTTP check type
These checks make an `HTTP GET` request every Interval to the specified URL.
The status of the service depends on the HTTP Response Code.
`200` is passing, `503` is warning and anything else is failing.
2015-01-09 16:43:24 -06:00
Emil Hessman 8c991c3632 website: omit excessive use of the word lastly
Simplify wording by removing various uses of the word lastly.
2015-01-09 06:37:26 +01:00
Emil Hessman acfc42c3db website: fix typo
s/patameters/parameters/
2015-01-09 05:59:06 +01:00
Armon Dadgar 8befdcbd93 website: Documenting ?cas with KV DELETE 2015-01-08 17:34:41 -08:00
Armon Dadgar abbcecd1dd website: Updating the documentation 2015-01-08 12:08:29 -08:00
Armon Dadgar b435a0c842 website: Update session API documentation 2015-01-07 15:19:27 -08:00
Armon Dadgar 9ba908eadc website: Link to consul-replicate. Fixes #439 2015-01-07 13:30:30 -08:00
Armon Dadgar 1088a5c170 Merge pull request #558 from ceh/http-api-response-headers
add ability to specify response headers on the HTTP API
2015-01-05 11:36:08 -08:00
Emil Hessman 4461c750bb website: fix typo, casing and links
Fix typo in Leader Election guide: s/blog/blob/

Also fix various casing issues and prefer HTTPS links
for HashiCorp projects.
2015-01-04 12:58:58 +01:00
Armon Dadgar daae47fefc Merge pull request #556 from darron/master
Docs: It's not key - it's service.
2015-01-02 21:54:53 +05:30
Thordur Bjornsson cb32b82b37 Revert "correct the doc for obtaining formatted json"
This reverts commit cf3b9ec4fee09075481fd5c521dd6c4b8db58e91.
2015-01-02 08:00:09 +01:00
Emil Hessman db23a3f0e9 add ability to specify response headers on the HTTP API
Add an config object that allows adding HTTP header response fields to every
HTTP API response.

Each specified header is added to every response from all HTTP API endpoints.
Each individual endpoint may overwrite the specified header, which makes sure
that Consul headers such as 'X-Consul-Index' is enforced by the API.
2014-12-28 19:17:08 +01:00
darron froese ee834837b2 It's not key - it's service.
It's right in the description, but the example seems to be wrong.
2014-12-26 21:51:48 -08:00
Michael H. Oshita 8351121fde minor grammer fix 2014-12-11 19:02:29 +09:00
Dan Frost bd5467c593 docs: agent/watches: minor fixes 2014-11-26 13:48:33 +00:00
Dan Frost bfd6c8aac0 docs: agent/checks: minor fixes 2014-11-26 13:42:53 +00:00
Dan Frost f0a2fa325a docs: agent/dns: minor fixes 2014-11-26 13:33:55 +00:00
Dan Frost e1a0845f5a docs: agent/basics: minor fixes 2014-11-26 13:15:41 +00:00
Ryan Uber 58ba650cb0 website: Improve docs for reloading config. Fixes #407 2014-11-25 19:03:14 -08:00
Brandon Wilson 22ad8172b8 correct the doc for obtaining formatted json
was "?pretty" should be "?pretty=1"
2014-11-21 12:27:48 -08:00
Ryan Uber 196cbd27b2 agent: ignore -encrypt if provided when keyring exists 2014-11-19 16:37:40 -08:00
Ryan Uber 9217e371bc website: document new behavior of the -encrypt option 2014-11-19 16:36:01 -08:00
Ryan Uber bb06d5ccb8 website: remove keyring persistence options from agent page 2014-11-19 16:31:06 -08:00
Ryan Uber d8f513f6d6 website: update consul keys documentation 2014-11-19 16:30:22 -08:00
Armon Dadgar dd41c69389 Merge pull request #478 from amalaviy/https
Added HTTPS support via a new HTTPS Port configuration option
2014-11-19 11:17:10 -08:00
Atin Malaviya 46178dbb37 Change names to StartJoinWan, RetryJoinWan etc 2014-11-17 17:14:59 -05:00
Atin Malaviya 59a68ecc26 Added HTTPS support via a new HTTPS Port configuration option similar to the HTTP Port. 2014-11-17 14:29:35 -05:00
Atin Malaviya df8d099f49 Add start-wan-join, retry-wan-join and related configuration options and commandline options 2014-11-14 10:56:39 -05:00
Ryan Uber c9de806ab9 website: better description of config merging in agent options. Closes #470 2014-11-13 12:04:09 -08:00
Danny Berger 4347b9394d Fix some typos in website docs 2014-11-04 21:33:42 -07:00
Armon Dadgar 982b177e69 Support old recursor config for backwards compatibility 2014-11-03 11:28:21 -08:00
Armon Dadgar 2c16fec0cc Merge pull request #448 from foostan/multiple_recursor
Add multiple recursor definition support
2014-11-03 11:18:37 -08:00
foostan 4d8f1c2133 Add multiple recursor definition support 2014-11-01 04:26:26 +09:00
Laurent Raufaste 7d01816c1f Rephrase 2014-10-30 21:46:19 -04:00
Laurent Raufaste 7a2a01f9de ACL doc clarification
Fixes #443
2014-10-30 21:44:23 -04:00
Ryan Uber c751a4ff5f website: fix JSON in multiple checks documentation 2014-10-27 11:58:01 -07:00
Ryan Uber 95fa599937 website: update docs for multiple checks in config 2014-10-26 13:25:48 -07:00
Alexander Simmerl ad4598959e Add multiple service definition support
This change-set adds another key to the configuration decoding called
`services`, which is expected to be a list of service definitions. It
follows the established convention of only allowing one of the keys:
`service`, `check`, `services`. For every entry in the list it calls
the corresponding decode method and appends it to the Servics of the
resulting Config.

While a similar result could be achieved with changing the Services
member of the Config struct to have named mapstruct tag it lacks the
proper time conversions provided by DecodeServiceDefinition.
2014-10-23 22:50:40 -04:00
Armon Dadgar df43c42c94 website: Fixing formatting 2014-10-23 17:14:40 -07:00
Armon Dadgar 2b2f9980fb Merge pull request #427 from blalor/agent_http_links
website: Improve navigability of agent HTTP API categories
2014-10-23 16:46:58 -07:00
Ryan Uber d83053e8ab website: document retry_join and retry_interval flags for config file 2014-10-23 16:40:49 -07:00
Brian Lalor d2985d3c04 Add links for status endpoints 2014-10-23 07:59:58 -04:00
Brian Lalor 3082b3f95f Add links for event endpoints 2014-10-23 07:59:05 -04:00
Brian Lalor d45fdd15dd Add links for ACL endpoints 2014-10-23 07:57:55 -04:00
Brian Lalor 39e44c7968 Add links for session endpoints 2014-10-23 07:56:28 -04:00
Brian Lalor 9a29e1b60e Add links for health endpoints 2014-10-23 07:54:46 -04:00
Brian Lalor 4401fbf0e3 Add links for catalog endpoints 2014-10-23 07:53:11 -04:00
Brian Lalor 3ecb9ec8df Add links for agent endpoints 2014-10-23 07:50:54 -04:00
Brian Lalor 4ca29beec3 Improve navigability of agent HTTP API categories 2014-10-23 07:44:20 -04:00
Leo Cassarani d43a89fdd7 Fix spelling of "separator" in the HTTP API docs 2014-10-23 12:31:41 +01:00
Seth Vargo e265ea050d Use new Markdown syntaxes and add SEO descriptions 2014-10-19 19:42:13 -04:00
Seth Vargo e90f3ce442 Use codeblocks for code 2014-10-19 19:41:11 -04:00
Armon Dadgar 2c1add1c67 Merge pull request #396 from ryanuber/f-retry-join
agent: Retry failed joins on agent start
2014-10-13 10:46:10 -07:00
Ryan Uber 984ea76e6b website: document retry join 2014-10-12 12:31:47 -07:00
Theo Hultberg c78bd6db63 Fix mistake in the watches documentation 2014-10-11 17:04:52 +02:00
Alex Wheeler 5917aa0e20 Added the dns_config option enable_truncate to the docs. 2014-09-30 15:31:28 -04:00
Armon Dadgar 4037f7c41c website: fixing formatting 2014-09-24 16:59:43 -07:00
Sneha More baa08454be removed repeated 'can' 2014-09-18 11:11:00 +05:30
lalyos 430885595d json sample fixed for PUT /v1/acl/create 2014-09-06 01:55:38 +02:00
Armon Dadgar 8846068455 website: Documenting new options 2014-09-02 14:36:25 -07:00
Armon Dadgar 9035e2d6b7 website: document addresses config 2014-09-02 12:49:52 -07:00
Armon Dadgar 47e30adf13 agent: statsd support. Fixes #247 2014-09-02 11:26:17 -07:00
Armon Dadgar ea20cabc0f website: Updating docs 2014-09-01 15:03:37 -07:00
Joseph Anthony Pasquale Holsten 6d382465b8 alphabetize config options in docs. Fixes #221 2014-08-31 02:03:01 +00:00
Joonas Bergius 8c178e5793 Fixed a small typo 2014-08-28 22:23:01 -04:00
Armon Dadgar 87c4e22f03 website: typo fixes 2014-08-28 17:54:58 -07:00
Armon Dadgar 2f8948fe89 website: Adding docs 2014-08-28 17:22:56 -07:00
Armon Dadgar b6279be742 website: Document node lifecycle. Fixes #282. 2014-08-22 15:54:48 -07:00
Armon Dadgar 168ddedcee agent: Support encrypt CLI flag. Fixes #245. 2014-08-22 15:08:15 -07:00
Armon Dadgar 2cde3678ea website: Document client auth for TLS. Fixes #255. 2014-08-22 15:00:07 -07:00
Armon Dadgar 3944e2f276 website: Document data dir requirements. Fixes #264. 2014-08-22 14:58:10 -07:00
Armon Dadgar 84cfa31f2e website: Minor cleanups 2014-08-21 17:35:05 -07:00
Armon Dadgar 60a50301db website: Document watches 2014-08-21 17:25:42 -07:00
Armon Dadgar de89031c1a website: Fixing docs 2014-08-19 10:02:43 -07:00
Armon Dadgar 98b83d9c0d Merge pull request #288 from gmr/rfc-2782-srv-lookups
Add RFC-2782 style SRV lookups
2014-08-18 16:01:18 -07:00
Armon Dadgar ea0a1dca2e website: ACL internals 2014-08-18 15:46:59 -07:00
Armon Dadgar 8c5ae92fa7 website: Documenting ACL endpoints 2014-08-18 15:46:59 -07:00
Armon Dadgar f6eaa3b2fd website: document configuration 2014-08-18 15:46:58 -07:00
Gavin M. Roy 97b8960bd8 Add RFC-2782 style SRV lookups 2014-08-18 15:45:56 -04:00
Armon Dadgar 2e56d505c0 website: More port use docs 2014-08-05 10:46:52 -07:00
Laurent Raufaste 1ea4eacbc5 Some breath 2014-08-03 20:52:36 -04:00
Laurent Raufaste edb6de1e3e Add a ports used section to the doc 2014-08-03 20:51:43 -04:00
Armon Dadgar 2906b7f439 website: Clarify the ?pretty docs 2014-08-01 13:38:03 -07:00
Eric Connell ec8e271804 updated website documentation with the "pretty" parameter 2014-08-01 14:16:21 -06:00
William Tisäter 29fdfb0f43 Short doc note about DNS case-insensitivity 2014-07-23 23:42:22 +02:00
Armon Dadgar 8b8184d942 website: remove old docs on the -encrypt flag 2014-07-15 09:50:49 -07:00
Nelson Elhage c505b49bf8 There is no -statsite command-line flag. 2014-07-10 18:06:36 -07:00
Ben Scofield 14e282dca8 Improve clarity around changing the -client param
This is a small change that (IMO) makes more explicit the effect
of changing `-client` -- namely, that you'll have to provide
`-rpc-addr` to every other consul command you run.
2014-07-02 21:21:37 +02:00
Armon Dadgar 358b473e01 Updating documentation for new bootstrap method 2014-07-01 15:02:26 -07:00
Philip K. Warren 6e9af77bff Fix a small typo in RPC docs. 2014-06-19 13:53:43 -05:00
Armon Dadgar 91373968a8 Adding server_name configuration for TLS 2014-06-13 11:10:27 -07:00
Rob Holland 7309cbadb9 Improve clarity of ?keys behaviour.
I read the previous version initially as meaning that it would return a list of keys which have no value set, which I couldn't understand. I think this removes some ambiguity.
2014-06-13 12:20:24 +01:00
Armon Dadgar 90cababb0b website: Mention reload command in addition to SIGHUP 2014-06-11 11:03:59 -07:00
Armon Dadgar 4952923ced website: Document reload RPC command 2014-06-11 10:54:36 -07:00
Armon Dadgar 648429288e agent: Adding SyslogFacility configuration 2014-06-11 10:18:19 -07:00
Armon Dadgar 2568918055 website: Document the check_update_interval config 2014-06-09 12:51:12 -07:00
Armon Dadgar 9e925bf458 consul: Adding support for optional session name 2014-06-09 11:42:28 -07:00
Armon Dadgar 2c63d17e79 Merge pull request #200 from hashicorp/f-dns
Adding support for DNS TTLs and stale reads
2014-06-09 11:13:47 -07:00
Armon Dadgar 0b87eb29de website: clarify unique per-ndoe 2014-06-08 17:31:44 -07:00
Armon Dadgar 3af3f40434 website: Documenting DNS settings 2014-06-08 17:26:41 -07:00
David Pelaez 78704a769c Fix typo in check update endpoints
The current website says that you can send output with the update of a check using the `?node` parameter. It wasn't working and I check [the source](3874498374/command/agent/agent_endpoint.go (L110)) to find that it was (the more logical noun of) note! I changed the indication to replace `?node` for `?note`
2014-06-04 22:55:17 -05:00
Armon Dadgar 1ac127b73e agent: Omit certains keys from the /self endpoint 2014-05-29 11:24:37 -07:00
William Tisäter ead134c890 Return both member and config in /v1/agent/self 2014-05-28 00:09:28 +02:00
William Tisäter a028c3ae93 Add /v1/agent/self and return local agent config 2014-05-27 01:15:33 +02:00
Armon Dadgar d42474a7cb Support wildcard for check lookup. Fixes #152 2014-05-21 12:45:12 -07:00
Armon Dadgar 5fa10c912e Support rejoin after leave. Fixes #110. 2014-05-21 12:32:24 -07:00
Armon Dadgar 9f2631f383 agent: syslog support. Fixes #105. 2014-05-21 12:06:03 -07:00
Armon Dadgar ce5470cbc2 agent: Support for raw key lookup. Fixes #150. 2014-05-20 16:53:43 -07:00
Armon Dadgar bd4d338678 website: Document DNS truncation. Fixes #144. 2014-05-20 16:43:44 -07:00
Armon Dadgar 9c5fca1a3e website: Document KV changes 2014-05-20 16:25:30 -07:00
Armon Dadgar 2129b9d592 website: Documenting the session endpoints 2014-05-20 16:25:30 -07:00
Armon Dadgar 14a84f4a4f agent: Support -advertise cli flag. Fixes #156. 2014-05-16 10:49:55 -07:00
Carl Jackson 81eac87031 s/direclty/directly/ 2014-05-08 17:48:29 -07:00
Armon Dadgar 1543696e03 website: mention client_addr 2014-05-08 13:44:59 -07:00
Armon Dadgar 01e085cc64 agent: Correct spelling of separator. Fixes #101. 2014-05-07 15:25:17 -07:00
Armon Dadgar fe35d55663 website: update docs, CLI flag no longer available 2014-05-07 15:11:56 -07:00
Nelson Elhage 8505ee7372 docs: The config key is "encrypt", not "encrypt_key" 2014-05-07 15:04:50 -07:00
William Tisäter 1591c4d393 Merge pull request #128 from carlosdp/pid-file
Add pid-file flag to agent
2014-05-06 19:57:12 +02:00
Armon Dadgar 65c0069872 website: improve the docs for the agent TTL endpoints 2014-05-06 10:44:42 -07:00
Carlos Diaz-Padron 511c1c0273 Add pid-file option to agent docs 2014-05-05 23:39:26 -04:00
Armon Dadgar a67209f6ab website: Fixing old reference to dns_addr 2014-05-04 13:26:21 -07:00
Shayan Pooya 48f947386b website: fix a couple of typos. 2014-05-03 19:16:55 -04:00
Armon Dadgar 1636abd125 website: Document the KV API changes 2014-04-30 23:44:27 -04:00
Armon Dadgar a70361282e website: Document the ui-dir flags 2014-04-30 23:43:56 -04:00
Gavin M. Roy c90975405a Revert the interval and TTL values 2014-04-30 15:46:20 -04:00
Gavin M. Roy ab2e3bf0f5 Minor documentation fixes
- Correct spotted typos
- Ran JSON snippets through jsonpp for consistent display of JSON results
- Unfortunately my editor stripped EOL whitespace so there's a bit of whitespace diff
2014-04-30 15:26:07 -04:00
Masahito Zembutsu ce8a5490f2 fix typo 2014-04-25 23:09:17 +09:00
Armon Dadgar 9175a4e7c3 website: Adding the output key to docs examples 2014-04-21 16:21:52 -07:00
Armon Dadgar 0e9f5019ad website: typo fix 2014-04-21 16:09:36 -07:00
Armon Dadgar d6b7dd5b62 agent: Support server-side filtering of passing checks. Fixes #57. 2014-04-21 16:08:26 -07:00
Armon Dadgar 6de3ddfd93 website: Document HTTP changes 2014-04-21 13:40:16 -07:00
Armon Dadgar 3da9d53ab2 website: Typo. Fixes #43. 2014-04-17 11:31:25 -07:00
Jacques Fuentes dd6f55ff3b Round 2: Fix typos, grammar errors, and misspellings 2014-04-16 00:01:12 -04:00
Armon Dadgar 32eb65316f agent: Adding support for -join flag. Fixes #33. 2014-04-11 16:59:16 -07:00
Armon Dadgar 5f52dfbf05 website: Document the port configurations 2014-04-11 16:31:33 -07:00
Armon Dadgar 13417cb333 website: Documentation cleanup 2014-04-11 16:23:16 -07:00
Armon Dadgar 911ce92cf3 website: Documentation cleanup 2014-04-09 11:06:27 -07:00
Armon Dadgar 549e78e005 website: Clarify the DNS documentation 2014-04-08 12:18:05 -07:00
Armon Dadgar 002b9018a1 website: More info on TLS encryption 2014-04-07 15:07:21 -07:00
Armon Dadgar c452b19267 website: Document new TLS flags 2014-04-07 15:07:00 -07:00
Armon Dadgar 83952c51a0 website: Mention that telemetry can be streamed 2014-04-04 14:55:23 -07:00
Armon Dadgar 8c6e544442 website: Correct some empty lists to null 2014-04-03 14:40:05 -07:00
Armon Dadgar 50eaefa03e website: Updating the tags documentation 2014-04-03 14:18:57 -07:00
Armon Dadgar 8d8754e7a8 website: Document the Key/Value API 2014-03-31 21:15:46 -07:00
Armon Dadgar 46a2c37852 agent: Support protocol version setting 2014-03-09 15:57:03 -07:00
Armon Dadgar 38317d4890 website: Documenting the info command 2014-02-23 17:09:59 -08:00
Armon Dadgar bdcbedafa5 website: document registering checks and services better. Fixes #6 2014-02-22 18:53:31 -08:00
Armon Dadgar b4143c82ea website: Clarify the ?index parameter. Fixes #7 2014-02-22 18:47:09 -08:00
Armon Dadgar 85091090c6 agent: Switch to -data-dir, better error if missing. Fixes #2. 2014-02-22 17:34:57 -08:00
Armon Dadgar 981e58e8e9 agent: Adding support for statsite telemetry 2014-02-20 14:59:54 -08:00
Armon Dadgar 7c0b73550c website: finish the HTTP documentation 2014-02-19 14:27:01 -08:00
Armon Dadgar 4b490b3a83 website: working on documenting http api 2014-02-19 12:05:18 -08:00
Armon Dadgar 1924f73449 website: document the DNS interface 2014-02-19 11:05:42 -08:00
Armon Dadgar 1eb51ee663 website: document checks and services 2014-02-18 18:05:18 -08:00
Armon Dadgar ed2622d0c8 website: replacing serf references 2014-02-18 17:33:44 -08:00
Armon Dadgar a7e7bfdc62 website: working on docs 2014-02-18 15:30:07 -08:00
Armon Dadgar 0611db496a website: bulk copy from serf 2014-02-07 16:41:03 -08:00