Commit Graph

56 Commits

Author SHA1 Message Date
Hans Hasselberg c7bb36559e
add docs for consul-k8s config read command (#17461)
* add docs for consul-k8s config read command

This PR adds documentation for the functionality introduced in
https://github.com/hashicorp/consul-k8s/pull/2078.

* add output

---------

Co-authored-by: David Yu <dyu@hashicorp.com>
2023-05-25 17:10:00 +00:00
malizz 2d3038874f
remove envoy endpoint flag from k8s docs (#17105) 2023-04-24 15:30:00 -07:00
John Maguire 6166889d44
Update the consul-k8s cli docs for the new `proxy log` subcommand (#16458)
* Update the consul-k8s cli docs for the new `proxy log` subcommand

* Updated consul-k8s docs from PR feedback

* Added proxy log command to release notes
2023-03-06 20:43:36 +00:00
malizz c9c49ea3a2
new docs for consul and consul-k8s troubleshoot command (#16284)
* new docs for consul and consul-k8s troubleshoot command

* add changelog

* add troubleshoot command

* address comments, and update cli output to match

* revert changes to troubleshoot upstreams, changes will happen in separate pr

* Update .changelog/16284.txt

Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>

* address comments

* update trouble proxy output

* add missing s, add required fields in usage

---------

Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2023-02-17 13:25:49 -08:00
Ashlee M Boyer 6e425f7428
docs: Migrate link formats (#15976)
* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Updating docs-content-check-legacy-links-format hash

* Migrating links to new format

Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
2023-01-25 08:52:43 -08:00
Iryna Shustava 2be8b3326c
docs: remaining agentless docs updates (#15455)
* Update servers-outside-kubernetes.mdx

* Update single-dc-multi-k8s.mdx

* update Vault data integration for snapshot agent

* update k8s health checks page

* remove all instances of controller.enabled in helm values examples

* API Gateway update

* Apply suggestions from code review

Co-authored-by: Riddhi Shah <riddhi@hashicorp.com>

* Apply suggestions from code review

* Apply suggestions from code review

* Cleaner diagram

* added change around clients to workloads

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com>
Co-authored-by: Riddhi Shah <riddhi@hashicorp.com>
Co-authored-by: David Yu <dyu@hashicorp.com>
2022-11-18 11:33:02 -06:00
boruszak f797d128c7 Spacing and title fixes 2022-09-16 10:28:32 -05:00
boruszak 0e042654dc Merge 'main' into docs/search-metadata-headers 2022-09-15 15:34:36 -05:00
Bryce Kalow 85c1a33c42
website: content updates for developer (#14419)
Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com>
Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com>
Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
Co-authored-by: Kevin Wang <kwangsan@gmail.com>
2022-09-14 17:45:42 -05:00
boruszak 0de4184b95 /docs/k8s 2022-09-14 17:26:14 -05:00
Thomas Eckert b56fb1aa44 Remove the beta warning for the upgrade command 2022-08-09 12:25:43 -04:00
Thomas Eckert edcca6e1a2
Apply Adam's suggestions
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2022-08-08 21:26:38 -04:00
Thomas Eckert 0dbb3a634f Clean up copy for the raw example 2022-08-08 17:32:47 -04:00
Thomas Eckert 71027a4ce1
Clean up raw copy
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 17:28:36 -04:00
Thomas Eckert 07b240e79c Combine shell sessions 2022-08-08 17:25:33 -04:00
Thomas Eckert b641be8466
Clean up external links about proxies
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 17:09:33 -04:00
Thomas Eckert f1f5776575
Add colon
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 17:08:18 -04:00
Thomas Eckert 46c2927ead Remove extra space from commands 2022-08-08 17:03:15 -04:00
Thomas Eckert e32f16cb45
See -> Refer to the
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 16:58:43 -04:00
Thomas Eckert e1e1ead19f
Note -> Tip
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 16:58:19 -04:00
Thomas Eckert f9420d13de
to -> on
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 16:57:31 -04:00
Thomas Eckert 9f72758aab Clarify use of Helm 2022-08-08 16:56:26 -04:00
Thomas Eckert 0c2efbee51
Update website/content/docs/k8s/k8s-cli.mdx
Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
2022-08-08 16:55:10 -04:00
Thomas Eckert 72df010472 Make external reference links sentences 2022-08-08 15:33:53 -04:00
Thomas Eckert d278b56734 Add read command examples 2022-08-08 15:16:55 -04:00
Thomas Eckert 466dce19a9 Change &nbsp; to <nobr> 2022-08-08 14:56:50 -04:00
Thomas Eckert 89f3b2979f Remove "Required" column from options (they are all optional) 2022-08-08 12:57:48 -04:00
Thomas Eckert 418bc1ca04 Update the table of contents with better descriptions 2022-08-08 12:53:41 -04:00
Thomas Eckert acf4758e12 Add options and examples to proxy read 2022-07-22 13:43:38 -04:00
Thomas Eckert 16c8563049 Add descriptions to the subjects 2022-07-22 12:14:01 -04:00
Thomas Eckert 73e8b3cc0d Add proxy list docs 2022-07-21 17:47:39 -04:00
Thomas Eckert 2ec29f6696 Move uninstall down to be alphabetically sorted 2022-07-20 15:14:14 -04:00
Thomas Eckert fe123421c6 Clean and clarify intro 2022-07-20 15:09:00 -04:00
Karl Cardenas d6778f4e63
docs: removed the word page 2022-03-22 15:51:04 -07:00
Karl Cardenas b17b6a462a
docs: add link to k8s cli install page 2022-03-22 15:40:53 -07:00
Karl Cardenas 7d4ee3efae
docs: cleaned up code blocks and added two sentences to the intro 2022-03-10 07:57:39 -07:00
David Yu 19d5d58e5c
docs: Add specific version install guide for `consul-k8s` CLI, refactor install (#12114)
* docs: Add specific version install guide for `consul-k8s` CLI

* parameterize version

* remove extra path

* Update k8s-cli.mdx

* slight formatting

* Update k8s-cli.mdx

* specific version details in overall install guide

* shell details

* Update install.mdx

* Update k8s-cli.mdx

* Update install.mdx

* broken link

* typo

* Update website/content/docs/k8s/installation/compatibility.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* Update website/content/docs/k8s/installation/install.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>

* moving install cli commands to separate page

* add tabs, wip

* add specific distro install guides

* add upgrade tabs

* build failure

* not sure why heading is not working

* remove whitespace

* add more whitespace

* fixes on formatting

* remove package lock

* add back package lock json

* test

* latest

* remove modified file

* adding fix to yum install

* create folder for upgrade and move upgrade cli there

* revert package-lock

* adding upgrade file

* Update website/content/docs/k8s/upgrade/upgrade-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update website/content/docs/k8s/installation/install-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update website/content/docs/k8s/installation/install-cli.mdx

Co-authored-by: Thomas Eckert <teckert@hashicorp.com>

* Update install-cli.mdx

* multi-line copy

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
Co-authored-by: Thomas Eckert <teckert@hashicorp.com>
2022-01-20 08:26:31 -08:00
Blake Covarrubias e3f36ad45c docs: Fix spelling errors 2022-01-11 09:37:09 -08:00
David Yu 2df20d13d5
docs: clarification on Limitations for Vault Secrets backend (#11885)
* docs: clarification on Limitations for Vault Secrets backend

* address typo in CLI docs

* Update index.mdx

* Update index.mdx
2021-12-17 14:38:12 -08:00
David Yu 147c6724d5
docs: remove BETA from Consul K8s CLI (#11863)
* docs: remove BETA from Consul K8s CLI
2021-12-16 20:26:48 -08:00
David Yu 6defa9ddb8
docs: add `brew install hashicorp/tap/consul-k8s` and re-order install and uninstall workflows (#11489)
* docs: add `brew install hashicorp/tap/consul-k8s`

* add consul k8s cli brew install to reference

* Update k8s-cli.mdx

* split home-brew commands into two steps

* Update k8s-cli.mdx

* slight changes on recommended way of installing Consul K8s for CLI or multi-DC

* Update install.mdx

* reorder cli and helm uninstall

* Update website/content/docs/k8s/installation/install.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/k8s/installation/install.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/k8s/installation/install.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/k8s/installation/install.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-11-05 16:33:11 -07:00
David Yu 1dcb949306
docs: add -verbose flag for install command (#11447) 2021-10-29 12:08:23 -07:00
David Yu cd78a9b71c
docs: re-do docs update for consul k8s cli beta (#11341)
* docs: re-do docs update for consul k8s cli beta

* Update website/content/docs/k8s/k8s-cli.mdx

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* removing sentence fragment

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-10-19 12:48:49 -07:00
trujillo-adam 3cebcd053d fixed command in install section 2021-10-04 18:45:57 -07:00
trujillo-adam 853512f479 added version flag to consul-k8s cli docs 2021-10-04 16:05:32 -07:00
David Yu 10b52a284b
docs: consul-k8s cli install, add `bin/` to source path (#11146)
Add `bin/` to path from which you move `consul-k8s` to `/usr/local/bin/consul-k8s`
2021-09-27 22:11:54 -07:00
trujillo-adam 52f82f2831 adding timeout flags, wait flag, and updated build procedure 2021-09-23 16:07:56 -07:00
trujillo-adam f0815f9cc2 removed extra codeblock ticks, again 2021-09-20 14:44:38 -07:00
trujillo-adam bf72046737 fixed formatting 2021-09-20 14:40:36 -07:00
trujillo-adam 183b021767 applied additional feedback, updated uninstall flags 2021-09-16 16:32:13 -07:00