Add links to reference arch in storage class helm values #14572
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
im2nguyen
added
type/docs
boruszak
approved these changes
Sep 12, 2022
| @@ -295,14 +295,14 @@ Use these links to navigate to a particular top-level stanza. | |||
|
|
|||
| - `controller` ((#v-global-secretsbackend-vault-controller)) | |||
|
|
|||
| - `tlsCert` ((#v-global-secretsbackend-vault-controller-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on | |||
| - `tlsCert` ((#v-global-secretsbackend-vault-controller-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on | |||
There was a problem hiding this comment.
Suggested change
| - `tlsCert` ((#v-global-secretsbackend-vault-controller-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on | |
| - `tlsCert` ((#v-global-secretsbackend-vault-controller-tlscert)) - Configuration to the Vault Secret that Kubernetes uses on |
Present tense instead of future tense, per style guide
| Kubernetes CRD creation, deletion, and update, to get TLS certificates | ||
| used issued from vault to send webhooks to the controller. | ||
|
|
||
| - `secretName` ((#v-global-secretsbackend-vault-controller-tlscert-secretname)) (`string: null`) - The Vault secret path that issues TLS certificates for controller | ||
| webhooks. | ||
|
|
||
| - `caCert` ((#v-global-secretsbackend-vault-controller-cacert)) - Configuration to the Vault Secret that Kubernetes will use on | ||
| - `caCert` ((#v-global-secretsbackend-vault-controller-cacert)) - Configuration to the Vault Secret that Kubernetes will use on |
There was a problem hiding this comment.
Suggested change
| - `caCert` ((#v-global-secretsbackend-vault-controller-cacert)) - Configuration to the Vault Secret that Kubernetes will use on | |
| - `caCert` ((#v-global-secretsbackend-vault-controller-cacert)) - Configuration to the Vault Secret that Kubernetes uses on |
| @@ -311,14 +311,14 @@ Use these links to navigate to a particular top-level stanza. | |||
|
|
|||
| - `connectInject` ((#v-global-secretsbackend-vault-connectinject)) | |||
|
|
|||
| - `caCert` ((#v-global-secretsbackend-vault-connectinject-cacert)) - Configuration to the Vault Secret that Kubernetes will use on | |||
| - `caCert` ((#v-global-secretsbackend-vault-connectinject-cacert)) - Configuration to the Vault Secret that Kubernetes will use on | |||
There was a problem hiding this comment.
Suggested change
| - `caCert` ((#v-global-secretsbackend-vault-connectinject-cacert)) - Configuration to the Vault Secret that Kubernetes will use on | |
| - `caCert` ((#v-global-secretsbackend-vault-connectinject-cacert)) - Configuration to the Vault Secret that Kubernetes uses on |
| Kubernetes pod creation, deletion, and update, to get CA certificates | ||
| used issued from vault to send webhooks to the ConnectInject. | ||
|
|
||
| - `secretName` ((#v-global-secretsbackend-vault-connectinject-cacert-secretname)) (`string: null`) - The Vault secret path that contains the CA certificate for | ||
| Connect Inject webhooks. | ||
|
|
||
| - `tlsCert` ((#v-global-secretsbackend-vault-connectinject-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on | ||
| - `tlsCert` ((#v-global-secretsbackend-vault-connectinject-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on |
There was a problem hiding this comment.
Suggested change
| - `tlsCert` ((#v-global-secretsbackend-vault-connectinject-tlscert)) - Configuration to the Vault Secret that Kubernetes will use on | |
| - `tlsCert` ((#v-global-secretsbackend-vault-connectinject-tlscert)) - Configuration to the Vault Secret that Kubernetes uses on |
| @@ -564,7 +564,7 @@ Use these links to navigate to a particular top-level stanza. | |||
| - `enabled` ((#v-global-openshift-enabled)) (`boolean: false`) - If true, the Helm chart will create necessary configuration for running | |||
| its components on OpenShift. | |||
|
|
|||
| - `consulAPITimeout` ((#v-global-consulapitimeout)) (`string: 5s`) - The time in seconds that the consul API client will wait for a response from | |||
| - `consulAPITimeout` ((#v-global-consulapitimeout)) (`string: 5s`) - The time in seconds that the consul API client will wait for a response from | |||
There was a problem hiding this comment.
Suggested change
| - `consulAPITimeout` ((#v-global-consulapitimeout)) (`string: 5s`) - The time in seconds that the consul API client will wait for a response from | |
| - `consulAPITimeout` ((#v-global-consulapitimeout)) (`string: 5s`) - The time in seconds that the consul API client waits for a response from |
| to be automatically created. For example, to use local | ||
| (https://kubernetes.io/docs/concepts/storage/storage-classes/#local) | ||
| to be automatically created. For example, to use | ||
| local(https://kubernetes.io/docs/concepts/storage/storage-classes/#local) |
There was a problem hiding this comment.
Suggested change
| local(https://kubernetes.io/docs/concepts/storage/storage-classes/#local) | |
| [local storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/#local), |
I assume that the intent was to add a link here. Missing brackets + when possible, include multiple words in hyperlinks to make the link text more descriptive.
| to be automatically created. For example, to use local | ||
| (https://kubernetes.io/docs/concepts/storage/storage-classes/#local) | ||
| to be automatically created. For example, to use | ||
| local(https://kubernetes.io/docs/concepts/storage/storage-classes/#local) | ||
| storage classes, the PersistentVolumeClaims would need to be manually created. |
There was a problem hiding this comment.
Suggested change
| storage classes, the PersistentVolumeClaims would need to be manually created. | |
| the PersistentVolumeClaims would need to be manually created. |
To match link fix above.
| storage classes, the PersistentVolumeClaims would need to be manually created. | ||
| A `null` value will use the Kubernetes cluster's default StorageClass. If a default | ||
| StorageClass does not exist, you will need to create one. | ||
| See https://www.consul.io/docs/install/performance#read-write-tuning for considerations around choosing a | ||
| performant storage class. | ||
| Refer to the [Read/Write Tuning](https://www.consul.io/docs/install/performance#read-write-tuning) |
There was a problem hiding this comment.
Suggested change
| Refer to the [Read/Write Tuning](https://www.consul.io/docs/install/performance#read-write-tuning) | |
| Refer to the [Read/Write Tuning](/docs/install/performance#read-write-tuning) |
| @@ -1566,7 +1571,7 @@ Use these links to navigate to a particular top-level stanza. | |||
| - `disruptionBudget` ((#v-connectinject-disruptionbudget)) - This configures the PodDisruptionBudget (https://kubernetes.io/docs/tasks/run-application/configure-pdb/) | |||
| for the service mesh sidecar injector. | |||
|
|
|||
| - `enabled` ((#v-connectinject-disruptionbudget-enabled)) (`boolean: true`) - This will enable/disable registering a PodDisruptionBudget for the | |||
| - `enabled` ((#v-connectinject-disruptionbudget-enabled)) (`boolean: true`) - This will enable/disable registering a PodDisruptionBudget for the | |||
There was a problem hiding this comment.
Suggested change
| - `enabled` ((#v-connectinject-disruptionbudget-enabled)) (`boolean: true`) - This will enable/disable registering a PodDisruptionBudget for the | |
| - `enabled` ((#v-connectinject-disruptionbudget-enabled)) (`boolean: true`) - This value enables or disables a registering a PodDisruptionBudget for the |
| @@ -1578,7 +1583,7 @@ Use these links to navigate to a particular top-level stanza. | |||
|
|
|||
| - `cni` ((#v-connectinject-cni)) - Configures consul-cni plugin for Consul Service mesh services | |||
|
|
|||
| - `enabled` ((#v-connectinject-cni-enabled)) (`boolean: false`) - If true, then all traffic redirection setup will use the consul-cni plugin. | |||
| - `enabled` ((#v-connectinject-cni-enabled)) (`boolean: false`) - If true, then all traffic redirection setup will use the consul-cni plugin. | |||
There was a problem hiding this comment.
Suggested change
| - `enabled` ((#v-connectinject-cni-enabled)) (`boolean: false`) - If true, then all traffic redirection setup will use the consul-cni plugin. | |
| - `enabled` ((#v-connectinject-cni-enabled)) (`boolean: false`) - If true, then all traffic redirection setup uses the consul-cni plugin. |
|
Hey @boruszak, I'm going to temporarily merge these changes. Going to go back and update the corresponding ones in There's also a bunch of links that aren't rendering correctly due to helm shenanigans |
|
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? |
|
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add links to reference arch in storage class helm values.
Testing & Reproduction steps
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