Kyle Havlovitz
ea66375063
Convert watch command to use base.Command
2017-02-09 20:36:01 -05:00
Kyle Havlovitz
edbb0ce0b8
Add missing doc page for version command
2017-02-09 20:08:25 -05:00
Kyle Havlovitz
aa0d2502f8
Convert snapshot command to use base.Command
2017-02-09 20:00:38 -05:00
Kyle Havlovitz
8236af47ba
Convert rtt command to use base.Command
2017-02-09 19:38:06 -05:00
Kyle Havlovitz
8c14f93fb1
Convert reload command to use base.Command
2017-02-09 19:32:22 -05:00
Kyle Havlovitz
369b4b6d73
Convert operator command to use base.Command
2017-02-09 18:19:34 -05:00
Kyle Havlovitz
be17779c42
Convert monitor command to use base.Command
2017-02-09 17:31:52 -05:00
Kyle Havlovitz
14415741a3
Convert members command to use base.Command
2017-02-09 17:12:47 -05:00
Kyle Havlovitz
6c4d4f9a32
Convert maint command to use base.Command
2017-02-09 17:06:19 -05:00
Kyle Havlovitz
ccb193f77f
Convert leave command to use base.Command
2017-02-09 16:48:12 -05:00
Kyle Havlovitz
abdf1fbab3
Convert keyring command to use base.Command
2017-02-08 18:25:47 -05:00
Kyle Havlovitz
8775b031d3
Convert join command to use base.Command
2017-02-08 17:14:02 -05:00
Kyle Havlovitz
a3d02a4cbc
Convert info command to use base.Command
2017-02-08 16:58:04 -05:00
Kyle Havlovitz
aa1c464961
Convert exec command to use base.Command
2017-02-08 16:57:46 -05:00
Kyle Havlovitz
8985398c7e
Convert event command to use base.Command
2017-02-08 16:56:58 -05:00
James Phillips
eb99212b83
Merge pull request #2669 from legendtkl/master
...
Fix consul kv example with flag separator
2017-02-07 20:17:42 -08:00
Kyle Havlovitz
49d2ce1c3d
Move command Meta to base.Command and split http options
2017-02-07 19:16:41 -05:00
Kyle Havlovitz
5d888f5303
Added -relay-factor param to keyring operations
2017-02-01 21:53:29 -05:00
legendtkl
a2ff72b6ce
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
1eaeb13a9c
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
f5e76a7125
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
5500009ae4
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
d4e8c8a2c1
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
2e8f440ac7
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
5334649355
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
b79296ac70
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
5a0b824ae0
Fix typo in command/kv/put doc
2016-12-21 14:02:26 +10:30
Brian Shumate
92cf10a8c7
Overlooked saving a couple changes
2016-12-06 18:01:43 -05:00
Brian Shumate
418c76d8bb
updates based on feedback
2016-12-06 14:46:26 -05:00
Brian Shumate
291ea643d2
Some examples where sockets are possible as well
2016-12-05 16:56:31 -05:00
Brian Shumate
fbd074b7e7
Add a table of CLI environment variables
2016-12-05 12:35:44 -05:00
James Turnbull
8d29224d5c
Fix to watch command docs
2016-11-25 13:34:08 -05:00
James Turnbull
23a4a96ad3
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
66b61e68a0
Adds details about config files.
2016-11-20 22:41:33 -08:00
James Phillips
3a63638cd7
Tweaks local option name.
2016-11-19 18:23:37 -08:00
James Phillips
e1e43dec7a
Adds a draft of the snapshot agent docs.
2016-11-16 21:38:02 -08:00
Benjamin Farley
58fa50e06d
Small change to how operator docs read
2016-11-16 09:01:51 +00:00
Kyle Havlovitz
606662c502
Add snapshot inspect subcommand ( #2451 )
2016-10-31 19:37:27 -04:00
Kyle Havlovitz
4be39290e5
Revert "Added website docs for snapshot inspect command"
...
This reverts commit 7d0318252c
.
2016-10-31 17:06:47 -04:00
Kyle Havlovitz
7d0318252c
Added website docs for snapshot inspect command
2016-10-31 17:01:27 -04:00
James Phillips
c01a3871c9
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
41f1764434
Adds a version note for the consul kv command.
...
Closes #2410 .
2016-10-13 08:02:20 -07:00
James Phillips
1e318db830
Update operator.html.markdown
2016-09-27 06:25:51 -07:00
Seth Vargo
f381d19221
Update cas docs
2016-09-26 16:15:27 -07:00
Seth Vargo
28de64c7f0
Remove base64 comment entirely
2016-09-26 16:10:22 -07:00
Seth Vargo
39fb70ff67
Fix CAS operations for put
2016-09-26 16:06:56 -07:00
Seth Vargo
85350a4329
Update kv get docs
2016-09-26 16:06:56 -07:00
Seth Vargo
c7496c5652
Change delete CAS behavior to require ModifyIndex
2016-09-26 16:06:55 -07:00
Seth Vargo
a6262c863b
Add top-level docs command
2016-09-26 16:06:54 -07:00
Seth Vargo
297a22383f
Add kv delete command
2016-09-26 16:06:53 -07:00
Seth Vargo
82bddd7f9b
Add kv put command
2016-09-26 16:06:53 -07:00
Seth Vargo
c8fdc5c50d
Add kv get
2016-09-26 16:06:53 -07:00
James Phillips
c4c409be44
Update keyring.html.markdown
2016-09-23 16:00:05 -07:00
Pawel Szymczyk
d97f389805
remove reference to localhost in operator.html.markdown
2016-09-14 12:12:27 +02:00
James Phillips
2c9885d10d
Updates documentation with details on the Consul operator actions.
2016-08-30 13:15:37 -07:00
James Phillips
e5850d8a26
Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands.
2016-08-30 00:02:50 -07:00
James Phillips
2b65e7da05
Fixes a typo and adds stale documentation to website.
2016-08-10 15:46:28 -07:00
Evan Gilman
73d4f5700b
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
03602779c6
Fixes a typo.
2016-02-09 16:37:06 -08:00
James Phillips
64ec6d7d73
Adds a warning about DoS-ing the cluster with consul exec.
2016-02-05 17:36:19 -08:00
James Phillips
49342dc973
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
1d733f4c36
Defaults monitor retries to 3 retries @ 1s for the consul lock command.
2016-01-05 18:34:22 -08:00
James Phillips
4afeddacc8
Adds monitor retries to the consul lock command.
2016-01-05 18:22:36 -08:00
James Phillips
8caa9e4c7e
Adds "try" support to locks and semaphores.
2016-01-05 18:22:36 -08:00
James Phillips
3a619ff4bf
Tweaks RTT command docs.
2015-12-21 15:16:48 -08:00
Sylvain Boily
9c2aadc5cb
Update documentation to use rtt with https
2015-12-17 13:24:42 -05:00
James Phillips
cef9402ab9
Updates docs for network coordinates.
2015-10-23 15:23:01 -07:00
James Phillips
99cfbb8a47
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
88845f7d71
Cleans up after code review, adds a -short option to "consul rtt" command.
2015-10-23 15:23:01 -07:00
James Phillips
fb8900156a
Adds a "consul rtt" command.
2015-10-23 15:23:01 -07:00
Anthony Scalisi
10e028d599
remove various typos
2015-09-11 12:29:54 -07:00
Ryota Arai
b2755d026e
website: description of -pass-stdin option
2015-09-01 11:00:26 +09:00
James Phillips
88c15e5bbd
Fixes a typo in the event docs, and twiddles the formatting.
2015-08-13 17:26:41 -07:00
Ryan Uber
7e63572df6
website: document -token parameter for exec/event commands
2015-06-22 17:19:07 -07:00
Clint Shryock
dcb2d9e5ac
fix typo
2015-06-01 08:34:54 -05:00
Ryan Uber
84b602a925
website: be explicit about grace period in lock command
2015-05-28 12:24:32 -07:00
Ryan Uber
8f79a964cd
website: link and formatting adjustments for configtest command
2015-05-11 09:42:06 -07:00
Joseph Anthony Pasquale Holsten
afbf68878c
command/configtest: add
2015-05-08 13:09:50 -07:00
Michael Chapman
8256737d5d
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
abce80f7bc
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
6f3215f0a8
website: fix minor typos in docs
2015-01-23 22:11:15 +01:00
Armon Dadgar
e1a5d537d4
Merge pull request #625 from hashicorp/f-maintcmd
...
New "maint" command
2015-01-22 11:56:49 -08:00
Ryan Uber
de0b6d06bb
website: update maint command documentation for list mode
2015-01-22 10:34:14 -08:00
Armon Dadgar
d478f786db
website: Cleanup the 'lock' documentation
2015-01-21 17:35:06 -08:00
Ryan Uber
6995e74d94
website: document maint command
2015-01-21 14:07:54 -08:00
Armon Dadgar
d6d1f19f1b
website: Document the lock command
2015-01-19 16:43:38 -10:00
Justin Clayton
132a517d88
Update exec.html.markdown
...
fixing near-meaningless spelling and grammar typos ;-)
2015-01-02 10:30:11 -08:00
lalyos
89f271a9da
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
042a523c14
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
f126bb7381
website: Improve docs for reloading config. Fixes #407
2014-11-25 19:03:14 -08:00
Ryan Uber
7a74f559b9
command: remove -init argument from keyring, auto-persist keyrings when using agent -encrypt
2014-11-19 16:35:13 -08:00
Ryan Uber
7e0af5153f
website: clean up keyring command docs and add output examples
2014-11-19 16:34:18 -08:00
Ryan Uber
daf77c3f5b
command/keyring: cleanup
2014-11-19 16:34:18 -08:00
Ryan Uber
9d01174521
consul: kill unused struct fields
2014-11-19 16:34:17 -08:00
Ryan Uber
cfbf2b4f94
command: allow wan ring to be modified separately from lan pools
2014-11-19 16:33:34 -08:00
Ryan Uber
c52997c95b
website: documentation updates for keyring command
2014-11-19 16:32:06 -08:00
Ryan Uber
026ebcef58
website: remove keyring persistence options from agent page
2014-11-19 16:31:06 -08:00
Ryan Uber
67d78628a3
command: renamed keys to keyring to disambiguate usage
2014-11-19 16:31:06 -08:00
Ryan Uber
cea2b49c15
website: update consul keys documentation
2014-11-19 16:30:22 -08:00
Ryan Uber
6b41e98964
website: document keys command
2014-11-19 16:30:22 -08:00
Jamey Owens
8c5bf1ca25
Typo fix for events command doc
2014-11-10 16:37:18 -05:00
Danny Berger
3da9291ae1
Fix some typos in website docs
2014-11-04 21:33:42 -07:00
Seth Vargo
869b194127
Use new Markdown syntaxes and add SEO descriptions
2014-10-19 19:42:13 -04:00
Sneha More
fe85e58bc6
reload command triggers reload
2014-09-23 12:52:09 +05:30
Ruben Vermeersch
99073cbf25
Fix typo
2014-09-02 19:15:54 +02:00
Armon Dadgar
2d7be20431
website: Updating docs
2014-09-01 15:03:37 -07:00
Armon Dadgar
dc883d151e
website: typo fixes
2014-08-30 17:22:23 -07:00
Armon Dadgar
088e024417
website: Adding docs
2014-08-28 17:22:56 -07:00
Armon Dadgar
dce716f4b2
website: Document watches
2014-08-21 17:25:42 -07:00
Armon Dadgar
dc5745cc9c
website: Show join help instead of members
2014-06-11 11:08:19 -07:00
Armon Dadgar
4542933139
website: Mention reload command in addition to SIGHUP
2014-06-11 11:03:59 -07:00
Armon Dadgar
2b0f7566e5
website: Document the new reload command
2014-06-11 11:01:36 -07:00
Armon Dadgar
e9c7098936
command/members: Improve output. Fixes #143
2014-06-06 16:00:02 -07:00
Jacques Fuentes
ccddd16821
Round 2: Fix typos, grammar errors, and misspellings
2014-04-16 00:01:12 -04:00
Armon Dadgar
304cb516e1
website: Documentation cleanup
2014-04-09 11:06:27 -07:00
Armon Dadgar
f7e76960bd
website: Update format of consul info
2014-03-31 21:15:37 -07:00
Armon Dadgar
31a85bb64e
command/members: Remove the detailed flag, abstraction leak
2014-03-09 15:46:43 -07:00
Armon Dadgar
48ba9c3571
website: Update sample output again
2014-02-23 18:13:51 -08:00
Armon Dadgar
e673e24a62
website: Update sample output
2014-02-23 18:11:07 -08:00
Armon Dadgar
fad3e4d97c
website: Documenting the info command
2014-02-23 17:09:59 -08:00
Armon Dadgar
1fb7b330ad
website: updating documentation on commands
2014-02-18 17:32:13 -08:00
Armon Dadgar
1d10b9d6ba
website: bulk copy from serf
2014-02-07 16:41:03 -08:00