Commit Graph

265 Commits

Author SHA1 Message Date
Luke Kysow c010fa076d
Document default storage class requirements (#11492) 2021-11-05 11:27:49 -07:00
David Yu a96a035973
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 37e051ed36 Update namespaced replication token example 2021-11-03 15:33:30 -04:00
Thomas Eckert 4789e3a4d0
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 571cff9dc9
docs: add -verbose flag for install command (#11447) 2021-10-29 12:08:23 -07:00
David Yu c3a1895f2e
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 e184ccc8e0
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 5f3dad4db2
docs: minor Consul K8s changes (#11402)
* docs: minor Consul K8s changes
2021-10-25 10:00:10 -07:00
David Yu 4d1490d16f
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 7b70eec218
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 8d49f51d2f
Update docs for consul-k8s v0.35.0 (#11349) 2021-10-18 15:44:43 -04:00
David Yu eb414d4884
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 aa82a43759 fixed command in install section 2021-10-04 18:45:57 -07:00
trujillo-adam 0efa13406e added version flag to consul-k8s cli docs 2021-10-04 16:05:32 -07:00
Luke Kysow ab0bfcd3ca
Add TOC to helm reference (#11144) 2021-09-28 16:25:40 -07:00
Luke Kysow e71a042bcc
Fix broken link (#11171) 2021-09-28 14:04:33 -07:00
David Yu 208389f5ad
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 78a3b9f3e1 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 75a14772e8
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 7b7436515f adding timeout flags, wait flag, and updated build procedure 2021-09-23 16:07:56 -07:00
Ashwin Venkatesh d92a2478e6
Update docs (#11111) 2021-09-22 12:26:08 -04:00
trujillo-adam 7b49bdb882 removed extra codeblock ticks, again 2021-09-20 14:44:38 -07:00
trujillo-adam 09166dd000 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 426ea5a742 fixed formatting 2021-09-20 14:40:36 -07:00
trujillo-adam ad6f46ba53
Apply suggestions from code review
Co-authored-by: David Yu <dyu@hashicorp.com>
2021-09-20 14:38:51 -07:00
trujillo-adam c1ec3399c0 removed extra codeblock ticks 2021-09-20 11:04:04 -07:00
trujillo-adam 2209a3b075 fixed indentation on install page 2021-09-20 10:25:06 -07:00
trujillo-adam 4c427b5d9d removed extra codeblock tic 2021-09-20 10:19:27 -07:00
trujillo-adam 13d48eb064 updating the helm uninstall instructions 2021-09-17 15:11:10 -07:00
trujillo-adam 101069fcce fixing some syntax errors that didn't appear locally 2021-09-17 09:31:19 -07:00
trujillo-adam 4047b30815 applied additional feedback, updated uninstall flags 2021-09-16 16:32:13 -07:00
trujillo-adam bac7057a52 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 23e57c4992 removed flag, added flag, and applied feedback 2021-09-16 09:54:55 -07:00
trujillo-adam 08c1b0e2ca
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 69a6bb0ca4
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 cd13796bd4
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 a2f58bdbdf
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 84d0763302 added a few more nbsp to improve table readability 2021-09-15 11:59:30 -07:00
David Yu 6ae4d7bb70
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 d1554f7269 updates to the uninstall flags, preset descriptions 2021-09-15 11:55:14 -07:00
David Yu 994d06f363
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 cf58cd1e54 adding k8s-cli alpha docs 2021-09-14 12:25:24 -07:00
trujillo-adam 9bedec4006
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 2f92768b75 fixing the policy for configuring k8 clusters as secondary in federated arch 2021-09-02 15:26:41 -07:00
Dustin Clifford 27839b6d93
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 bb7b678617
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 bb9188bb45
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 8f625ae170
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 db59597cac 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 6cc451bd7f
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 6bcc864819 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 321e20af13
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 4d2bc76d62 docs: Fix spelling errors across website 2021-07-19 14:29:54 -07:00
Curt Marker 99be1dfd69
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 dcb90fb832
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 f6273fe5ba
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 14527dd005
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 0c8944f6f7
Add headings to Helm docs (#10562) 2021-07-06 11:23:10 -07:00
jkirschner-hashicorp 31bbab8ae7
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 b4a10443d1 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 4c3b1b8b7b 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 b43bd28be0
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 e128e38d9e
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 e4cf9fcc9c
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 c2cc9b6bda 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 e6e3e196db
docs: add docs for running a single Consul dc in multiple k8s clusters (#10508) 2021-06-29 14:23:36 -06:00
Ashwin Venkatesh 23ca62c606
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
David Yu 351c5e350d
docs: Remove Helm 2 mention in Consul K8s install and uninstall (#10517)
* docs: Remove Helm 2 mention in Consul K8s install and uninstall
Helm 2 is no longer supported via Consul K8s. Helm 3 is now the supported version for Consul K8s.
2021-06-29 09:18:08 -07:00
Mike Ajala 9a8c966f74
Update self-hosted-kubernetes.mdx (#10518)
Corrected typo, from you _mean_ need to you _may_ need.
2021-06-29 09:17:07 -07:00
David Yu e0a6946506
docs: Remove beta version references from Helm reference (#10477)
Removing references from the 1.10 beta that were included in Helm Configuration Reference
2021-06-24 09:08:33 -07:00
David Yu 2b4942b7f5
docs - Adding Mesh as CRD in Consul K8s (#10459)
* docs - Adding Mesh as CRD in Consul K8s
* Removing extra left brace in ServiceDefaults
2021-06-22 19:18:13 -07:00
Ashwin Venkatesh 33921549ae
update docs (#10405)
Consul 1.10 GA for Consul K8s
2021-06-22 16:41:53 -07:00
Iryna Shustava 2169266927
docs: update docs/k8s/connect to for tproxy GA. (#10408)
* Assume tproxy is enabled by default and connect to upstreams
  with kube DNS.
* Update docs for missing annotations.
2021-06-22 16:34:20 -07:00
David Yu dbb6889b72
docs: Update Consul K8s Compat Matrix for Consul 1.10 (#10456) 2021-06-22 16:27:04 -07:00
Blake Covarrubias 8b7123b585 Remove beta release callout on downloads page 2021-06-22 16:22:50 -07:00
Blake Covarrubias ebe1f1cb51 docs: Remove beta tag for 1.10 features
Remove beta tag for 1.10 features which are now GA.
2021-06-22 16:22:50 -07:00
David Yu 9867b87dff
docs: Remove Grafana from Observability section (#10454)
* Remove Grafana from Observability section

Reference Grafana Config in the learn guide
Co-authored-by: Blake Covarrubias <blake@covarrubi.as>
2021-06-22 14:31:45 -07:00
Kyle Schochenmaier 4146cd4dd4
Update health checks docs for tproxy (#10419)
* Update health checks docs for tproxy
Co-authored-by: Iryna Shustava <ishustava@users.noreply.github.com>
2021-06-21 13:48:07 -05:00
Ashwin Venkatesh 14b23f37c1 Update k8s license docs to account for license autoload 2021-06-16 14:59:34 -04:00
Luke Kysow 168fbbbed1
Update k8s term gateway docs to make address clear (#10389)
Previously if you were to follow these docs and register two external
services, you would set the Address field on the node. The second
registered service would change the address of the node for the first
service.

Now the docs explain the address key and how to register more than one
external service.
2021-06-14 09:15:40 -07:00
Jono Sosulska 3d7b85718e
Update Kubernetes docs to point to install pages. (#10293)
Adds more clear indicators that the collections on the learn.hashicorp.com sites have specific instructions for single node deployments.
Co-Authored by: soonoo <qpseh2m7@gmail.com>
2021-05-25 15:36:09 -04:00
allisaurus 13fcfca31e
docs: fix Amazon EKS service name (#10280) 2021-05-21 15:58:13 -07:00
Luke Kysow fb5d8c1505
Update k8s fed docs to clarify role of acl token (#10233) 2021-05-13 10:20:12 -07:00
Andy Assareh c7f4c6bbdf
K8s docs: Manual join: add note that kubeconfig not required (#9998)
Per Consul PM, kubeconfig is not required for manual join. I believe this should be clarified in the docs as the current wording refers to the auto join steps above which state kubeconfig is required.
2021-05-06 12:59:25 -06:00
Derek Strickland d11823804d
refactor get started links to new tutorial (#10066) 2021-04-20 13:17:50 -04:00
Iryna Shustava 1758a6dc54
docs: update helm ref docs and connect docs (#10032)
All k8s connect-related docs now need to mention that we require a Kubernetes service
for all Connect services
2021-04-16 12:49:02 -07:00
Zachary Shilton 5b53b5aef5
website: implement mktg 032 (#9953)
* website: migrate to new nav-data format

* website: clean up unused intro content

* website: remove deprecated sidebar_title from frontmatter

* website: add react-content to fix global style import issue
2021-04-07 15:50:38 -04:00
Iryna Shustava fcc7f280f2
docs: Update Helm reference docs (#9904) 2021-03-19 09:12:49 -07:00
Nitya Dhanushkodi 2965b858c9
Add metrics documentation (#9848) 2021-03-18 17:20:54 -07:00
Ranjandas 0a08c942c8 Add a sample error message 2021-03-02 12:48:03 +11:00
Ranjandas e2f1fa3ccf
Update vms-and-kubernetes.mdx 2021-03-02 10:20:24 +11:00
Ranjandas 9e63706d92
Added references to node name 2021-03-02 09:44:35 +11:00
Ranjandas 3790770af6
Update cert creation instruction for Federation
The Server certificates used for Federation require the node name in the form of `<node>.server.<dc>.<domain>`. Not having this would through `bad tls certificate` error.

* Fixed cert create command
* Added note to create a wildcard cert (like the ones on Kubernetes)
* Fixed numbering
2021-03-02 09:39:46 +11:00
Ashwin Venkatesh ea23b2171c
Update helm docs for consul-helm v0.30.0 (#9779) 2021-02-17 14:08:35 -05:00
Luke Kysow 8695402022
Docs describing migrating to CRDs (#9562)
* Document how users can migrate to CRDs.
* Update documentation for federation with new `ProxyDefaults`
requirement.
* Ensure `controller.enabled: true` is set in our example configs.
* Remove `connect-service-protocol` annotation docs.
2021-02-17 14:01:52 -05:00
Derek Strickland 8b91cae80f
Crosslink new microservices collection. (#9704) 2021-02-08 13:27:20 -05:00
David Yu 7247d9c0cb
docs: fix another broken link to upgrading k8s servers from token rotation page (#9707)
fix another broken link to upgrading k8s servers from token rotation page
2021-02-04 09:44:04 -08:00
David Yu 5c749d32f8
docs: Small change to fix broken link to k8s upgrade from k8s tls certs page (#9705)
Broken link to k8s server upgrade from tls certs page
2021-02-04 09:13:32 -08:00
Ashwin Venkatesh f7092a068f
Add docs for TLS Server Certificate rotation for K8S (#9636)
* Add docs for TLS Server Certificate rotation for K8s
2021-01-29 17:13:28 -05:00
Luke Kysow 320fcf4510
Add operations section to k8s notes (#9625)
* Add operations section to k8s notes

* Unify faq/troubleshooting
2021-01-29 11:15:40 -08:00
David Yu 23a5633aea
docs: Update Compat Matrix for Consul Helm 0.29 (#9657)
* docs: Update Compat Matrix for Consul Helm 0.29

Adding 0.29

* Update compatibility.mdx
2021-01-27 14:39:03 -08:00
Ashwin Venkatesh fbf106446d Update docs with fields for ingress support for consul UI 2021-01-22 12:19:43 -05:00
Luke Kysow 4217488e78
Move cfg entry docs to under connect from agent (#9533)
Since all config entries are currently related to service mesh it's a
much more natural place to look for them under Service Mesh than under
Agent.
2021-01-13 12:48:48 -08:00
Luke Kysow a89461cc95
Update k8s gateway docs for CRDs (#9538) 2021-01-08 14:30:41 -08:00
Nitya Dhanushkodi 9e58147c30
Document how clients not on K8s can join a DC in K8s. (#9438) 2021-01-07 16:14:07 -08:00
Luke Kysow 72db0cc6d3
Document CRDs and kube namespaces (#9502)
* Document CRDs and kube namespaces
2021-01-07 11:22:06 -08:00
Luke Kysow 76e72de6d3
Document Kube CRDs alongside config entry docs
* Adds a new react component `ConfigEntryReference` that allows us to
document config entries for both HCL and Kubernetes CRDs.
* Rewrites config entry docs to use new component
* Add CRD examples alongside HCL examples
* Removes examples from Kube CRD doc because the examples are now in the
main CRD docs
2021-01-05 09:40:43 -08:00
Iryna Shustava b5498642d0
Update Helm reference docs (#9463) 2020-12-23 11:42:36 -08:00
David Yu 2a2f8c7394
Update with 0.28 (#9450) 2020-12-21 13:24:33 -08:00
Ashwin Venkatesh 45bfa8101d
Merge pull request #9431 from hashicorp/gen-docs2
Ensure type shown for maps in k8s docs
2020-12-18 15:07:14 -05:00
Nitya Dhanushkodi 21d3b29f93
Update helm docs for external client agents. (#9429) 2020-12-18 09:18:17 -08:00
Blake Covarrubias 8fc383c28e docs: Remove beta tag for 1.8 and 1.9 features
Remove beta tag for 1.8 and 1.9 features which are now GA.
2020-12-17 16:51:35 -08:00
Luke Kysow 41020f73bd
Ensure type shown for maps in k8s docs 2020-12-17 16:27:02 -08:00
Luke Kysow 4d6dc1fd8f
Use generated helm docs (#9324) 2020-12-17 10:47:54 -08:00
Jeff Escalante fe3902c906
maintenance complete, pending markdown-page component addition 2020-12-16 16:55:23 -05:00