Skip to content

Update gc doc with vs listeners #4507

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

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Update gc doc with vs listeners #4507

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e3a766
Update gc doc with vs listeners
vepatel Oct 12, 2023
e057da9
Merge branch 'main' into docs/gc-vs-listener
vepatel Oct 12, 2023
e6efe5d
fix typo
vepatel Oct 12, 2023
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
21 changes: 16 additions & 5 deletions docs/content/configuration/global-configuration/globalconfiguration-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ docs: "DOCS-588"

The GlobalConfiguration resource allows you to define the global configuration parameters of the Ingress Controller. The resource is implemented as a [Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).

The resource supports configuring listeners for TCP and UDP load balancing. Listeners are required by [TransportServer resources](/nginx-ingress-controller/configuration/transportserver-resource).
The resource supports configuring listeners for TCP and UDP load balancing. Listeners are required by [TransportServer resources](/nginx-ingress-controller/configuration/transportserver-resource) and
can be used to configure custom listerners for VirtualServers as specified [here](/nginx-ingress-controller/tutorials/virtual-server-with-custom-listener-ports).

## Prerequisites

Expand All @@ -35,6 +36,13 @@ spec:
- name: dns-tcp
port: 5353
protocol: TCP
- name: http-8083
port: 8083
protocol: HTTP
- name: https-8443
port: 8443
protocol: HTTP
ssl: true
```

{{% table %}}
Expand All @@ -45,12 +53,15 @@ spec:

### Listener

The listener defines a listener (a combination of a protocol and a port) that NGINX will use to accept traffic for a [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource):
The listener defines a listener (a combination of a protocol and a port) that NGINX will use to accept traffic for a [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) and a [VirtualServer](nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources):

```yaml
name: dns-tcp
port: 5353
protocol: TCP
- name: dns-tcp
port: 5353
protocol: TCP
- name: http-8083
port: 8083
protocol: HTTP
```

{{% table %}}
Expand Down