Skip to content

document nginx ingress (skupper-440) #253

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
pwright merged 2 commits into from
Oct 17, 2024
Merged

document nginx ingress (skupper-440) #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a49f020
document nginx ingress (skupper-440)
pwright Oct 16, 2024
0584657
update based on feedback
pwright Oct 17, 2024
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
2 changes: 2 additions & 0 deletions cli/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,8 @@ include::./single-logical-service.adoc[leveloffset=0]

include::./protocols.adoc[leveloffset=0]

include::../kubernetes/ingress.adoc[leveloffset=1]

// Type: reference
[id="cli-global-options"]
== CLI options
Expand Down
37 changes: 37 additions & 0 deletions kubernetes/ingress.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
include::../partials/attributes.adoc[]
// Type: concept
[id="understanding-ingress"]
= Understanding ingress

When you create a site that can be linked to, you need to enable ingress on that site.
By default, ingress is enabled, however you can disable it or set it to use a specific ingress type.

By default, the ingress type is set to:

* `route` if available (OpenShift)
* `loadbalancer`

Other options include:

* `none` useful if you do not need to link to the current site.
* `nodeport`
* `nginx-ingress-v1`
* `contour-http-proxy`

You can set the ingress type using the CLI when creating the site `skupper init --ingress <type>` or by setting the type in your site YAML, for example to disable ingress:

[source, bash]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: skupper-site
data:
name: my-site
ingress: "none"
----

If the default ingress is not suitable, an alternative is `nginx-ingress-v1`.
Nginx uses Server Name Indication (SNI) to identify connection targets, which eliminates the need for assigning separate IP addresses as required by `loadbalancer`.

NOTE: When using `nginx-ingress-v1` you must enable SSL Passthrough as described in link:https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough[Ingress-Nginx Controller documentation].
Loading