clean up some of the ingress.class documentation (#4271)

* clean up some of the ingress.class documentation

* drop visible quotes since it's already in a a code block

* add matching brace

* fix mispell

* pr feedback
This commit is contained in:
Dave Protasowski 2021-10-04 10:22:27 -04:00 committed by GitHub
parent 860dca05b5
commit fae61866db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 10 deletions

View File

@ -1,28 +1,24 @@
# Configuring Services custom ingress class
By default, when a Knative Service is created an Ingress Class (`ingress.class`) is automatically chosen for it based on the content of the `networking-config` ConfigMap located inside the `knative-serving` namespace.
The `networking-config` ConfigMap is configured when Knative Serving is installed, and if no other ingress class is specified, this defaults to `"istio.ingress.networking.knative.dev"`.
After it is configured in the `networking-config` ConfigMap, the `ingress.class` is used for all Knative Services that do not specify an `ingress.class` annotation.
When a Knative Service is created an ingress class (`ingress.class`) is automatically assigned to it, based on the value in the `config-network` ConfigMap located inside the `knative-serving` namespace. This ConfigMap is part of Knative Serving installation. If the ingress class is not specified, this defaults to `istio.ingress.networking.knative.dev`. Once configured the `ingress.class` is used for all Knative Services unless it is overridden with an `ingress.class` annotation.
!!! warning
The ingress class value should only be modified during Knative Serving installation to avoid issues in your deployment.
Changing the ingress class in `config-network` ConfigMap will only affect newly created Services
## Using the ingress class annotation
Generally it is recommended for Knative Services to use the default `ingress.class`. However, in scenarios where there are multiple networking implementations, you might want to specify different ingress class annotations for each Service.
You can configure each Service to use a different ingress class by specifying the `network.knative.dev/ingress.class` annotation.
You can configure each Service to use a different ingress class by specifying the `networking.knative.dev/ingress.class` annotation.
To add an ingress class annotation to a Service, run the following command:
```bash
kubectl annotate kservice <service-name> network.knative.dev/ingress.class=<ingress-type>
kubectl annotate kservice <service-name> networking.knative.dev/ingress.class=<ingress-type>
```
Where:
- `<service-name>` is the name of the Service that you are applying the annotation to.
- `<ingress-type` is the type of ingress that is used as the ingress class for the Service.
- `<ingress-type>` is the type of ingress that is used as the ingress class for the Service.
!!! note
This annotation overrides the configuration specified in the `networking-config` ConfigMap.
This annotation overrides the `ingress.class` value specified in the `config-network` ConfigMap.