Commit Graph

1488 Commits

Author SHA1 Message Date
Paul Banks 24b60ba77a
Acl upgrade guide (#4880)
* Very WIP upgrade docs. Actual Upgrade notes doneish; token migration guide WIP.

* Token migration guide

* Complete ACL migration guide

* Upgrade guide cleanup

* Updated upgrade and migration guides

* Typo fix

Co-Authored-By: banks <banks@banksco.de>

* Update website/source/docs/guides/acl-migrate-tokens.html.md

Co-Authored-By: banks <banks@banksco.de>

* Update website/source/docs/guides/acl-migrate-tokens.html.md

Co-Authored-By: banks <banks@banksco.de>

* Update upgrade-specific.html.md

* Update website/source/docs/guides/acl-migrate-tokens.html.md

* Update website/source/docs/guides/acl-migrate-tokens.html.md

* Note Multi-DC changes in upgrade guide.

* Update website/source/docs/upgrade-specific.html.md
2018-11-14 15:40:02 +00:00
Jack Pearkes a90c29e60d Doc changes for 1.4 Final (#4870)
* website: add multi-dc enterprise landing page

* website: switch all 1.4.0 alerts/RC warnings

* website: connect product wording

Co-Authored-By: pearkes <jackpearkes@gmail.com>

* website: remove RC notification

* commmand/acl: fix usage docs for ACL tokens

* agent: remove comment, OperatorRead

* website: improve multi-dc docs

Still not happy with this but tried to make it slightly more informative.

* website: put back acl guide warning for 1.4.0

* website: simplify multi-dc page and respond to feedback

* Fix Multi-DC typos on connect index page.

* Improve Multi-DC overview.

A full guide is a WIP and will be added post-release.

* Fixes typo avaiable > available
2018-11-13 13:43:53 +00:00
Rebecca Zanzig 8ca4e56db1 Update the helm chart `join` instructions
This fixes some previous incorrect information about the join feature
in the Helm chart. Based on the fix for consul-helm issue 59.
2018-11-12 12:22:18 -08:00
Kyle Havlovitz 4a73a59d70
Merge pull request #4917 from hashicorp/replication-token-cleanup
Use acl replication_token for connect
2018-11-12 09:12:54 -08:00
Rebecca Zanzig b6cb8ea6ef Update docs for Helm chart `maxUnavailable` value
Due to a Helm templating limitation, setting this value to `0` requires
an extra flag when installing. This adds information about that.
2018-11-09 16:58:54 -08:00
Rebecca Zanzig 72e5c4c621
Merge pull request #4928 from hashicorp/docs/server-affinity
Add documentation of server affinity Helm chart variable
2018-11-09 12:37:33 -08:00
R.B. Boyer b153f9be39
docs: use hcl heredoc syntax for multi line strings in sentinel examples (#4930) 2018-11-08 16:28:40 -06:00
Rebecca Zanzig db6c5d1b20 Add doc info for added server affinity value
Supports newly added functionality to the Helm chart.
2018-11-08 12:07:30 -08:00
Rebecca Zanzig 140a1edcea Reorder Helm chart server values
This matches the ordering in the Helm chart, to make it easier for
users to find information.
2018-11-08 12:06:00 -08:00
R.B. Boyer 2a8951fcc0
docs: remove curly quotes from shell block (#4921) 2018-11-07 10:42:13 -08:00
Kyle Havlovitz 9c09d66028
Merge pull request #4912 from hashicorp/acl-doc-fixes
docs: fix some examples in the new ACL guide
2018-11-07 09:23:36 -08:00
Kyle Havlovitz 6354996804
docs: remove leftover typo from replication_token info 2018-11-07 09:22:23 -08:00
Kyle Havlovitz 62691ebc82
config: remote connect replication_token 2018-11-07 02:15:37 -08:00
Kyle Havlovitz aec362d06c docs: fix some examples in the new ACL guide 2018-11-06 18:47:44 -08:00
Mike Pettypiece 77165c1588 Update consul CLI docs for kv export and import
This will make the kv docs consistent with get/delete/put
2018-11-06 20:19:09 -05:00
Rebecca Zanzig 2c8675565d
Merge pull request #4900 from hashicorp/docs/helm-extension
Document options for additional helm chart configuration
2018-11-06 15:39:40 -08:00
Rebecca Zanzig 971f3fb433
Merge pull request #4891 from hashicorp/docs/k8s-storage
Clarify storage usage for consul + k8s
2018-11-05 12:45:22 -08:00
Rebecca Zanzig 638a5ff7a1 Document options for additional helm chart configuration
There is a fine line between making the helm chart easy and simple to
use and supporting lots of configurability. This documents options for
users who would like to extend the Helm chart beyond what is readily
available in the `values.yaml` file.
2018-11-05 12:20:14 -08:00
Rebecca Zanzig ea6e5c8945 Clarify storage usage for consul + k8s
This adds two Helm chart values into the documentation with details
that have come up in several issues.

Additionally, it notes that persistent volumes and their claims need
to be removed manually because of current kubernetes and helm design.
2018-11-05 10:50:41 -08:00
R.B. Boyer 9211d2701d
fix comment typos (#4890) 2018-11-02 12:00:39 -05:00
Geoffrey Grosenbach 3981c5d48c Adds redirects and updates links for learn.hashicorp (#4878)
* Adds redirects for Getting Started pages

* Uses correct links to resources at learn.hashicorp

* Reconfigures "Learn more" links to point to learn.hashicorp

* Links to learn.hashicorp on segmentation page

* Adds redirect for sample config file

* Fixes links to Getting Started guide on learn.hashicorp

* Remove getting started guide which is now on learn.hashicorp

* Corrects link to `consul/io` which should go to `consul.io`

* Revert "Remove getting started guide which is now on learn.hashicorp"

This reverts commit 2cebacf402f83fb936718b41ac9a27415f4e9f21 so a placeholder
message can be written here while we are transitioning content to
learn.hashicorp

* Adding a new page for getting started to direct users to learn.

* Added a note at the being of each doc to notify users about the temporary repo change.

* Revert "Added a note at the being of each doc to notify users about the temporary repo change."

This reverts commit 9a2a8781f9705028e4f53f758ef235e74b2b7198.

From conversation at https://github.com/hashicorp/consul/pull/4878

* Removes redirect from sample web.json demo file

* Removed typo
2018-11-01 14:44:49 -07:00
Anubhav Mishra 538973fc5e
Clarify sync wording.
Co-Authored-By: adilyse <rebecca@hashicorp.com>
2018-10-31 13:18:50 -07:00
Anubhav Mishra 98dcc32c53
Updating configuration wording.
Co-Authored-By: adilyse <rebecca@hashicorp.com>
2018-10-31 13:18:01 -07:00
Rebecca Zanzig 6e575b2671 Update Helm docs to include the `default` flag for catalog sync
Additionally fixes an issue with quotes on the related annotation.
2018-10-30 16:37:04 -07:00
Jack Pearkes 770d708494
website: clarify log file filename format (#4856)
Fixes #4697
2018-10-29 09:29:14 -07:00
Sébastien Portebois 1823a35325 website: broken partial rendering and missing id (#4862)
* Fix partial rendering in service command (CLI) help
* Fix sample JSON to be a valid json for service registration
* Add missing id field to make the complete document complete.
2018-10-29 01:41:25 -07:00
Martin Halder 988ceb697a website: fix minor typo in documentation (#4864) 2018-10-29 01:33:42 -07:00
Paul Banks 7742aec226 Correct prometheus docs (#4805) 2018-10-26 12:11:57 -07:00
Jack Pearkes a8c1ebe6fb
Fix some broken links in docs (#4858)
* website: let curl make noise during website deploy

* website: fix a handful of broken links
2018-10-26 10:55:12 -07:00
Rebecca Zanzig 7ad6596454
Merge pull request #4828 from hashicorp/docs/helm-16-getting-started
Update the `join` command format in the k8s Running Consul section
2018-10-25 15:47:14 -07:00
Rebecca Zanzig 0aec555d8f
Merge pull request #4854 from hashicorp/docs/k8s+helm
Add connectInject `image` info into helm docs
2018-10-25 15:07:36 -07:00
Hans Hasselberg 787e90cebc
website: sync guides list with guides sidebar. (#4831) 2018-10-25 12:07:26 -07:00
Rebecca Zanzig 6fb2134e96 Add connectInject `image` info into helm docs
This field was added back into the helm chart, but it was not added
back to the documentation. This adds it, then additionally fixes a
few typos in the same file.
2018-10-25 08:41:59 -07:00
Matt Keeler a02a6be6b9
Implement CLI token cloning & special ID handling (#4827)
* Implement CLI token cloning & special ID handling

* Update a couple CLI commands to take some alternative options.

* Document the CLI.

* Update the policy list and set-agent-token synopsis
2018-10-24 10:24:29 -04:00
Martin Logan 999cb0a49f website: Update deprecated script tag in example. (#4790)
Signed-off-by: Martin Logan <mlogan@fanatics.com>
2018-10-24 07:21:20 -07:00
Matt Keeler 2b4d3eabfe
Fix some uuids and make it clear that the SecretID is used for agent tokens (#4845) 2018-10-24 09:47:55 -04:00
Rebecca Zanzig 6b132da961 Update the `join` command format in the k8s Running Consul section
Based on info from consul-helm issue 16, the formatting of the helm
chart value for joining an external cluster needs to be specified
as a yaml array. This updates the documentation to reflect this.
2018-10-22 14:08:13 -07:00
Matt Keeler 1ac888aa8c ACL documentation (#4824)
* Updating the ACL guide.

* Update the docs correctly

* Finish updating the ACL docs - for now.
2018-10-19 13:26:31 -07:00
Matt Keeler 18b29c45c4
New ACLs (#4791)
This PR is almost a complete rewrite of the ACL system within Consul. It brings the features more in line with other HashiCorp products. Obviously there is quite a bit left to do here but most of it is related docs, testing and finishing the last few commands in the CLI. I will update the PR description and check off the todos as I finish them over the next few days/week.
Description

At a high level this PR is mainly to split ACL tokens from Policies and to split the concepts of Authorization from Identities. A lot of this PR is mostly just to support CRUD operations on ACLTokens and ACLPolicies. These in and of themselves are not particularly interesting. The bigger conceptual changes are in how tokens get resolved, how backwards compatibility is handled and the separation of policy from identity which could lead the way to allowing for alternative identity providers.

On the surface and with a new cluster the ACL system will look very similar to that of Nomads. Both have tokens and policies. Both have local tokens. The ACL management APIs for both are very similar. I even ripped off Nomad's ACL bootstrap resetting procedure. There are a few key differences though.

    Nomad requires token and policy replication where Consul only requires policy replication with token replication being opt-in. In Consul local tokens only work with token replication being enabled though.
    All policies in Nomad are globally applicable. In Consul all policies are stored and replicated globally but can be scoped to a subset of the datacenters. This allows for more granular access management.
    Unlike Nomad, Consul has legacy baggage in the form of the original ACL system. The ramifications of this are:
        A server running the new system must still support other clients using the legacy system.
        A client running the new system must be able to use the legacy RPCs when the servers in its datacenter are running the legacy system.
        The primary ACL DC's servers running in legacy mode needs to be a gate that keeps everything else in the entire multi-DC cluster running in legacy mode.

So not only does this PR implement the new ACL system but has a legacy mode built in for when the cluster isn't ready for new ACLs. Also detecting that new ACLs can be used is automatic and requires no configuration on the part of administrators. This process is detailed more in the "Transitioning from Legacy to New ACL Mode" section below.
2018-10-19 12:04:07 -04:00
Jack Pearkes 34d01e6254
website: minor notes about 1.4.0 (#4820) 2018-10-19 08:52:56 -07:00
Pierre Souchay fab55bee2b dns: implements prefix lookups for DNS TTL (#4605)
This will fix https://github.com/hashicorp/consul/issues/4509 and allow forinstance lb-* to match services lb-001 or lb-service-007.
2018-10-19 08:41:04 -07:00
Jack Pearkes bfa1a912ab website: note Envoy support in Nomad guide (#4787) 2018-10-19 08:41:03 -07:00
Jack Pearkes 8c684db488 New command: consul debug (#4754)
* agent/debug: add package for debugging, host info

* api: add v1/agent/host endpoint

* agent: add v1/agent/host endpoint

* command/debug: implementation of static capture

* command/debug: tests and only configured targets

* agent/debug: add basic test for host metrics

* command/debug: add methods for dynamic data capture

* api: add debug/pprof endpoints

* command/debug: add pprof

* command/debug: timing, wg, logs to disk

* vendor: add gopsutil/disk

* command/debug: add a usage section

* website: add docs for consul debug

* agent/host: require operator:read

* api/host: improve docs and no retry timing

* command/debug: fail on extra arguments

* command/debug: fixup file permissions to 0644

* command/debug: remove server flags

* command/debug: improve clarity of usage section

* api/debug: add Trace for profiling, fix profile

* command/debug: capture profile and trace at the same time

* command/debug: add index document

* command/debug: use "clusters" in place of members

* command/debug: remove address in output

* command/debug: improve comment on metrics sleep

* command/debug: clarify usage

* agent: always register pprof handlers and protect

This will allow us to avoid a restart of a target agent
for profiling by always registering the pprof handlers.

Given this is a potentially sensitive path, it is protected
with an operator:read ACL and enable debug being
set to true on the target agent. enable_debug still requires
a restart.

If ACLs are disabled, enable_debug is sufficient.

* command/debug: use trace.out instead of .prof

More in line with golang docs.

* agent: fix comment wording

* agent: wrap table driven tests in t.run()
2018-10-19 08:41:03 -07:00
Kyle Havlovitz c617326470 re-add Connect multi-dc config changes
This reverts commit 8bcfbaffb6.
2018-10-19 08:41:03 -07:00
Rebecca Zanzig 58fc4a7cbc Add additional formatting detail to the Helm `join` command
In response to consul-helm issue 16.
2018-10-17 12:53:44 -07:00
Jack Pearkes 8bcfbaffb6 Revert "Connect multi-dc config" (#4784) 2018-10-11 17:32:45 +01:00
danielehc 40017f5e59
Update creating-certificates.html.md (#4780)
In case `verify_server_hostname` is set in the configuration, Consul checks the certificate against  `server.<datacenter>.<domain>`.

The name suggested by the guide generates errors like the following:
```
2018/10/10 12:42:20 [ERR] consul: Failed to confirm peer status for consul-3: rpc error getting client: failed to get conn: x509: certificate is valid for server.node.consul.labs, localhost, not server.consul.labs. Retrying in 16s...
```

Removing the `node` part from the certificate permits them to work also when that option is set.
2018-10-11 14:23:51 +02:00
Aestek 25f04fbd21 [Security] Add finer control over script checks (#4715)
* Add -enable-local-script-checks options

These options allow for a finer control over when script checks are enabled by
giving the option to only allow them when they are declared from the local
file system.

* Add documentation for the new option

* Nitpick doc wording
2018-10-11 13:22:11 +01:00
Paul Banks f951dcfb9d
Be more explicit about rolling upgrade process 2018-10-11 11:44:20 +01:00
Paul Banks 5952804334
Move 1.0.6 upgrade docs that were added in the wrong place 2018-10-11 11:38:55 +01:00