Commit Graph

198 Commits

Author SHA1 Message Date
David Yu a17c78ab21
docs: Formatting for Consul K8s uninstall commands (#12031)
* docs: Missing $ prior to command for Consul K8s uninstall

* re-do numer bullets was mis-numbered

* Update uninstall.mdx

* simplify wording
2022-01-12 09:16:42 -08:00
vanphan24 e765343983
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:57:14 -08:00
vanphan24 f4c5c2cf16
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:57:09 -08:00
vanphan24 6e2c0a3f00
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:57:02 -08:00
vanphan24 f1c872604f
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:56:58 -08:00
vanphan24 3e65685dbd
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:56:53 -08:00
vanphan24 4dd4349897
Update website/content/docs/k8s/installation/vault/server-tls.mdx
Co-authored-by: mrspanishviking <cardenas88karl@gmail.com>
2022-01-12 08:56:33 -08:00
vanphan24 196d5fdeb7
Update server-tls.mdx
Added k8s auth role for client
Added to Consul yaml file: tls.enableAutoEncrypt: true
Fixed name of CA policy: policies=ca-policy
2022-01-12 08:46:55 -08:00
vanphan24 a10382e5d1
Clarifies external CA config
It is not clear that this page is to configure an external CA for Connect CA. Added line to clarify that this page is for configuring external CA's for the Connect CA. For the built-in CA, no config is needed.
2022-01-11 13:22:50 -08:00
David Yu d20230fac1
docs: Update uninstall to ensure CRDs are deleted (#12021)
* docs: Update uninstall to ensure CRDs are deleted

* Update website/content/docs/k8s/operations/uninstall.mdx

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>

* add more details around CRD deletion

* move around crd deletion to before unsintall

* slight wording

* move deletion of CRDs to first line

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2022-01-11 12:53:39 -08:00
Blake Covarrubias e3f36ad45c docs: Fix spelling errors 2022-01-11 09:37:09 -08:00
Jasmine W a4af0a6bb0
Merge pull request #12002 from hashicorp/kubernetes-service-screenshot
added screenshot of k8s service
2022-01-11 11:34:00 -05:00
Jasmine W 4aeee82661 pushing for circleci 2022-01-11 11:16:24 -05:00
Natalie Smith 24c67f2dfa docs: simplify agent docs slugs 2022-01-10 17:37:18 -08:00
Natalie Smith 00c2444cfc docs: fix external links to agent config pages 2022-01-10 17:11:50 -08:00
Jake Herschman 5460c0c0f6 fixed duplicated image path 2022-01-10 19:08:16 -05:00
Jake Herschman 2994a78c97 updated datacenter dropdown image 2022-01-10 18:38:41 -05:00
Jake Herschman ee3efc0468 updated topology image 2022-01-10 18:37:51 -05:00
Jasmine W e94525c216 added screenshot of k8s service 2022-01-10 15:57:15 -05:00
David Yu 1b65760782
docs: Fix indentation for gossipEncryption when using Vault secrets backend 2022-01-05 21:35:28 -08:00
David Yu 6bef2b2eb4
docs: Clarification of Vault Consul K8s requirements for Auth Method (#11929)
* docs: Clarification of Vault Consul K8s requirements

* link back to requirements

* Update gossip.mdx

* Update index.mdx

* add details for K8s auth method requirement

* Update gossip.mdx

* Update server-tls.mdx

* Update connect-ca.mdx

* Update gossip.mdx

* Update server-tls.mdx

* Update website/content/docs/k8s/installation/vault/gossip.mdx

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

* Update website/content/docs/k8s/installation/vault/index.mdx

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

* Update website/content/docs/k8s/installation/vault/index.mdx

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

* Update website/content/docs/k8s/installation/vault/index.mdx

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

* Update website/content/docs/k8s/installation/vault/server-tls.mdx

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

* Update website/content/docs/k8s/installation/vault/index.mdx

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

* Update website/content/docs/k8s/installation/vault/index.mdx

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

* Update index.mdx

* Update index.mdx

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2022-01-03 14:17:55 -08:00
Artem Kozlenkov 06e547a5b6
add the missing `-n consul` namespace to `k pf ..` 2021-12-27 17:54:35 +01:00
Artem Kozlenkov e45ae6d17e
Update install.mdx
add port-forwad missing namespace flag
2021-12-27 17:50:49 +01:00
Blake Covarrubias 0db9f05eea Minor doc fixes to K8s CA and Admin Partitions guides
K8s Vault CA config docs:

* Re-add filename label on K8s Connect CA config.
* Remove call to `jq` when retrieving CA configuration.
* Clarify `connect.ca_config` and `connect.ca_provider` agent configs
are only used at cluster initialization.

Admin Partitions tutorial:

* Fix Helm client values filename.
* Use kubectl's template output to base64 decode Consul bootstrap token.
2021-12-21 12:30:29 -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 bd011ab7b6
docs: ExportedServices YAML correction (#11883)
* docs: ExportedServices YAML correction

* Add enterprise alert to CRD index
2021-12-17 11:29:10 -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
Kyle Schochenmaier 1d5fba753c
docs: consul-vault kubernetes integration docs (#11766)
* Add documentation for the consul with vault integration that covers Server TLS, Connect CA and gossip encryption

Co-authored-by: David Yu <dyu@hashicorp.com>
Co-authored-by: Iryna Shustava <iryna@hashicorp.com>
2021-12-15 12:59:36 -06:00
Ashwin Venkatesh b71fff9f1c
update docs (#11784) 2021-12-08 21:21:46 -05:00
freddygv ed6076db26 Rename partition-exports to exported-services
Using a name less tied to partitions gives us more flexibility to use
this config entry in OSS for exports between datacenters/meshes.
2021-12-03 17:47:31 -07:00
trujillo-adam 0fb360211a addtional feedback; added PartitionExports to CRDs section 2021-11-30 11:18:12 -08:00
David Yu f1d1c12ad5
docs: provide more example CLI commands and reference Vault (#11528)
* docs: provide more example CLI commands and reference Vault

* Extra formatting

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

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

* adding more detail around gossip encryption rotation precautions

* Update website/content/docs/k8s/operations/gossip-encryption-key-rotation.mdx

Co-authored-by: Matt Keeler <mkeeler@users.noreply.github.com>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: Matt Keeler <mkeeler@users.noreply.github.com>
2021-11-10 12:05:20 -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
Luke Kysow 5caee36a76
Document default storage class requirements (#11492) 2021-11-05 11:27:49 -07:00
David Yu 8f8055352d
docs: consul-k8s uninstall with namespace (#11478)
* docs:  consul-k8s uninstall with namespace

Uninstall with namespace

* change release name to consul in uninstall

* Update website/content/docs/k8s/operations/uninstall.mdx

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

* add --create-namespace command to install for custom values file

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
2021-11-03 16:48:48 -07:00
Kyle Rarey a775e9a274 Update namespaced replication token example 2021-11-03 15:33:30 -04:00
Thomas Eckert 875fa920c9
Update Helm Docs for v0.36.0 Consul K8s release (#11483)
Co-authored-by: David Yu <dyu@hashicorp.com>
2021-11-03 10:04:16 -07:00
David Yu 1dcb949306
docs: add -verbose flag for install command (#11447) 2021-10-29 12:08:23 -07:00
David Yu 823026e319
docs: revised Helm install to create namespace and install on dedicated namespace (#11440)
* docs: revised Helm install to create namespace and install on dedicated Consul namespace

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

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

* Update install.mdx

* changing to Helm 3.2+ as a pre-req to make it easier to follow
* might as well bump to latest version

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2021-10-28 12:27:00 -07:00
David Yu fc68feec65
docs: Move consul-k8s architecture docs to Overview (#11414)
* docs: Move consul-k8s architecture docs to Overview
2021-10-25 15:33:41 -07:00
David Yu 6e3fbf1ece
docs: minor Consul K8s changes (#11402)
* docs: minor Consul K8s changes
2021-10-25 10:00:10 -07:00
David Yu d17459a7e3
docs: bump reference to consul-k8s cli to beta and reformat helm config example (#11398) 2021-10-22 09:14:35 -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
Ashwin Venkatesh f9e6831fa2
Update docs for consul-k8s v0.35.0 (#11349) 2021-10-18 15:44:43 -04:00
David Yu 8988427086
docs: Remove Ambassador docs since they are outdated and link to Learn Guide (#11251)
* docs: Remove Ambassador docs since they are outdated
* Relink to Learn guide
2021-10-08 09:05:25 -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
Luke Kysow dfc74f56f5
Add TOC to helm reference (#11144) 2021-09-28 16:25:40 -07:00
Luke Kysow 410d57879c
Fix broken link (#11171) 2021-09-28 14:04:33 -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
Blake Covarrubias 94d3849472 docs: Decode K8s secrets with base64decode function
Use kubectl's base64decode template function (added in K8s 1.11) to
decode values in Secrets. Removes external call to `base64` utility on
the host system.
2021-09-24 08:59:34 -07:00
trujillo-adam b22684540e
Merge pull request #11028 from hashicorp/docs-k8s-cli-alpha
adding k8s-cli alpha docs
2021-09-23 16:35:56 -07:00
trujillo-adam 52f82f2831 adding timeout flags, wait flag, and updated build procedure 2021-09-23 16:07:56 -07:00
Ashwin Venkatesh fd7f670f12
Update docs (#11111) 2021-09-22 12:26:08 -04:00
trujillo-adam f0815f9cc2 removed extra codeblock ticks, again 2021-09-20 14:44:38 -07:00
trujillo-adam 1700dab2e6 Merge branch 'docs-k8s-cli-alpha' of github.com:hashicorp/consul into docs-k8s-cli-alpha
implementing feedback
2021-09-20 14:42:09 -07:00
trujillo-adam bf72046737 fixed formatting 2021-09-20 14:40:36 -07:00
trujillo-adam 4aa40ccbe1
Apply suggestions from code review
Co-authored-by: David Yu <dyu@hashicorp.com>
2021-09-20 14:38:51 -07:00
trujillo-adam 9863054362 removed extra codeblock ticks 2021-09-20 11:04:04 -07:00
trujillo-adam c6eae6858c fixed indentation on install page 2021-09-20 10:25:06 -07:00
trujillo-adam faee67e35b removed extra codeblock tic 2021-09-20 10:19:27 -07:00
trujillo-adam 0722e17e93 updating the helm uninstall instructions 2021-09-17 15:11:10 -07:00
trujillo-adam 2cc678d388 fixing some syntax errors that didn't appear locally 2021-09-17 09:31:19 -07:00
trujillo-adam 183b021767 applied additional feedback, updated uninstall flags 2021-09-16 16:32:13 -07:00
trujillo-adam 0a3ded7dcc Merge branch 'docs-k8s-cli-alpha' of github.com:hashicorp/consul into docs-k8s-cli-alpha
removed name flag from install, added config-file flag, applied feedback
2021-09-16 10:13:04 -07:00
trujillo-adam bacd9423e0 removed flag, added flag, and applied feedback 2021-09-16 09:54:55 -07:00
trujillo-adam ef9c1776dd
Update website/content/docs/k8s/k8s-cli.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:32:21 -07:00
trujillo-adam 470fba1a0e
Update website/content/docs/k8s/installation/install.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:31:43 -07:00
trujillo-adam b8d1e205cd
Update website/content/docs/k8s/index.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:31:17 -07:00
trujillo-adam 5987900fd3
Update website/content/docs/k8s/installation/install.mdx
Co-authored-by: Nitya Dhanushkodi <nitya@hashicorp.com>
2021-09-15 20:30:58 -07:00
trujillo-adam a25a30921a added a few more nbsp to improve table readability 2021-09-15 11:59:30 -07:00
David Yu f58418f811
docs: Reformat Uninstall steps (#11040)
* docs: Reformat Uninstall steps

Reformatting uninstall as steps to make uninstall instructions more clear.
2021-09-15 11:59:02 -07:00
trujillo-adam dfb4775712 updates to the uninstall flags, preset descriptions 2021-09-15 11:55:14 -07:00
David Yu 4e26d94080
docs: Remove step for deleting webhook-cert-manager secret on Consul K8s uninstall (#11035)
* Remove step for deleting webhook-cert-manager secret
* Update website/content/docs/k8s/operations/uninstall.mdx
2021-09-15 08:11:22 -07:00
trujillo-adam e35236a053 adding k8s-cli alpha docs 2021-09-14 12:25:24 -07:00
trujillo-adam 0ee554ea54
Update website/content/docs/k8s/installation/multi-cluster/vms-and-kubernetes.mdx
Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
2021-09-07 07:53:57 -07:00
trujillo-adam 7cb56d6a9b fixing the policy for configuring k8 clusters as secondary in federated arch 2021-09-02 15:26:41 -07:00
Dustin Clifford c9ff4bfac8
docs: Bad External VM Example (#10943)
Adds a missing `\` for continuation in the example command for
connecting an external VM client outside of Kubernetes to the Consul
server cluster.
2021-08-27 11:38:55 -07:00
Luke Kysow dda8efc612
Update helm reference (#10939)
* Update helm reference

* Fix docs issue breaking build

* Remove keys that aren't yet in the release
2021-08-26 17:58:59 -07:00
sridhar 0081443567
Merge pull request #10673 from hashicorp/srikrishmurthy-patch-1
Updated a note in the ingress-gateway YAML that the ingress gateway name must match with what's configured in the helm chart
2021-08-25 17:35:00 -07:00
sridhar cf66becabe
Update website/content/docs/k8s/connect/ingress-gateways.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-17 16:32:35 -07:00
Blake Covarrubias 99b1d8ed8c docs: Update code blocks across website
* Use CodeTabs for examples in multiple formats.
* Ensure correct language on code fences.
* Use CodeBlockConfig for examples with filenames, or which need
highlighted content.
2021-08-11 13:20:03 -07:00
sridhar 8b4672f644
Update website/content/docs/k8s/connect/ingress-gateways.mdx
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-08-04 16:25:36 -07:00
Jared Kirschner ccc8c9b128 Generalize base64 command usage in docs
The base64 CLI utility has two different short flag arguments for decode
depending on the platform: -D and -d.

Previously, the docs used the -D flag exclusively with the base64 utility.
Luckily, the long form of the flag is the same across platforms: --decode.

All uses of the base64 -D flag have been replaced with --decode.
2021-07-28 11:40:35 -04:00
sridhar d4d62a5667
Update ingress-gateways.mdx
Updated a note in the ingress-gateway YAML that the ingress gateway name must match with what's configured in the helm chart
2021-07-21 16:18:40 -07:00
Blake Covarrubias 832896ed11 docs: Fix spelling errors across website 2021-07-19 14:29:54 -07:00
Curt Marker eb3e9271d3
Fixed a typo that broke the example static-server deployment (#10582)
The service account was typo'd and needs to be fixed
2021-07-12 13:28:36 -07:00
Daniel Nephin ec6da0859d
Merge pull request #10570 from hashicorp/copy-of-master
Changes that were accidentally merged into the old master branch
2021-07-08 16:28:56 -04:00
David Yu fc411b2313
docs: Update docs to reflect limitation in TProxy when using single Consul DC deployment with multiple k8s clusters (#10549)
* docs: Update to reflect single Consul DC deployment with multiple k8s clusters
2021-07-08 10:44:29 -07:00
Daniel Nephin 2c4f22a9f0
Merge pull request #10552 from hashicorp/dnephin/ca-remove-rotation-period
ca: remove unused RotationPeriod field
2021-07-06 18:49:33 -04:00
Luke Kysow 75b21259a1
Add headings to Helm docs (#10562) 2021-07-06 11:23:10 -07:00
jkirschner-hashicorp 5f73de6fbc
Merge pull request #10560 from jkirschner-hashicorp/change-sane-to-reasonable
Replace use of 'sane' where appropriate
2021-07-06 11:46:04 -04:00
Daniel Nephin 3a045cca8d ca: remove unused RotationPeriod field
This field was never used. Since it is persisted as part of a map[string]interface{} it
is pretty easy to remove it.
2021-07-05 19:15:44 -04:00
Jared Kirschner bd536151e1 Replace use of 'sane' where appropriate
HashiCorp voice, style, and language guidelines recommend avoiding ableist
language unless its reference to ability is accurate in a particular use.
2021-07-02 12:18:46 -04:00
David Yu 619eb5875d
docs: Formatting for Ingress Controllers example repos (#10542)
* docs: Formatting for Ingress Controllers example repos
* Update ingress-controllers.mdx
2021-07-01 10:48:40 -07:00
Kyle Schochenmaier 307f49dd31
docs: Ingress controllers configurations (#10495)
Add high level documentation on how to enable ingress controllers in consul on k8s.

Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
Co-authored-by: Luke Kysow <1034429+lkysow@users.noreply.github.com>
2021-07-01 11:24:27 -05:00
David Yu c3f0e395f0
docs: remove alpha from 1.10.0 reference for observability on k8s metrics merging (#10528)
The docs note an alpha pre-release version on K8s observability. Updating to only reference the GA 1.10.0 version of Consul for observability on k8s and metrics merging.
2021-06-30 12:18:19 -07:00
Daniel Nephin 4d741531b4 Update references to the main branch
The main branch is being renamed from master->main. This commit should
update all references to the main branch to the new name.

Co-Authored-By: Mike Morris <mikemorris@users.noreply.github.com>
2021-06-29 17:17:38 -04:00
Iryna Shustava 1c0beefc73
docs: add docs for running a single Consul dc in multiple k8s clusters (#10508) 2021-06-29 14:23:36 -06:00
Ashwin Venkatesh 48069d18dd
Add docs for gossip encryption key rotation (#10522)
* Add docs for gossip encryption key rotation with feedback from David, Kyle and Luke.
2021-06-29 14:45:19 -04:00