Commit Graph

1271 Commits

Author SHA1 Message Date
Jack Pearkes 559d35156a
Merge pull request #3929 from sryabkov/patch-1
Highlighting the dead link in documentation
2018-03-19 16:00:32 -07:00
Josh Soref 94835a2715 Spelling (#3958)
* spelling: another

* spelling: autopilot

* spelling: beginning

* spelling: circonus

* spelling: default

* spelling: definition

* spelling: distance

* spelling: encountered

* spelling: enterprise

* spelling: expands

* spelling: exits

* spelling: formatting

* spelling: health

* spelling: hierarchy

* spelling: imposed

* spelling: independence

* spelling: inspect

* spelling: last

* spelling: latest

* spelling: client

* spelling: message

* spelling: minimum

* spelling: notify

* spelling: nonexistent

* spelling: operator

* spelling: payload

* spelling: preceded

* spelling: prepared

* spelling: programmatically

* spelling: required

* spelling: reconcile

* spelling: responses

* spelling: request

* spelling: response

* spelling: results

* spelling: retrieve

* spelling: service

* spelling: significantly

* spelling: specifies

* spelling: supported

* spelling: synchronization

* spelling: synchronous

* spelling: themselves

* spelling: unexpected

* spelling: validations

* spelling: value
2018-03-19 16:56:00 +00:00
Paul Banks 8871ad130d
Merge pull request #3961 from canterberry/docs/tls-cipher-suites
📝 Clarify the list of supported TLS cipher suites
2018-03-19 16:51:14 +00:00
Paul Banks 37c07b3cac
Use master 2018-03-19 16:50:52 +00:00
Devin Canterberry 961aea97fe
📝 Prefer brevity at the cost of some ambiguity 2018-03-15 10:25:27 -07:00
Devin Canterberry 1db58de366
⤵️ Merge from `master`; no conflicts 2018-03-15 09:13:01 -07:00
Jack Pearkes 6fb94ff40a website: clarify where ACL token is set in the UI 2018-03-14 16:50:04 -07:00
Jack Pearkes c66628a06f website: add section on securing the UI with ACLs
Figured it would be worth documenting due to #3931.
2018-03-14 16:46:04 -07:00
Jack Pearkes 652e821511
Merge pull request #3884 from rberlind/master
Updated Stale Reads section of DNS Caching Guide
2018-03-13 16:56:58 -07:00
Devin Canterberry 84d650cc4a
📝 Clarify the list of supported TLS cipher suites
Previously, the documentation linked to Golang's source code, which
can drift from the list of cipher suites supported by Consul. Consul
has a hard-coded mapping of string values to Golang cipher suites, so
this is a more direct source of truth to help users understand which
string values are accepted in the `tls_cipher_suites` configuration
value.
2018-03-13 09:25:03 -07:00
randall thomson 3b1a2af8f1
Update index.html.md
update cli commands for consul 1.x
2018-03-09 09:46:37 -08:00
Preetha 251cdb9c24
Some tweaks to the documentation for a_record_limit 2018-03-08 11:23:07 -06:00
Pierre Souchay 57310a6446 Updated documentation as requested by @preetapan 2018-03-08 18:02:40 +01:00
Sergei Ryabkov 82d195b695
Highlighting the dead link
I am proposing to remove a dead link (https://atlas.hashicorp.com/help/consul/alternatives). If the page has moved and the new location is known, it would be of course better to update the link.
2018-03-02 18:22:19 -05:00
Paul Banks 257ad520f2
Merge pull request #3928 from hashicorp/service-token-docs
Notes on ACL token storage and permissions
2018-03-02 16:28:56 +00:00
Paul Banks 9a47449c6d
Merge pull request #3899 from pierresouchay/fix_blocking_queries_index
Services Indexes modified per service instead of using a global Index
2018-03-02 16:24:43 +00:00
Paul Banks c57451a414
Notes on ACL token storage and permissions 2018-03-02 16:22:12 +00:00
Paul Banks e833b535a6
Notes on ACL token storage and permissions 2018-03-02 16:20:11 +00:00
Brian Shumate 6d92c28c5c Clarify encrypt key for WAN joined DCs 2018-03-02 10:41:09 -05:00
Pierre Souchay 7b81e2c3ad Better information and advices for upgrade to 1.0.7+ 2018-03-02 09:08:00 +01:00
Pierre Souchay 360dc1dd8d Simplified error handling for maxIndexForService
* added unit tests to ensure service index is properly garbage collected
* added Upgrade from Version 1.0.6 to higher section in documentation
2018-03-01 14:09:36 +01:00
Jack Pearkes 10f3eb623a website: override automatic linking of list items for softlayer dc
This avoids a conflict with #datacenter later on the page. We're mixing
histroic manually specified anchors with generated anchors (via
redcarpet / middleman-hashicorp) so we have to manually override the
automatic generation here.

I was tempted to rewrite the old manual anchors to use the automatic
generation, but there is no way to maintain backwards compatibility,
so will leave that for a time when it is appropriate for us to break
links (or redirect them, etc).

Fixes #3916
2018-02-27 10:53:12 -08:00
Paul Banks a216d136fe
Fix a couple of minor typos found in docs. 2018-02-13 16:21:12 +00:00
Roger Berlind bad4f2f404
Updated Stale Reads section of DNS Caching Guide
I updated the content based on discussion with James Phillips in #team-connect on 2/8/2018.
2018-02-12 11:26:10 -05:00
Kyle Havlovitz f6ecaa4a1c
Add enterprise default config section 2018-02-05 13:33:59 -08:00
James Phillips e748c63fff
Merge pull request #3855 from hashicorp/pr-3782-slackpad
Adds support for gRPC health checks.
2018-02-02 17:57:27 -08:00
James Phillips 49772f93bb
Adds documentation for gRPC health checks. 2018-02-02 17:53:49 -08:00
Preetha 6d969d372b
Clarification around locking (#3853) 2018-02-01 14:08:06 -06:00
Jim Kalafut cedc7e6119
Fix broken link to SWIM paper 2018-01-21 17:41:58 -08:00
James Phillips d93eb3659c
Updates configuration docs for Azure VMSS support. 2018-01-19 16:37:22 -08:00
James Phillips 410e96108a
Update external.html.md 2018-01-12 13:23:16 -08:00
James Cunningham 8dfe140501 fix dead telemetry prefix filter link 2018-01-05 15:19:33 -07:00
James Phillips 10ff52c21c
Merge pull request #3765 from diptanu/f-agent-telemetry
Added telemetry around Catalog APIs
2018-01-04 18:56:26 -08:00
Chad Whitacre 7dbe5654c7 Fix some small doc errors 2018-01-04 16:44:07 -05:00
Bastien Gérard 967a1de1ed fix in documentation 2017-12-31 09:48:16 +01:00
Diptanu Choudhury 3858317ac9 Updated docs 2017-12-21 20:37:13 -08:00
Diptanu Choudhury 7f28391cbf Added docs 2017-12-21 16:58:39 -08:00
James Phillips e0dd7cc152
Merge pull request #3740 from yfouquet/issue_3709
Update documentation for "serf_lan_bind" and "serf_wan_bind"
2017-12-14 17:49:38 -08:00
Tomas Celaya 36ea244ced Include a warning about the interaction between `translate_wan_addrs` and `bind_addr` in the Basic WAN guide. 2017-12-14 13:12:04 -08:00
Yoann Fouquet 715dd744ff Update documentation for "serf_lan_bind" and "serf_wan_bind"
These was spotted in issue #3709.
These two configuration elements were renamed "serf_lan" and "serf_wan" in commit 12216583a1
Update documentation to fit the new code.
Note that flags "-serf-lan-bind" and "-serf-wan-bind" were not renamed.
2017-12-12 13:55:19 +01:00
Ivan Smirnov db1623c44f
Fix syntax error.
Running consul 1.0.0, 'consul operator raft' requires 'list-peers' rather than '-list-peers'
2017-11-20 20:17:20 -08:00
James Phillips b4d19abb7c
Adds a version note about rolling updates. 2017-11-20 12:01:23 -08:00
James Phillips 93f68555d0
Adds enable_agent_tls_for_checks configuration option which allows (#3661)
HTTP health checks for services requiring 2-way TLS to be checked
using the agent's credentials.
2017-11-07 18:22:09 -08:00
James Phillips d85dfffcae
Update atlas.html.md 2017-11-02 14:16:47 -07:00
James Phillips c488b870b6
Update coordinates.html.md 2017-10-31 21:23:51 -07:00
Frank Schröder 874e350b2f config: add -config-format option (#3626)
* config: refactor ReadPath(s) methods without side-effects

Return the sources instead of modifying the state.

* config: clean data dir before every test

* config: add tests for config-file and config-dir

* config: add -config-format option

Starting with Consul 1.0 all config files must have a '.json' or '.hcl'
extension to make it unambigous how the data should be parsed. Some
automation tools generate temporary files by appending a random string
to the generated file which obfuscates the extension and prevents the
file type detection.

This patch adds a -config-format option which can be used to override
the auto-detection behavior by forcing all config files or all files
within a config directory independent of their extension to be
interpreted as of this format.

Fixes #3620
2017-10-31 17:30:01 -05:00
Frank Schröder a052255f86 vendor: update go-discover (#3634)
* vendor: update go-discover

Pull in providers:

 * Aliyun (Alibaba Cloud)
 * Digital Ocean
 * OpenStack (os)
 * Scaleway

* doc: use ... instead of xxx

* doc: strip trailing whitespace

* doc: add docs for aliyun, digitalocean, os and scaleway

* agent: fix test
2017-10-31 17:03:54 -05:00
James Phillips a11c277f75
Changes "ip" to "IP". 2017-10-23 12:34:43 +02:00
Frank Schroeder 81917ee675
Merge pull request #3600 from hashicorp/support-go-sockaddr-for-dns-recursors
DNS recursors can be added through go-sockaddr templates. Entries
are deduplicated while the order is maintained.

Originally proposed by @taylorchu

See #2932
2017-10-23 10:45:36 +02:00
Frank Schroeder 0ca94055c4
Revert "doc: update docs for dns recursor go-sockaddr templates"
This reverts commit 6d4a57aedc.
2017-10-23 10:08:35 +02:00
Frank Schroeder 42563dc73f
Revert "doc: address review comment"
This reverts commit 6ba9690e81.
2017-10-23 10:08:35 +02:00
Frank Schroeder 703be5a219
Revert "Changes "ip" to "IP"."
This reverts commit dca5dcb68c.
2017-10-23 10:08:35 +02:00
James Phillips dca5dcb68c Changes "ip" to "IP". 2017-10-23 08:01:25 +02:00
Frank Schroeder 6ba9690e81 doc: address review comment 2017-10-23 08:01:25 +02:00
Frank Schroeder 6d4a57aedc doc: update docs for dns recursor go-sockaddr templates 2017-10-23 08:01:25 +02:00
James Phillips 3ab8b50133
Tweaks watch docs. 2017-10-21 20:09:37 -07:00
preetapan bed69cefb2 Update watches.html.md 2017-10-21 20:59:47 -05:00
Preetha Appan 28a3901f10 Small grammar correction 2017-10-21 20:55:15 -05:00
Preetha Appan cdb5f8c3c9 Improve HTTP handler documentation 2017-10-21 20:51:37 -05:00
Hadar Greinsmark 7e1a860978 Implement HTTP Watch handler (#3413)
Implement HTTP Watch handler
2017-10-21 20:39:09 -05:00
Frank Schroeder 8ad8331f7d
doc: address review comment 2017-10-20 20:06:33 +02:00
Frank Schroeder 2122f16a69
doc: update docs for dns recursor go-sockaddr templates 2017-10-20 15:51:49 +02:00
Johan Brandhorst 4ebdff30ef Fixed indentation in Script + Interval
Remove newlines which were causing the text to not be rendered under the intended bullet point.
2017-10-20 14:02:31 +02:00
James Phillips ecee15b466
Updates documentation for consul validate.
This makes it clear that you need to pass the full configuration,
and that the command won't work with config fragments.

Closes #3591
2017-10-19 18:59:05 -07:00
Preetha Appan 18ccd3a80b Documentation update for KMS support 2017-10-19 11:39:14 -05:00
Preetha Appan 89b98d2fe2 Update autopilot documentation to mention correct Consul version that defaults raft protocol to 3. 2017-10-19 11:31:29 -05:00
Jay 4d95a56b43 s/acesss/access (#3593)
Spell "access" correctly
2017-10-18 17:24:56 -07:00
Christopher "Chief" Najewicz 0b710b4a7a Update docs for retry_join cloud discovery to include snippet around (#3577)
using HTTP_PROXY, HTTPS_PROXY and NO_PROXY env vars when needed
2017-10-17 16:05:44 -07:00
James Phillips d5b945ccee
Adds a note about the Raft protocol not being the same as the Consul protocol. 2017-10-13 16:54:48 -07:00
James Phillips 204e6bac18
Adds a 1.0 section to the upgrade guide and cleans up the change log. 2017-10-13 16:46:36 -07:00
James Phillips 036efc663d Update sentinel.html.markdown.erb 2017-10-13 12:15:08 -07:00
csawyerYumaed 0f79922795 Update dns forwarding documentation (#3574)
Add details about setting up macOS to point to consul for services without the headache of dnsmasq, bind, etc.
2017-10-12 14:25:57 -07:00
Kyle Havlovitz 4ab59af09e
Clarify the docs around script check timeout behavior 2017-10-11 14:55:55 -07:00
Kyle Havlovitz 106b8b0b33 Kill check processes after the timeout is reached (#3567)
* Kill check processes after the timeout is reached

Kill the subprocess spawned by a script check once the timeout is reached. Previously Consul just marked the check critical and left the subprocess around.

Fixes #3565.

* Set err to non-nil when timeout occurs

* Fix check timeout test

* Kill entire process subtree on check timeout

* Add a docs note about windows subprocess termination
2017-10-11 11:57:39 -07:00
Frank Schröder 94f58199b1 agent: add option to discard health output (#3562)
* agent: add option to discard health output

In high volatile environments consul will have checks with "noisy"
output which changes every time even though the status does not change.
Since the output is stored in the raft log every health check update
unblocks a blocking call on health checks since the raft index has
changed even though the status of the health checks may not have changed
at all. By discarding the output of the health checks the users can
choose a different tradeoff. Less visibility on why a check failed in
exchange for a reduced change rate on the raft log.

* agent: discard output also when adding a check

* agent: add test for discard check output

* agent: update docs

* go vet

* Adds discard_check_output to reloadable config table.

* Updates the change log.
2017-10-10 17:04:52 -07:00
Frank Schröder 759ef8a1d4 config: add generic method to translate between CamelCase and snake_case (#3557)
* doc: document discrepancy between id and CheckID

* doc: document enable_tag_override change

* config: add TranslateKeys helper

TranslateKeys makes it easier to map between different representations
of internal structures. It allows to recursively map alias keys to
canonical keys in structured maps.

* config: use TranslateKeys for config file

This also adds support for 'enabletagoverride' and removes
the need for a separate CheckID alias field.

* config: remove dead code

* agent: use TranslateKeys for FixupCheckType

* agent: translate enable_tag_override during service registration

* doc: add '.hcl' as valid extension

* config: map ScriptArgs to args

* config: add comment for TranslateKeys
2017-10-10 16:40:59 -07:00
James Phillips bb12368eac Makes RPC handling more robust when rolling servers. (#3561)
* Adds client-side retry for no leader errors.

This paves over the case where the client was connected to the leader
when it loses leadership.

* Adds a configurable server RPC drain time and a fail-fast path for RPCs.

When a server leaves it gets removed from the Raft configuration, so it will
never know who the new leader server ends up being. Without this we'd be
doomed to wait out the RPC hold timeout and then fail. This makes things fail
a little quicker while a sever is draining, and since we added a client retry
AND since the server doing this has already shut down and left the Serf LAN,
clients should retry against some other server.

* Makes the RPC hold timeout configurable.

* Reorders struct members.

* Sets the RPC hold timeout default for test servers.

* Bumps the leave drain time up to 5 seconds.

* Robustifies retries with a simpler client-side RPC hold.

* Reverts untended delete.
2017-10-10 15:19:50 -07:00
James Phillips d8a1ec70f8 Update compatibility.html.md 2017-10-09 14:18:37 -07:00
James Phillips 486e1a277e Update compatibility.html.md 2017-10-09 14:18:23 -07:00
Radek Simko 0075421b1a docs: agent/options gcp's project_name is optional
Per https://github.com/hashicorp/go-discover/blob/master/provider/gce/gce_discover.go#L53-L61
2017-10-08 13:08:50 +02:00
Preetha Appan 194b09a86b Update documentation with subcommand example 2017-10-06 15:23:43 -05:00
Preetha Appan 84ee8b8aff Autocomplete support 2017-10-06 15:05:45 -05:00
Kyle Havlovitz adf29675f3 Merge pull request #3535 from hashicorp/metric-docs
Update metric names and add a legacy config flag
2017-10-04 17:39:16 -07:00
Kyle Havlovitz 766d1259d8
Move http request metric to the agent section 2017-10-04 17:36:10 -07:00
Kyle Havlovitz a3e9ac5840
Add a test for legacy metrics with a whitelist filter 2017-10-04 17:27:57 -07:00
Kyle Havlovitz 198ed6076d Clean up subprocess handling and make shell use optional (#3509)
* Clean up handling of subprocesses and make using a shell optional

* Update docs for subprocess changes

* Fix tests for new subprocess behavior

* More cleanup of subprocesses

* Minor adjustments and cleanup for subprocess logic

* Makes the watch handler reload test use the new path.

* Adds check tests for new args path, and updates existing tests to use new path.

* Adds support for script args in Docker checks.

* Fixes the sanitize unit test.

* Adds panic for unknown watch type, and reverts back to Run().

* Adds shell option back to consul lock command.

* Adds shell option back to consul exec command.

* Adds shell back into consul watch command.

* Refactors signal forwarding and makes Windows-friendly.

* Adds a clarifying comment.

* Changes error wording to a warning.

* Scopes signals to interrupt and kill.

This avoids us trying to send SIGCHILD to the dead process.

* Adds an error for shell=false for consul exec.

* Adds notes about the deprecated script and handler fields.

* De-nests an if statement.
2017-10-04 16:48:00 -07:00
Kyle Havlovitz c728564994
Update metric names and add a legacy config flag 2017-10-04 16:43:27 -07:00
Frank Schroeder 2191511e9f doc: drop last references to -retry-join-* options 2017-10-04 19:12:28 +02:00
Frank Schroeder 012ec7876e doc: document go-discover format change 2017-10-04 19:12:28 +02:00
Preetha Appan 41ec69f71a Update ACL guide to describe the new list policy for Keys 2017-10-04 06:19:20 -05:00
Kyle Havlovitz 93bf819c36
Update snapshot agent docs 2017-09-29 12:28:04 -07:00
Frank Schroeder b0b84604fc update docs 2017-09-29 20:26:43 +02:00
Preetha Appan 9b3481265a Fix grammar in containers guide. 2017-09-29 10:37:04 -05:00
Preetha Appan 2c684ebb51 Update containers guide to mention that Consul now handles nodes changing IP addresses. 2017-09-29 10:20:33 -05:00
James Phillips 1181ab0d11 Clarifies server requirement for bootstrap-expect.
Fixes #3510.
2017-09-28 22:02:37 -07:00
Preetha Appan 54bb478372 Update sentinel documentation to remove features that are coming in a future release 2017-09-28 21:00:00 -05:00
Patrick Sodré fa67334361
Update docs on RFC1464 vs RFC1035 options 2017-09-28 12:32:46 +02:00
Patrick Sodré 8e14b527e8
Update docs to include support for TXT records
- Add explanation to the difference between RFC1035
    and RFC1464 queries.
2017-09-28 12:32:42 +02:00
James Phillips 38b2d76d39 Update options.html.md 2017-09-27 15:55:46 -07:00
James Phillips 5fa5f6ef01 Update options.html.md 2017-09-27 15:40:00 -07:00