docs fix gateway helmcharts #159
Open
Conversation
This file contains hidden or 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
qboileau
reviewed
Feb 24, 2025
Member
qboileau
left a comment
qboileau
left a comment
There was a problem hiding this comment.
Can be cleaned up by removing comment already present on chart values.yaml and in README.md.
Also, might be useful to include links to cloud provider external load balanced service documentations. Like for AWS EKS or GCP GKE and/or main kubernetes documentation for more examples
Comment on lines
+190
to
+208
| ## @section Gateway external service configurations | ||
| ## @descriptionStart | ||
| ## This section specifies external service configuration | ||
| ## @descriptionEnd | ||
| external: | ||
| ## @param service.external.enable Enable a service for external connection to Gateway | ||
| enable: true | ||
| ## @param service.external.type Type of load balancer | ||
| type: LoadBalancer | ||
| ## @param service.external.ip IP to configure | ||
| ip: "" | ||
| ## @param service.external.annotations | ||
| annotations: {} | ||
| # LoadBalancer externaldns gke support by annotation https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials/gke.md#verify-using-an-external-load-balancer | ||
| # external-dns.alpha.kubernetes.io/hostname: "{{ required "A valid .Values.gateway.domain is required!" .Values.gateway.domain }}" | ||
| ## @param service.external.admin Enable admin exposition on external service | ||
| admin: false | ||
| ## @param service.external.jmx Enable jmx exposition on external service | ||
| jmx: false |
Member
There was a problem hiding this comment.
No need to copy the doc here your actual change over the default value is
service:
external:
enable: true
type: LoadBalancer # Use LoadBalancer service instead of default ClusterIP
Contributor
There was a problem hiding this comment.
@meticulo3366 - the other values you have included are the defaults, e.g. IP empty, annotations empty etc.
So for your example it's probably just what Quentin proposed?
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.
Included instructions on the importance of setting up a service along with an ingress config