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
James Phillips
01541fefd1
Tweaks local option name.
2016-11-19 18:23:37 -08:00
James Phillips
645c9f85d2
Adds a draft of the snapshot agent docs.
2016-11-16 21:38:02 -08:00
Benjamin Farley
e52e0b2a5a
Small change to how operator docs read
2016-11-16 09:01:51 +00:00
Kyle Havlovitz
440611f9f7
Add snapshot inspect subcommand ( #2451 )
2016-10-31 19:37:27 -04:00
Kyle Havlovitz
72412237fd
Revert "Added website docs for snapshot inspect command"
...
This reverts commit 7d0318252ca8fd81192b1bdc45a4c37407aecd37.
2016-10-31 17:06:47 -04:00
Kyle Havlovitz
c97c59b070
Added website docs for snapshot inspect command
2016-10-31 17:01:27 -04:00
James Phillips
bc29610124
Adds support for snapshots and restores. ( #2396 )
...
* Updates Raft library to get new snapshot/restore API.
* Basic backup and restore working, but need some cleanup.
* Breaks out a snapshot module and adds a SHA256 integrity check.
* Adds snapshot ACL and fills in some missing comments.
* Require a consistent read for snapshots.
* Make sure snapshot works if ACLs aren't enabled.
* Adds a bit of package documentation.
* Returns an empty response from restore to avoid EOF errors.
* Adds API client support for snapshots.
* Makes internal file names match on-disk file snapshots.
* Adds DC and token coverage for snapshot API test.
* Adds missing documentation.
* Adds a unit test for the snapshot client endpoint.
* Moves the connection pool out of the client for easier testing.
* Fixes an incidental issue in the prepared query unit test.
I realized I had two servers in bootstrap mode so this wasn't a good setup.
* Adds a half close to the TCP stream and fixes panic on error.
* Adds client and endpoint tests for snapshots.
* Moves the pool back into the snapshot RPC client.
* Adds a TLS test and fixes half-closes for TLS connections.
* Tweaks some comments.
* Adds a low-level snapshot test.
This is independent of Consul so we can pull this out into a library
later if we want to.
* Cleans up snapshot and archive and completes archive tests.
* Sends a clear error for snapshot operations in dev mode.
Snapshots require the Raft snapshots to be readable, which isn't supported
in dev mode. Send a clear error instead of a deep-down Raft one.
* Adds docs for the snapshot endpoint.
* Adds a stale mode and index feedback for snapshot saves.
This gives folks a way to extract data even if the cluster has no
leader.
* Changes the internal format of a snapshot from zip to tgz.
* Pulls in Raft fix to cancel inflight before a restore.
* Pulls in new Raft restore interface.
* Adds metadata to snapshot saves and a verify function.
* Adds basic save and restore snapshot CLI commands.
* Gets rid of tarball extensions and adds restore message.
* Fixes an incidental bad link in the KV docs.
* Adds documentation for the snapshot CLI commands.
* Scuttle any request body when a snapshot is saved.
* Fixes archive unit test error message check.
* Allows for nil output writers in snapshot RPC handlers.
* Renames hash list Decode to DecodeAndVerify.
* Closes the client connection for snapshot ops.
* Lowers timeout for restore ops.
* Updates Raft vendor to get new Restore signature and integrates with Consul.
* Bounces the leader's internal state when we do a restore.
2016-10-25 19:20:24 -07:00
James Phillips
51f0d91efb
Adds a version note for the consul kv command.
...
Closes #2410 .
2016-10-13 08:02:20 -07:00
James Phillips
9910cbfa0a
Update operator.html.markdown
2016-09-27 06:25:51 -07:00
Seth Vargo
784b45a5b6
Update cas docs
2016-09-26 16:15:27 -07:00
Seth Vargo
e3430e6806
Remove base64 comment entirely
2016-09-26 16:10:22 -07:00
Seth Vargo
70fd7efde9
Fix CAS operations for put
2016-09-26 16:06:56 -07:00
Seth Vargo
9cd78ea4d4
Update kv get docs
2016-09-26 16:06:56 -07:00
Seth Vargo
46f4093f14
Change delete CAS behavior to require ModifyIndex
2016-09-26 16:06:55 -07:00
Seth Vargo
533e4b3168
Add top-level docs command
2016-09-26 16:06:54 -07:00
Seth Vargo
ce5c820c4a
Add kv delete command
2016-09-26 16:06:53 -07:00
Seth Vargo
d5dd8ef7a1
Add kv put command
2016-09-26 16:06:53 -07:00
Seth Vargo
a8dc0f86b6
Add kv get
2016-09-26 16:06:53 -07:00
James Phillips
8a5d6f4d00
Update keyring.html.markdown
2016-09-23 16:00:05 -07:00
Pawel Szymczyk
4c82447726
remove reference to localhost in operator.html.markdown
2016-09-14 12:12:27 +02:00
James Phillips
c063a1a8d0
Updates documentation with details on the Consul operator actions.
2016-08-30 13:15:37 -07:00
James Phillips
1b7a16b7d3
Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands.
2016-08-30 00:02:50 -07:00
James Phillips
32cf81e59c
Fixes a typo and adds stale documentation to website.
2016-08-10 15:46:28 -07:00
Evan Gilman
6235467a9a
Document consul lock shell execution
...
Consul lock executes children under a shell, which was previously
undocumented. Document it, and warn against cases where this can cause
children to leak when the lock is lost.
I have made this a dedicated section so it can easily be removed
later when we move to exec
https://github.com/hashicorp/consul/issues/1692
2016-06-03 17:01:05 -07:00
James Phillips
48a29b5a31
Fixes a typo.
2016-02-09 16:37:06 -08:00
James Phillips
43a8eb8189
Adds a warning about DoS-ing the cluster with consul exec.
2016-02-05 17:36:19 -08:00
James Phillips
6dd0835319
Makes the timeout behavior more intuitive.
...
Previously, it would try once "up to" the timeout, but in practice it would
just fall through. This modifies the behavior to block until the timeout has
been reached.
2016-01-06 09:40:20 -08:00
James Phillips
87dd758199
Defaults monitor retries to 3 retries @ 1s for the consul lock command.
2016-01-05 18:34:22 -08:00
James Phillips
9323276b58
Adds monitor retries to the consul lock command.
2016-01-05 18:22:36 -08:00
James Phillips
3348cf4c0b
Adds "try" support to locks and semaphores.
2016-01-05 18:22:36 -08:00
James Phillips
09b1924cce
Tweaks RTT command docs.
2015-12-21 15:16:48 -08:00
Sylvain Boily
726fde8e02
Update documentation to use rtt with https
2015-12-17 13:24:42 -05:00
James Phillips
b3b1c6940b
Updates docs for network coordinates.
2015-10-23 15:23:01 -07:00
James Phillips
c48e3e1179
Defaults second node to agent if not given. Removes -short option and tweaks output formatting.
2015-10-23 15:23:01 -07:00
James Phillips
a51e170eef
Cleans up after code review, adds a -short option to "consul rtt" command.
2015-10-23 15:23:01 -07:00
James Phillips
43df5c6784
Adds a "consul rtt" command.
2015-10-23 15:23:01 -07:00
Anthony Scalisi
8d733b7fca
remove various typos
2015-09-11 12:29:54 -07:00
Ryota Arai
50914e2388
website: description of -pass-stdin option
2015-09-01 11:00:26 +09:00
James Phillips
c6b4ba12a7
Fixes a typo in the event docs, and twiddles the formatting.
2015-08-13 17:26:41 -07:00
Ryan Uber
d893a60534
website: document -token parameter for exec/event commands
2015-06-22 17:19:07 -07:00
Clint Shryock
9d6af83fa4
fix typo
2015-06-01 08:34:54 -05:00
Ryan Uber
b6151768dd
website: be explicit about grace period in lock command
2015-05-28 12:24:32 -07:00
Ryan Uber
b082d2f529
website: link and formatting adjustments for configtest command
2015-05-11 09:42:06 -07:00
Joseph Anthony Pasquale Holsten
ae3e8d24c4
command/configtest: add
2015-05-08 13:09:50 -07:00
Michael Chapman
20826efaa2
website: Fix list of types available to watch
...
The list of types erroneously had services listed twice in place
of 'service' and 'services'
2015-02-13 11:20:26 +11:00
Emil Hessman
2a80aacb86
docs: describe child process handling on Windows for lock command
...
Add website documentation for how the lock command handles child
process termination on Windows.
2015-01-25 11:42:29 +01:00
Emil Hessman
9be514e747
website: fix minor typos in docs
2015-01-23 22:11:15 +01:00
Armon Dadgar
e5e519df4b
Merge pull request #625 from hashicorp/f-maintcmd
...
New "maint" command
2015-01-22 11:56:49 -08:00
Ryan Uber
361b3109c2
website: update maint command documentation for list mode
2015-01-22 10:34:14 -08:00
Armon Dadgar
99671ba0d7
website: Cleanup the 'lock' documentation
2015-01-21 17:35:06 -08:00
Ryan Uber
61322641ea
website: document maint command
2015-01-21 14:07:54 -08:00
Armon Dadgar
b92b09cd19
website: Document the lock command
2015-01-19 16:43:38 -10:00
Justin Clayton
419f287273
Update exec.html.markdown
...
fixing near-meaningless spelling and grammar typos ;-)
2015-01-02 10:30:11 -08:00
lalyos
3823a931c6
Add default rpc address configuration option as CONSUL_RPC_ADDR env variable
...
Similar as in serf: https://github.com/hashicorp/serf/pull/210
2014-12-16 12:18:34 +01:00
Clint Shryock
693fa207c8
Small doc update for exec command
...
the documentation for -tag says it must be used with -service, but
example used is -server, which doesn't work.
This changes -server to -service.
2014-12-03 22:46:26 -06:00
Ryan Uber
58ba650cb0
website: Improve docs for reloading config. Fixes #407
2014-11-25 19:03:14 -08:00
Ryan Uber
c59107f08e
command: remove -init argument from keyring, auto-persist keyrings when using agent -encrypt
2014-11-19 16:35:13 -08:00
Ryan Uber
08f1605159
website: clean up keyring command docs and add output examples
2014-11-19 16:34:18 -08:00
Ryan Uber
001a579d47
command/keyring: cleanup
2014-11-19 16:34:18 -08:00
Ryan Uber
1ec111bbfc
consul: kill unused struct fields
2014-11-19 16:34:17 -08:00
Ryan Uber
03012e8ac6
command: allow wan ring to be modified separately from lan pools
2014-11-19 16:33:34 -08:00
Ryan Uber
9a7a7c10d4
website: documentation updates for keyring command
2014-11-19 16:32:06 -08:00
Ryan Uber
bb06d5ccb8
website: remove keyring persistence options from agent page
2014-11-19 16:31:06 -08:00
Ryan Uber
8dc53447a3
command: renamed keys to keyring to disambiguate usage
2014-11-19 16:31:06 -08:00
Ryan Uber
d8f513f6d6
website: update consul keys documentation
2014-11-19 16:30:22 -08:00
Ryan Uber
c0f1b5f8c8
website: document keys command
2014-11-19 16:30:22 -08:00
Jamey Owens
a0f954b0ae
Typo fix for events command doc
2014-11-10 16:37:18 -05:00
Danny Berger
4347b9394d
Fix some typos in website docs
2014-11-04 21:33:42 -07:00
Seth Vargo
e265ea050d
Use new Markdown syntaxes and add SEO descriptions
2014-10-19 19:42:13 -04:00
Sneha More
4e4ed41d47
reload command triggers reload
2014-09-23 12:52:09 +05:30
Ruben Vermeersch
bf5df40981
Fix typo
2014-09-02 19:15:54 +02:00
Armon Dadgar
ea20cabc0f
website: Updating docs
2014-09-01 15:03:37 -07:00
Armon Dadgar
7f9b260c93
website: typo fixes
2014-08-30 17:22:23 -07:00
Armon Dadgar
2f8948fe89
website: Adding docs
2014-08-28 17:22:56 -07:00
Armon Dadgar
60a50301db
website: Document watches
2014-08-21 17:25:42 -07:00
Armon Dadgar
e9a31bb298
website: Show join help instead of members
2014-06-11 11:08:19 -07:00
Armon Dadgar
90cababb0b
website: Mention reload command in addition to SIGHUP
2014-06-11 11:03:59 -07:00
Armon Dadgar
5378542b1c
website: Document the new reload command
2014-06-11 11:01:36 -07:00
Armon Dadgar
7fc5b7a920
command/members: Improve output. Fixes #143
2014-06-06 16:00:02 -07:00
Jacques Fuentes
dd6f55ff3b
Round 2: Fix typos, grammar errors, and misspellings
2014-04-16 00:01:12 -04:00
Armon Dadgar
911ce92cf3
website: Documentation cleanup
2014-04-09 11:06:27 -07:00
Armon Dadgar
00bd68d866
website: Update format of consul info
2014-03-31 21:15:37 -07:00
Armon Dadgar
752b4ac43f
command/members: Remove the detailed flag, abstraction leak
2014-03-09 15:46:43 -07:00
Armon Dadgar
6a7c45c66c
website: Update sample output again
2014-02-23 18:13:51 -08:00
Armon Dadgar
8f47b60145
website: Update sample output
2014-02-23 18:11:07 -08:00
Armon Dadgar
38317d4890
website: Documenting the info command
2014-02-23 17:09:59 -08:00
Armon Dadgar
c200b63204
website: updating documentation on commands
2014-02-18 17:32:13 -08:00
Armon Dadgar
0611db496a
website: bulk copy from serf
2014-02-07 16:41:03 -08:00
