consul icon indicating copy to clipboard operation
consul copied to clipboard

Add links to reference arch in storage class helm values

Open im2nguyen opened this issue 3 years ago • 2 comments

Description

Add links to reference arch in storage class helm values.

Most customers are using default values for storageclass for Consul helm chart which is not suitable for running enterprise workloads and since Consul is write limited by disk I/O and as per reference architecture it needs disk with minimum of 3000+ IOPS ( even for Dev clusters) this can result in performance issues.

Testing & Reproduction steps

  • In the case of bugs, describe how to replicate
  • If any manual tests were done, document the steps and the conditions to replicate
  • Call out any important/ relevant unit tests, e2e tests or integration tests you have added or are adding

Links

Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section.

Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links.

PR Checklist

  • [ ] updated test coverage
  • [ ] external facing docs updated
  • [ ] not a security concern

im2nguyen avatar Sep 12 '22 17:09 im2nguyen

Hey @boruszak, I'm going to temporarily merge these changes.

Going to go back and update the corresponding ones in consul-k8s since these changes were auto-generated from there. Here's the associated PR from the upstream repo: https://github.com/hashicorp/consul-k8s/pull/1493

There's also a bunch of links that aren't rendering correctly due to helm shenanigans

im2nguyen avatar Sep 12 '22 19:09 im2nguyen

driving by with a comment that maybe we should tag consul-docs team for reviews of the source file in consul-k8s repo sometime since it's auto-generated?

kschoche avatar Sep 12 '22 20:09 kschoche

I believe we can close these as these changes are now already reflected on consul.io due to the PR @im2nguyen made to consul-k8s

david-yu avatar Sep 28 '22 21:09 david-yu