consul/website
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
..
scripts Remove people from community section (#3352) 2017-08-02 12:05:45 -07:00
source New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
Gemfile update middleman-hashicorp to 0.3.35 2018-04-13 09:11:32 -07:00
Gemfile.lock update middleman-hashicorp to 0.3.35 2018-04-13 09:11:32 -07:00
LICENSE.md Update license 2017-03-08 11:40:06 -08:00
Makefile Update middleman docker image to 0.3.35 2018-04-13 09:22:12 -07:00
README.md Update middleman-hashicorp 2017-03-08 11:26:11 -08:00
config.rb website: bump website for 1.3.0 2018-10-11 11:27:54 -07:00
packer.json website: bump version of middleman used in packer build 2018-04-13 10:29:50 -07:00
redirects.txt Remove people from community section (#3352) 2017-08-02 12:05:45 -07:00
report.xml Starting Docs (#46) 2018-06-25 12:24:05 -07:00

README.md

Consul Website

This subdirectory contains the entire source for the Consul Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome!

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. Clone this repo and run make website.

Then open up http://localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation).