Commit Graph

238 Commits

Author SHA1 Message Date
Jack Pearkes 5faa61a906 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
R.B. Boyer 480ea8e7c6
docs: remove curly quotes from shell block (#4921) 2018-11-07 10:42:13 -08:00
Mike Pettypiece 6ca8138d4e 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
R.B. Boyer a5d57f5326
fix comment typos (#4890) 2018-11-02 12:00:39 -05:00
Sébastien Portebois a0614aadca 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 62dae2fd9f website: fix minor typo in documentation (#4864) 2018-10-29 01:33:42 -07:00
Matt Keeler 8fa3d61d25
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
Jack Pearkes a10297c15b
website: minor notes about 1.4.0 (#4820) 2018-10-19 08:52:56 -07:00
Jack Pearkes 197d62c6ca 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
Paul Banks 94332edf2e
[WIP] Initial draft of Sidecar Service and Managed Proxy deprecation docs (#4752)
* Initial draft of Sidecar Service and Managed Proxy deprecation docs

* Service definition deprecation notices and sidecar service

* gRPC and sidecar service config options; Deprecate managed proxy options

* Envoy Docs: Basic envoy command; envoy getting started/intro

* Remove change that snuck in

* Envoy custom config example

* Add agent/service API docs; deprecate proxy config endpoint

* Misc grep cleanup for managed proxies; capitalize Envoy

* Updates to getting started guide

* Add missing link

* Refactor Envoy guide into a separate guide and add bootstrap reference notes.

* Add limitations to Envoy docs; Highlight no fixes for known managed proxy issues on deprecation page; clarify snake cae stuff; Sidecar Service lifecycle
2018-10-11 10:44:42 +01:00
Matt Keeler 71297a6b9d
Update the snapshot agent documentation(#4758)
Detail the S3 permissions required in addition to a gotcha regarding having part of the key within the S3 bucket name configuration.
2018-10-05 13:55:06 -04:00
Mitchell Hashimoto 3bbbc3fd66
website: docs for services CLI 2018-10-01 10:27:15 -07:00
Freddy 7a19f2a6da
Update snapshot agent docs to include s3-endpoint (#4652) 2018-09-11 16:32:31 +01:00
Paul Banks e40e131dd7
Merge pull request #4263 from hashicorp/kv-get-docs
Update kv docs detail for accuracy
2018-07-13 18:29:34 +01:00
Jack Pearkes d3cec142d4 website: fix an assortment of broken links 2018-06-25 12:26:24 -07:00
Kyle Havlovitz 837f23441d connect/ca: hide the RotationPeriod config field since it isn't used yet 2018-06-25 12:26:18 -07:00
Mitchell Hashimoto 8dbe0017bb Starting Docs (#46)
* website: first stab at Connect docs

* website: lots more various stuff (bad commit messages)

* website: getting started page for Connect

* website: intentions

* website: intention APIs

* website: agent API docs

* website: document agent/catalog proxy kind service values

* website: /v1/catalog/connect/:service

* website: intention CLI docs

* website: custom proxy docs

* website: remove dedicated getting started guide

* website: add docs for CA API endpoints

* website: add docs for connect ca commands

* website: add proxy CLI docs

* website: clean up proxy command, add dev docs

* website: todo pages

* website: connect security
2018-06-25 12:24:05 -07:00
Hannah Oppenheimer a94ab3cd88
Update kv docs detail for accuracy 2018-06-21 13:21:26 -05:00
Matt Keeler 83d07bdde8 Add licensing documentation. 2018-05-24 10:10:00 -04:00
Josh Soref 1dd8c378b9 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
randall thomson 24588fc479
Update index.html.md
update cli commands for consul 1.x
2018-03-09 09:46:37 -08:00
Chad Whitacre 53d1102191 Fix some small doc errors 2018-01-04 16:44:07 -05:00
James Phillips 60af465b4e
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 5af8492172 Documentation update for KMS support 2017-10-19 11:39:14 -05:00
Preetha Appan e3e781e264 Update documentation with subcommand example 2017-10-06 15:23:43 -05:00
Preetha Appan 5d5e245417 Autocomplete support 2017-10-06 15:05:45 -05:00
Kyle Havlovitz be04bfed34 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 7c7927ff3d
Update snapshot agent docs 2017-09-29 12:28:04 -07:00
James Phillips 02a3f3f27b
Shows the segment name in the keyring API and command output. 2017-09-07 12:17:39 -07:00
James Phillips 76cd7963e5 Update maint.html.markdown.erb 2017-09-01 17:51:02 -07:00
phanidileep df4e77e179 Updating maint.html to remove node maint (#3354)
* Updating maint.html to remove node maint

as discussed in #3268 maint mode does not have any affect on the node health.

* Update maint.html.markdown.erb
2017-09-01 17:49:51 -07:00
Kyle Havlovitz 02c35fe0ba
Add doc sections for network segments 2017-08-31 11:19:08 -07:00
James Phillips 9b70009ab8 command/lock: Add -child-exitcode, return 2 on child error (#3329)
* Exit 2 if -child-exit-code and the child returned with an error.
* There is no platform independent way to check the exact return code of
* the child, so on error always return 2.
* Closes #947
* Closes #1503
2017-07-26 22:09:19 -07:00
James Phillips 6e251d39b5 Updates consul exec docs to mention ACLs. (#3308)
* Update documentation for consul exec to mention all permissions it needs.

* Removed node write perm, not needed for consul exec

* Converts ACL note into a table like the API docs, adds ACL guide x-ref.
2017-07-20 09:30:08 -07:00
Kyle Havlovitz 73ec6541f6
Add UpgradeVersionTag information to docs 2017-07-18 14:01:21 -07:00
James Phillips fe7a24c846 Adds a missing newline to the snapshot agent page. 2017-07-17 22:22:50 -07:00
Kyle Havlovitz 6ea05706a1
Add network area TLS setting to docs 2017-07-14 17:06:33 -07:00
Seth Vargo a2ba7071e9 Add catalog CLI functions (#3204) 2017-07-14 12:45:08 -07:00
Preetha Appan 5bc9edb4ec Update documentation and json examples for snapshot agent 2017-06-21 21:15:02 -05:00
Preetha Appan 59e2592872 Added documentation for new s3 server side encryption 2017-06-08 11:39:10 -07:00
Katie Bayes 714f46f34b add enterprise badge style alert boxes, change guides/areas.html.md to erb file 2017-06-04 01:30:21 -04:00
Frank Schroeder 2391e8e98a
website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
Kyle Havlovitz 72ee7c2501 Show raft protocol in list-peers command (#2929) 2017-04-19 15:01:40 -07:00
Kyle Havlovitz cdd8b5b880
Add tls client options to api/cli 2017-04-14 13:37:29 -07:00
captainill 9d2c13341b update all links to enterprise to avoid redirect 2017-04-05 12:13:23 -07:00
James Phillips 686ddd8c83
Deprecates the ACLs internals doc in favor of a guide. 2017-04-04 18:56:42 -07:00
Seth Vargo b0bb01d5da
Update API docs 2017-04-04 12:33:35 -04:00
Brian Shumate 77dc61ace9
docs: Clarify force-remove limited to same DC, fixes #1264 2017-03-30 14:44:10 -04:00
Kyle Havlovitz 074b8576a5 Merge pull request #2847 from hashicorp/remove-peer-by-id
Add CLI/API endpoints for removing peer by ID
2017-03-30 10:13:56 -07:00
Kyle Havlovitz a2058d23ef
Add CLI/API endpoints for removing peer by ID 2017-03-30 10:13:32 -07:00
James Phillips c4e6655757
Adds a link from the autopilot CLI page to the guide. 2017-03-29 21:14:26 -07:00
James Phillips 36aface2e2
Adds network area CLI documentation. 2017-03-28 10:31:56 -07:00
Kyle Havlovitz 37ea20cb44
Add advanced autopilot features 2017-03-22 15:25:16 -07:00
James Phillips 28f8aa5559
Removes remoteConsuls in favor of the new router.
This has the next wave of RTT integration with the router and also
factors some common RTT-related helpers out to lib. While we were
in here we also got rid of the coordinate disable config so we don't
need to deal with the complexity in the router (there was never a
user-visible way to disable coordinates).
2017-03-16 16:42:19 -07:00
Kyle Havlovitz 8130f9b1c1
Cleaned up and reorganized some autopilot-related code 2017-03-09 18:21:40 -08:00
Kyle Havlovitz 8bcab6c6d7
Add autopilot server health tracking
This adds two goroutines to perform autopilot tasks on the leader - one
to monitor the health of servers and another to periodically clean up
dead servers with a limit on removal count. Also adds a new http endpoint,
`/v1/operator/autopilot/health`, for querying this information through an
operator RPC endpoint.
2017-03-06 16:00:10 -08:00
Kyle Havlovitz 44f0b08db7 Merge pull request #2771 from hashicorp/f-autopilot
Autopilot dead server cleanup, config, and raft version compatibility
2017-02-28 15:04:16 -08:00
Kyle Havlovitz 23c492a74e
Rename DeadServerCleanup and make wording adjustments 2017-02-28 14:45:21 -08:00
Kyle Havlovitz 3b67c50c1d
Remove the RPC client interface and update docs 2017-02-28 13:41:09 -08:00
Kyle Havlovitz f7b6d776f4
Add cli docs and minor test/comment tweaks 2017-02-24 16:55:44 -08:00
Kyle Havlovitz 3f05576cc8
Condense raft subcommand into one doc page 2017-02-16 11:44:14 -08:00
Kyle Havlovitz 2b12a43840
Split operator raft command into subcommands 2017-02-15 13:53:34 -08:00
Kyle Havlovitz 0262f009dd Merge pull request #2732 from hashicorp/f-validate-command
Deprecate configtest and add validate command
2017-02-10 20:34:09 -05:00
Kyle Havlovitz 35d99a81ac
Update docs and give better error for unknown client scheme 2017-02-10 19:55:54 -05:00
Kyle Havlovitz 27ee6f974d
Update website docs for validate command 2017-02-10 19:38:38 -05:00
Kyle Havlovitz 955d1b983d
Merge branch 'master' into f-cli-rework-3 2017-02-09 21:24:27 -05:00
Kyle Havlovitz 65ad17a27d
Convert watch command to use base.Command 2017-02-09 20:36:01 -05:00
Kyle Havlovitz 1767a4dcb0
Add missing doc page for version command 2017-02-09 20:08:25 -05:00
Kyle Havlovitz 50f6c6a2bb
Convert snapshot command to use base.Command 2017-02-09 20:00:38 -05:00
Kyle Havlovitz bcdbc9175c
Convert rtt command to use base.Command 2017-02-09 19:38:06 -05:00
Kyle Havlovitz 520edc2e49
Convert reload command to use base.Command 2017-02-09 19:32:22 -05:00
Kyle Havlovitz 1a26907d01
Convert operator command to use base.Command 2017-02-09 18:19:34 -05:00
Kyle Havlovitz c78f62b83d
Convert monitor command to use base.Command 2017-02-09 17:31:52 -05:00
Kyle Havlovitz 7d72864531
Convert members command to use base.Command 2017-02-09 17:12:47 -05:00
Kyle Havlovitz 4be635d3a1
Convert maint command to use base.Command 2017-02-09 17:06:19 -05:00
Kyle Havlovitz e385af8eeb
Convert leave command to use base.Command 2017-02-09 16:48:12 -05:00
Kyle Havlovitz d3b24d2d12
Convert keyring command to use base.Command 2017-02-08 18:25:47 -05:00
Kyle Havlovitz 9e156286c7
Convert join command to use base.Command 2017-02-08 17:14:02 -05:00
Kyle Havlovitz a69f2a0faf
Convert info command to use base.Command 2017-02-08 16:58:04 -05:00
Kyle Havlovitz 89771b6075
Convert exec command to use base.Command 2017-02-08 16:57:46 -05:00
Kyle Havlovitz 6cc2299123
Convert event command to use base.Command 2017-02-08 16:56:58 -05:00
James Phillips 511b135131 Merge pull request #2669 from legendtkl/master
Fix consul kv example with flag separator
2017-02-07 20:17:42 -08:00
Kyle Havlovitz 9e38fc1c84
Move command Meta to base.Command and split http options 2017-02-07 19:16:41 -05:00
Kyle Havlovitz 4fc3bd3abf
Added -relay-factor param to keyring operations 2017-02-01 21:53:29 -05:00
legendtkl b9ce8f6e4f Fix consul kv example with flag separator
1. fix consul kv example with flag separator
2017-01-24 17:03:12 +08:00
Brian Shumate f81d8c0754
DOCS: update environment variables
- Move environment variables to section of CLI page
- Remove environment variables page
- Remove environment variables nagivation menu entry
2017-01-09 12:02:06 -05:00
Brian Shumate d5bdc4c98b
DOCS: update environment variables page
- Relocate Environment Variables page to Agent section
- Correct front matter newlines issue
2017-01-06 09:42:49 -05:00
James Phillips d29cd8f4c8 Merge pull request #2573 from hashicorp/jbs-envvars
Add a page for CLI environment variables
2017-01-05 12:42:29 -08:00
James Nugent 3b1f523b85 cli: Add KV `export` and `import`
This commit adds two new commands to the Consul KV CLI, which export and
import a JSON formatted representation of the Consul KV tree. It is
useful to migrate parts of the KV tree between unrelated Consul
clusters, and could also be used for initial data population of the KV
store.
2017-01-05 07:57:38 -06:00
James Nugent c32fe92eee cli: Add -base64 option to `consul kv put`
This commit adds a -base64 option to the consul kv put command, which
base 64 decodeds the data prior to writing it. This can be used in
conjunction with `consul kv get -base64 key`.
2017-01-04 16:12:21 -06:00
James Nugent a24e5041ac Merge pull request #2631 from hashicorp/kv-get-base64
cli: Add -base64 option to `consul kv get`
2017-01-04 16:00:27 -06:00
James Nugent 2bb6121e54 cli: Add -base64 option to `consul kv get`
This commit adds a `-base64` option to the `consul kv get` command,
which base 64 encodes the output such that it can be processed by
terminal tools in the event that the data is binary. The flag defaults
to false.
2017-01-04 15:41:40 -06:00
Bradley Falzon 5acd28c506 Fix typo in command/kv/put doc 2016-12-21 14:02:26 +10:30
Brian Shumate 5a26a906cd
Overlooked saving a couple changes 2016-12-06 18:01:43 -05:00
Brian Shumate c5b68467c6
updates based on feedback 2016-12-06 14:46:26 -05:00
Brian Shumate bcec3b3eb4
Some examples where sockets are possible as well 2016-12-05 16:56:31 -05:00
Brian Shumate cd2b3ed193
Add a table of CLI environment variables 2016-12-05 12:35:44 -05:00
James Turnbull b7566cd0e8 Fix to watch command docs 2016-11-25 13:34:08 -05:00
James Turnbull dd4918fd16 Documentation pass
I was reviewing some docs and found a few issues.

1. Fixed some spelling mistakes.
2. Re-formatted some paragraphs.
3. Changed some potentially loaded language.
4. Fixed some grammar issues.
5. Tried to consistently use syntax-highlighting.
6. Fixed post-period spacing.
7. Fixed some formatting issues and inconsistency.
8. All "notes" are either proper notes or re-written.
2016-11-25 12:02:32 -05:00
James Phillips ef4168cd53
Adds details about config files. 2016-11-20 22:41:33 -08:00