Generate helm docs for release consul-k8s 1.1.2#17568
Conversation
curtbushko
added
type/docs
website/content/docs/k8s/helm.mdx
Outdated
| - [tests ((#h-tests))](#tests-h-tests) | ||
| - [Helm Chart Examples](#helm-chart-examples) | ||
| - [Customizing the Helm Chart](#customizing-the-helm-chart) | ||
| - [`global`](#h-global) |
There was a problem hiding this comment.
Looks like it's missing the top level hierarchy here? Not sure why that happened
There was a problem hiding this comment.
I am not sure... I just ran the generation...
There was a problem hiding this comment.
I see what happened @eddie-rowe looks like you introduce some more text into the generated page via this PR: https://github.com/hashicorp/consul/pull/17032/files.
I assume safe to override your changes? We need to change the way we generate this file if you want those changes to persist as this page is actually maintained via golang code MDX generation.
There was a problem hiding this comment.
Interesting - I don't remember changing any of those higher level values.. maybe that was from a merge with another branch or resolving conflicts?
My changes for this particular page were to fix these broken links related to cluster peering:
There was a problem hiding this comment.
@trujillo-adam @boruszak - do you have any perspective on these mentioned changes?
There was a problem hiding this comment.
It would be better to implement Eddie's changes in the source code we generate this reference docs from, but it looks like we are already redirecting properly -- I think it's safe to overwrite his changes.
im2nguyen
left a comment
im2nguyen
left a comment
There was a problem hiding this comment.
are these changes generated from consul-k8s? if not, we should make the updates in https://github.com/hashicorp/consul-k8s, we might only need this to update the header table of contents
|
|
||
| - `domain` ((#v-global-domain)) (`string: consul`) - The domain Consul will answer DNS queries for | ||
| (Refer to [`-domain`](/consul/docs/agent/config/cli-flags#_domain)) and the domain services synced from | ||
| (Refer to [`-domain`](https://developer.hashicorp.com/consul/docs/agent/config/cli-flags#_domain)) and the domain services synced from |
There was a problem hiding this comment.
is there a reason why you want to use absolute links instead? we prefer relative links whenever possible (same for the rest of these changes)
There was a problem hiding this comment.
this is auto-generated from the helm chart! feel free to disregard this comment
it makes sense to have absolute links in the helm chart since folks could use that as a source of truth. we might need to update the auto-gen to remove "https://developer.hashicorp.com"
There was a problem hiding this comment.
@im2nguyen Can you approve as this is blocking the final step of the release. If we want to change the helm chart then that needs to happen in the consul-k8s repo on several branches.
There was a problem hiding this comment.
i'll pre-approve for now so you're not blocked, but can you revert "Consul Connect" -> "service mesh" it's a change that we would like not be reverted
There was a problem hiding this comment.
I've reverted the changes for Consul Connect and other places that shouldn't have been changed.
website/content/docs/k8s/helm.mdx
Outdated
| - `secretKey` ((#v-global-secretsbackend-vault-ca-secretkey)) (`string: ""`) - The key within the Kubernetes or Vault secret that holds the Vault CA certificate. | ||
|
|
||
| - `connectCA` ((#v-global-secretsbackend-vault-connectca)) - Configuration for the Vault service mesh CA provider. | ||
| - `connectCA` ((#v-global-secretsbackend-vault-connectca)) - Configuration for the Vault Connect CA provider. |
There was a problem hiding this comment.
@jkirschner-hashicorp and I updated "Consul Connect" -> "service mesh" which a more appropriate name for this. is there a reason why we're reverting it back?
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
im2nguyen
left a comment
im2nguyen
left a comment
There was a problem hiding this comment.
pre-approving as to not block merging, however, we should revert any changes back to Consul Connect
5 participants
Description
Generate docs for consul-k8s 1.1.2 release.
-->
Links
PR Checklist