Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs fix gateway helmcharts #159

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs fix gateway helmcharts #159

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3d72efa
added instructions on the importance of setting up a service plus an …
Feb 24, 2025
9d22854
Update README.md
meticulo3366 Feb 24, 2025
c1d7851
Update README.md
meticulo3366 Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions charts/gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,36 @@ In particular, the [Client to Gateway Authentication page](https://docs.condukto

### Ingress configuration examples

#### External Service

**note for any ingress you will need to configure a service also**

**below is the simplest configuration to deploy a load balancer with an ingress set up**

example
```yaml
service:
## @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
Comment on lines +190 to +208
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

```

#### Nginx Ingress without TLS

**values.yaml** :
Expand Down