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.

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

[MAISTRA-1744] Route Annotations Documentation Update #158

Merged
merged 4 commits into from Aug 12, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions topics/docs/comparison-with-istio/ior.adoc
Expand Up @@ -18,6 +18,8 @@ apiVersion: networking.istio.io/v1alpha3
kind: Gateway
metadata:
name: gateway1
annotations:
kubernetes.io/tls-acme: "true"
spec:
selector:
istio: ingressgateway
Expand Down Expand Up @@ -46,6 +48,9 @@ If the Gateway is deleted, Maistra deletes the routes. Maistra does not modify r
=== Catch-all domains
Catch-all domains ("\*") are not supported. If one is found in the Gateway definition, Maistra _will_ create the route, but will rely on https://docs.okd.io/3.11/architecture/networking/routes.html#route-hostnames[OpenShift to create a default hostname]. This means that the newly created route will __not__ be a catch all ("*") route, instead it will have a hostname in the form `<route-name>[-<project>].<suffix>`. Refer to the https://docs.okd.io/3.11/architecture/networking/routes.html#route-hostnames[OpenShift documentation] for more information about how default hostnames work and how a cluster administrator can customize it.

=== Route annotations
All annotations present in the Istio gateway definition, except those starting with `kubectl.kubernetes.io` will be copied over to the newly created OpenShift route. This will only occur when the route is created.

=== Subdomains
Subdomains (e.g.: "*.domain.com") are supported. However this ability doesn't come enabled by default in OpenShift. This means that Maistra _will_ create the route with the subdomain, but it will only be in effect if OpenShift is configured to enable it. Cluster administrators can refer to the https://docs.okd.io/3.11/install_config/router/default_haproxy_router.html#using-wildcard-routes[OpenShift documentation] for instructions on how to enable this feature.

Expand Down