Commit Graph

246 Commits

Author SHA1 Message Date
Matt Keeler db2cf01406 Adds documentation for the new ACL APIs (#4851)
* Update the ACL API docs

* Add a CreateTime to the anon token

Also require acl:read permissions at least to perform rule translation. Don’t want someone DoSing the system with an open endpoint that actually does a bit of work.

* Fix one place where I was referring to id instead of AccessorID

* Add godocs for the API package additions.

* Minor updates: removed some extra commas and updated the acl intro paragraph

* minor tweaks

* Updated the language to be clearer

* Updated the language to be clearer for policy page

* I was also confused by that! Your updates are much clearer.

Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>

* Sounds much better.

Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>

* Updated sidebar layout and deprecated warning
2018-10-31 15:11:51 -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
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
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
Paul Banks 51c0001aad
[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
Mitchell Hashimoto a3adf47bfb
website: add docs for the Connect injection 2018-10-07 23:47:08 -07:00
Dan Brown d3b6750c3b Add Deployment Guide and update links (#4487)
* Adds Deployment Guide and update links
* Fixes releases link
* Re-organisation of content
* Cuts down "deployment" doc (which should focus on Reference Architecture) by moving raft and performance tuning to the Server Performance page which already covers some of this.
* Moves backups from "deployment" doc (which should focus on Reference Architecture) to "deployment-guide"
* Cleans up some notes and add single DC diagram
* Removes old link to deployment guide from nav
* Corrects minor styling, formatting, and grammar
2018-10-03 11:37:36 -10:00
Mitchell Hashimoto 3cf2b9e361
website: docs for services CLI 2018-10-01 10:27:15 -07:00
Mitchell Hashimoto 321cd016d4
website: docs for catalog sync 2018-09-23 17:12:14 -07:00
Mitchell Hashimoto 113f568509 website: document k8s go-discover (#4666)
This adds documentation for the `k8s` go-discover provider that will be part of 1.2.3.
2018-09-13 10:12:27 -04:00
Mitchell Hashimoto 5943c79ed4
Initial Helm Chart/K8S Docs (#4653)
* website: initial Kubernetes section with Helm information

* website: extraConfig for clients

* website: add more helm fields

* website: document extraVolumes

* website: document Consul DNS

* website: fix typos and show example of downward API
2018-09-12 08:44:30 -07:00
Geoffrey Grosenbach a03512496f
Consul Production Deployment Guide
Renames guide to "Production Deployment"
Adds link in sidebar menu.
Implements edits suggested by Consul engineering team.
2018-08-10 11:51:05 -07:00
Peter Souter 0888b435ee Adds Monitoring with Telegraf guide (#4227)
* Installing Telegraf
* Configuring Telegraf 
* Configuring Consul to send metrics to Telegraf
* Important metrics and aggregates
2018-07-23 16:46:43 -07:00
Siva 7969d16e42 Added guide for Windows Service 2018-06-26 18:23:55 -04:00
mkeeler 6813a99081 Merge remote-tracking branch 'connect/f-connect' 2018-06-25 19:42:51 +00:00
Mitchell Hashimoto 93cd52024d website: split out CA docs by provider type 2018-06-25 12:26:23 -07:00
Mike Wickett bdd066425c Adds small polyfill for classlist because IE does not support it on SVG elements 2018-06-25 12:26:22 -07:00
Jack Pearkes bc1d3b5c76 website: add back intro link in header 2018-06-25 12:26:21 -07:00
Paul Banks b757b5cc48 Initial draft of connect production guide 2018-06-25 12:26:20 -07:00
Mike Wickett aa2b9108ed Add use case drop down to nav 2018-06-25 12:26:20 -07:00
RJ Spiker 37996e76ca website - separate js components so they're only called if needed 2018-06-25 12:26:18 -07:00
Jeff Escalante 409bf6301f add missing images/animations to homepage 2018-06-25 12:26:17 -07:00
RJ Spiker c6ce69c519 website - add case studies components with content 2018-06-25 12:26:15 -07:00
Mitchell Hashimoto 4acbe3fdf0 website: add vs. Envoy page 2018-06-25 12:25:43 -07:00
Mitchell Hashimoto 68826b2b76 website: istio vs. and nomad platform guide 2018-06-25 12:25:43 -07:00
Mitchell Hashimoto 7a1031fdc5 website: clearly note beta for Connect 2018-06-25 12:25:37 -07:00
Mitchell Hashimoto f522249e6b website: connect native overview 2018-06-25 12:24:13 -07:00
Mitchell Hashimoto c95ea2f205 website: remove sergmentation from sidebar
we'll move east-west to a "use case" section, didnt' feel right in the
reference docs.
2018-06-25 12:24:06 -07:00
Mitchell Hashimoto 097856c515 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
Omar Khawaja 8f66362770
update encryption doc and add guide for creating certificates (#4238)
* update encryption doc and add guide for creating certificates in consul with cfssl

* add details about CLI and disabling HTTP

* delete $ symbols and add guide elements

* add missing periods and steps heading
2018-06-18 15:25:35 -04:00
Matt Keeler 7c2afd2951 Add licensing documentation. 2018-05-24 10:10:00 -04:00
Geoffrey Grosenbach 3c5a279636 Revert sidebar link to Production Deployment Guide
Will be published when it has been reviewed.
2018-05-15 12:47:04 -07:00
Geoffrey Grosenbach 8dede720c1
Merge pull request #4113 from hashicorp/doc-production-deployment-guide
Production deployment guide
2018-05-14 16:11:57 -07:00
Geoffrey Grosenbach 4b528b10a5 WIP Sidebar menu for Consul Deployment Guide 2018-05-10 17:48:04 -07:00
Kyle Havlovitz 48560848fc
Move cloud auto-join docs to a separate page and add Triton 2018-05-10 17:15:41 -07:00
Jeff Kohrman e7a9cdbc99
Add link to privacy policy in website footer
Added link to updated privacy policy in footer of `layout.erb` for the OSS website.
2018-05-09 12:12:05 -06:00
Jeff Escalante 08e980e6e8 adjust analytics and scripts for turbolinks 2018-04-23 13:05:39 -04:00
Jack Pearkes cc454356bf
Merge pull request #3950 from hashicorp/je.segment
Switch web analytics to segment
2018-04-11 11:13:15 -07:00
Jeff Escalante da1f3f6213 switch analytics from ga to segment 2018-04-06 18:08:00 -04:00
Jack Pearkes ff13fdb328 website: use a smaller og image for unfurling / expansion behavior
Currently the large image can load in Slack (or other
clients that expand links) and dominate the viewport.

This is just following the pattern from a recent
change to the Terraform website in https://github.com/hashicorp/terraform-website/pull/214
2018-03-30 17:19:21 -07:00
Preetha Appan 7ca8b3ad8b
Adds documentation for Sentinel integration in Consul Enterprise. 2017-09-19 09:02:53 -05:00
Kevin Fishner 9f4a055953 add newtork segments overview page 2017-09-04 15:44:13 -07:00
Kyle Havlovitz 00d03f1141
Add doc sections for network segments 2017-08-31 11:19:08 -07:00
James Phillips adf3fc0b3b Changes sidebar to match title (and be shorter). 2017-08-01 17:20:19 -07:00
Preetha Appan d4fb271a3d Added links to new containers guide to navbar and index pages 2017-08-01 11:48:25 -05:00
James Phillips b97ae36896 Adds a Guides link to the nav. (#3337) 2017-07-28 16:56:57 -07:00
James Phillips 59b9164142 Adds a geo failover guide using prepared queries. (#3328) 2017-07-26 15:40:01 -07:00
Seth Vargo afd83a9705 Add catalog CLI functions (#3204) 2017-07-14 12:45:08 -07:00
Armon Dadgar df55d9fbb0 website: Add a vs Eureka. Fixes #1295 2017-06-08 11:00:30 -07:00
Rob Genova ff7db062ba Eliminated 'consul' from all paths; misc. edits; wrap text at 80 characters 2017-05-05 05:24:04 +00:00
Rob Genova f20aad8983 Add Consul Enterprise section to Docs 2017-05-04 22:30:11 +00:00
Seth Vargo 0bb2c356d8
Use HashiCorp logo for jsonld 2017-04-18 13:19:00 -04:00
James Phillips e954faa2aa
Removes old Atlas ecosystem doc from Consul. 2017-04-13 17:39:32 -07:00
Seth Vargo fc65d2201e
Add press-kit 2017-04-06 17:11:34 -04:00
James Phillips 497b6b522c Merge pull request #2876 from hashicorp/enterprise-links
update all links to enterprise to avoid redirect
2017-04-05 13:02:29 -07:00
Seth Vargo 74a26ee793
Add open graph images 2017-04-05 15:57:14 -04:00
captainill 1e898158fc update all links to enterprise to avoid redirect 2017-04-05 12:13:23 -07:00
James Phillips 93ddd46ffa
Removed RPC link from the sidebar. 2017-04-05 11:51:52 -07:00
James Phillips c89f4f420c Merge pull request #2874 from hashicorp/acl-guide
Updates the ACL guide.
2017-04-05 10:37:48 -07:00
Seth Vargo 77a847f203
Wider column sidebar 2017-04-05 10:04:06 -04:00
James Phillips 5ab7ea6f53
Deprecates the ACLs internals doc in favor of a guide. 2017-04-04 18:56:42 -07:00
James Phillips d621958e94
Removes guide link for Atlas integration. 2017-04-04 18:55:09 -07:00
Seth Vargo 61d814e69c
Rename sidebar link items 2017-04-04 12:40:53 -04:00
Seth Vargo 99c3592064
Update API docs 2017-04-04 12:33:35 -04:00
Seth Vargo 21b5570cb4
Fix GitHub link 2017-03-30 19:24:08 -04:00
Seth Vargo 2768612b37
Fix enterprise link 2017-03-30 19:17:26 -04:00
Seth Vargo 2816a83934
Remove app init 2017-03-30 19:10:00 -04:00
Seth Vargo 06dbeefaad
Move to new branding
This JUST moves over to the new branding. Once we get this in, I can
work on making the sidebar links and splitting out the API into its own
section.
2017-03-30 18:46:50 -04:00
James Phillips dac716641e
Adds network areas guide. 2017-03-28 11:56:55 -07:00
James Phillips 0b0eba8e97
Adds network area CLI documentation. 2017-03-28 10:31:56 -07:00
James Phillips 001dcf5511
Adds an Enterprise link to the Consul top nav. 2017-03-24 09:28:20 -07:00
Kyle Havlovitz c936fe38da
Add autopilot guide to the docs 2017-03-10 14:55:18 -08:00
Jason Costello 26576c6ca5 Remove 'by hashicorp" 2017-03-08 16:36:30 -08:00
Jason Costello b26affb22d Remove announcement banner 2017-03-08 16:36:30 -08:00
Jason Costello efdea4e081 Add meganav 2017-03-08 16:35:02 -08:00
Kyle Havlovitz 5429e8ce66
Add cli docs and minor test/comment tweaks 2017-02-24 16:55:44 -08:00
Jason Costello ce058b6a4a Wire up Klavika, remove Museo declarations 2017-02-21 10:45:56 -08:00
Kyle Havlovitz c8d0273f1b
Condense raft subcommand into one doc page 2017-02-16 11:44:14 -08:00
Kyle Havlovitz e85b401eb9
Split operator raft command into subcommands 2017-02-15 13:53:34 -08:00
Kyle Havlovitz eee5eb3fb8
Update website docs for validate command 2017-02-10 19:38:38 -05:00
Kyle Havlovitz 55ee1b0aed
Merge branch 'master' into f-cli-rework-3 2017-02-09 21:24:27 -05:00
Kyle Havlovitz bad037fb58
Cleanup and formatting adjustments 2017-02-09 20:49:17 -05:00
Kyle Havlovitz edbb0ce0b8
Add missing doc page for version command 2017-02-09 20:08:25 -05:00
Kyle Havlovitz a3d02a4cbc
Convert info command to use base.Command 2017-02-08 16:58:04 -05:00
Chris Becker 1025ded3d5 Add consul kv import/export links to sidebar 2017-02-01 15:11:39 -05:00
Ryon Coleman 2f111f2e4d Add Google Tag Manager #GTM-NR2SD7C 2017-01-27 15:41:42 -05: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 e1e43dec7a
Adds a draft of the snapshot agent docs. 2016-11-16 21:38:02 -08: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
Seth Vargo d5aac284d9 Switch to Docker-based website build process (#2448)
This has been working really well on Nomad and hashicorp.com, so I am
ready to port it out to Consul as a beta. This moves the local
development to a Docker container, which is the same container that we
use to publish the website in production. The result is much faster and
more consistent deploys.
2016-10-31 12:49:52 -07:00
Seth Vargo bfa0c3bc4c Add security page (#2447) 2016-10-29 12:44:20 -07: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
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 e5850d8a26
Adds new consul operator endpoint, CLI, and ACL and some basic Raft commands. 2016-08-30 00:02:50 -07:00
James Phillips c1c1a340e0
Sorts the guides (redux). 2016-08-25 16:47:54 -07:00