diff --git a/docs/install/serving/install-serving-with-yaml.md b/docs/install/serving/install-serving-with-yaml.md index 6136d4077..c4c7144c9 100644 --- a/docs/install/serving/install-serving-with-yaml.md +++ b/docs/install/serving/install-serving-with-yaml.md @@ -45,7 +45,7 @@ Follow the procedure for the networking layer of your choice: kubectl patch configmap/config-network \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"ingress.class":"kourier.ingress.networking.knative.dev"}}' + --patch '{"data":{"ingress-class":"kourier.ingress.networking.knative.dev"}}' ``` 1. Fetch the External IP address or CNAME by running the command: @@ -95,7 +95,7 @@ Follow the procedure for the networking layer of your choice: kubectl patch configmap/config-network \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"ingress.class":"ambassador.ingress.networking.knative.dev"}}' + --patch '{"data":{"ingress-class":"ambassador.ingress.networking.knative.dev"}}' ``` 1. Fetch the External IP address or CNAME by running the command: @@ -129,7 +129,7 @@ Follow the procedure for the networking layer of your choice: kubectl patch configmap/config-network \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"ingress.class":"contour.ingress.networking.knative.dev"}}' + --patch '{"data":{"ingress-class":"contour.ingress.networking.knative.dev"}}' ``` 1. Fetch the External IP address or CNAME by running the command: @@ -241,20 +241,20 @@ The following tabs expand to show instructions for installing each Serving exten kubectl apply -f {{ artifact(repo="net-http01",file="release.yaml")}} ``` - 2. Configure the `certificate.class` to use this certificate type by running the command: + 2. Configure the `certificate-class` to use this certificate type by running the command: ```bash kubectl patch configmap/config-network \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"certificate.class":"net-http01.certificate.networking.knative.dev"}}' + --patch '{"data":{"certificate-class":"net-http01.certificate.networking.knative.dev"}}' ``` - 3. Enable auto-TLS by running the command: + 3. Enable autoTLS by running the command: ```bash kubectl patch configmap/config-network \ --namespace knative-serving \ --type merge \ - --patch '{"data":{"autoTLS":"Enabled"}}' + --patch '{"data":{"auto-tls":"Enabled"}}' ``` diff --git a/docs/serving/configuration/deployment.md b/docs/serving/configuration/deployment.md index c992ac9ea..8f2b844da 100644 --- a/docs/serving/configuration/deployment.md +++ b/docs/serving/configuration/deployment.md @@ -23,35 +23,35 @@ metadata: data: # This is the Go import path for the binary that is containerized # and substituted here. - queueSidecarImage: ko://knative.dev/serving/cmd/queue + queue-sidecar-image: ko://knative.dev/serving/cmd/queue # List of repositories for which tag to digest resolving should be skipped - registriesSkippingTagResolving: "kind.local,ko.local,dev.local" - # digestResolutionTimeout is the maximum time allowed for an image's + registries-skipping-tag-resolving: "kind.local,ko.local,dev.local" + # digest-resolution-timeout is the maximum time allowed for an image's # digests to be resolved. - digestResolutionTimeout: "10s" - # ProgressDeadline is the duration we wait for the deployment to + digest-resolution-timeout: "10s" + # progress-deadline is the duration we wait for the deployment to # be ready before considering it failed. - progressDeadline: "600s" - # queueSidecarCPURequest is the requests.cpu to set for the queue proxy sidecar container. + progress-deadline: "600s" + # queue-sidecar-cpu-request is the requests.cpu to set for the queue proxy sidecar container. # If omitted, a default value (currently "25m"), is used. - queueSidecarCPURequest: "25m" - # queueSidecarCPULimit is the limits.cpu to set for the queue proxy sidecar container. + queue-sidecar-cpu-request: "25m" + # queue-sidecar-cpu-limit is the limits.cpu to set for the queue proxy sidecar container. # If omitted, no value is specified and the system default is used. - queueSidecarCPULimit: "1000m" - # queueSidecarMemoryRequest is the requests.memory to set for the queue proxy container. + queue-sidecar-cpu-limit: "1000m" + # queue-sidecar-memory-request is the requests.memory to set for the queue proxy container. # If omitted, no value is specified and the system default is used. - queueSidecarMemoryRequest: "400Mi" - # queueSidecarMemoryLimit is the limits.memory to set for the queue proxy container. + queue-sidecar-memory-request: "400Mi" + # queue-sidecar-memory-limit is the limits.memory to set for the queue proxy container. # If omitted, no value is specified and the system default is used. - queueSidecarMemoryLimit: "800Mi" - # queueSidecarEphemeralStorageRequest is the requests.ephemeral-storage to + queue-sidecar-memory-limit: "800Mi" + # queue-sidecar-ephemeral-storage-request is the requests.ephemeral-storage to # set for the queue proxy sidecar container. # If omitted, no value is specified and the system default is used. - queueSidecarEphemeralStorageRequest: "512Mi" - # queueSidecarEphemeralStorageLimit is the limits.ephemeral-storage to set + queue-sidecar-ephemeral-storage-request: "512Mi" + # queue-sidecar-ephemeral-storage-limit is the limits.ephemeral-storage to set # for the queue proxy sidecar container. # If omitted, no value is specified and the system default is used. - queueSidecarEphemeralStorageLimit: "1024Mi" + queue-sidecar-ephemeral-storage-limit: "1024Mi" ``` ## Configuring progress deadlines @@ -83,12 +83,12 @@ metadata: annotations: knative.dev/example-checksum: "fa67b403" data: - progressDeadline: "10m" + progress-deadline: "10m" ``` ## Skipping tag resolution -You can configure Knative Serving to skip tag resolution for Deployments by modifying the `registriesSkippingTagResolving` ConfigMap setting. +You can configure Knative Serving to skip tag resolution for Deployments by modifying the `registries-skipping-tag-resolving` ConfigMap setting. The following example shows how to disable tag resolution for `registry.example.com`: @@ -104,5 +104,5 @@ metadata: knative.dev/example-checksum: "fa67b403" data: # List of repositories for which tag to digest resolving should be skipped - registriesSkippingTagResolving: registry.example.com + registries-skipping-tag-resolving: registry.example.com ``` diff --git a/docs/serving/configuration/rolling-out-latest-revision-configmap.md b/docs/serving/configuration/rolling-out-latest-revision-configmap.md index 4074f7268..eb8e26241 100644 --- a/docs/serving/configuration/rolling-out-latest-revision-configmap.md +++ b/docs/serving/configuration/rolling-out-latest-revision-configmap.md @@ -12,7 +12,7 @@ You can configure the `rollout-duration` parameter by modifying the `config-netw name: config-network namespace: knative-serving data: - rolloutDuration: "380s" # Value in seconds. + rollout-duration: "380s" # Value in seconds. ``` === "Operator configuration" diff --git a/docs/serving/samples/knative-routing-go/README.md b/docs/serving/samples/knative-routing-go/README.md index 5997005b4..e75f232a1 100644 --- a/docs/serving/samples/knative-routing-go/README.md +++ b/docs/serving/samples/knative-routing-go/README.md @@ -194,7 +194,7 @@ kubectl get cm -n knative-serving config-network -o yaml ``` {% raw %} -Then look for the value for `domainTemplate`. If it is +Then look for the value for `domain-template`. If it is `{{.Name}}-{{.Namespace}}.{{.Domain}}`, you need to change `search-service.default` into `search-service-default` and `login-service.default` into `login-service-default` as well in `routing.yaml`. @@ -259,7 +259,7 @@ The Gateway proxy checks the updated host, and forwards it to `Search` or ![Object model](images/knative-routing-sample-flow.png) -## Using internal services and `"httpProtocol": "Redirected"` +## Using internal services and `"http-protocol": "Redirected"` Using the approach explained in the previous section, services will be available using two entrypoints into the cluster: The original ones provided by Knative Serving (`search-service.default.example.com` and `login-service.default.example.com`), @@ -290,8 +290,8 @@ kubectl apply --filename docs/serving/samples/knative-routing-go/routing-interna will replace the custom routing rule with one that uses the `knative-local-gateway`, enabling access via `example.com/search` and `example.com/login` again. -With these changes, you can also use [the `autoTLS` feature](../../using-auto-tls.md) in combination with the global setting -`"httpProtocol": "Redirected"`, which would otherwise try to redirect the `entry-route` +With these changes, you can also use [the `auto-tls` feature](../../using-auto-tls.md) in combination with the global setting +`"http-protocol": "Redirected"`, which would otherwise try to redirect the `entry-route` VirtualService requests from HTTP to HTTPS, failing the request. ## Clean Up diff --git a/docs/serving/samples/kong-routing-go/README.md b/docs/serving/samples/kong-routing-go/README.md index 074dd2e95..c109ff59d 100644 --- a/docs/serving/samples/kong-routing-go/README.md +++ b/docs/serving/samples/kong-routing-go/README.md @@ -194,7 +194,7 @@ kubectl get svc $INGRESSGATEWAY -n kong --output yaml kubectl get cm config-network -n knative-serving -o yaml ``` - Then, look for the value for `domainTemplate`. If it is {% raw + Then, look for the value for `domain-template`. If it is {% raw %}`{{.Name}}-{{.Namespace}}.{{.Domain}}`{% endraw %}, you need to change `search-service.default` into `search-service-default` and `login-service.default` into `login-service-default` as well in diff --git a/docs/serving/services/certificate-class.md b/docs/serving/services/certificate-class.md index a659cf132..7384dcea5 100644 --- a/docs/serving/services/certificate-class.md +++ b/docs/serving/services/certificate-class.md @@ -1,5 +1,7 @@ # Configuring a custom certificate class for a Service + + When autoTLS is enabled and Knative Services are created, a certificate class (`certificate.class`) is automatically chosen 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 certificate class is not specified, this defaults to `cert-manager.certificate.networking.knative.dev`. After `certificate.class` is configured, it is used for all Knative Services unless it is overridden with a `certificate.class` annotation. ## Using the certificate class annotation diff --git a/docs/serving/services/custom-domains.md b/docs/serving/services/custom-domains.md index bec479eeb..33ff0333e 100644 --- a/docs/serving/services/custom-domains.md +++ b/docs/serving/services/custom-domains.md @@ -53,7 +53,7 @@ DomainMappings in that namespace to use the domain name. ``` Where `` is the name of the file you created in the previous step. - * To create ClusterDomainClaims automatically: set the `autocreateClusterDomainClaims` property + * To create ClusterDomainClaims automatically: set the `autocreate-cluster-domain-claims` property to `true` in the `config-network` ConfigMap in the `knative-serving` namespace. This allows any user, in any namespace, to map any domain name, including ones in other namespaces or for domain names that they do not own. diff --git a/docs/serving/services/http-option.md b/docs/serving/services/http-option.md index b96d4ba75..64a850245 100644 --- a/docs/serving/services/http-option.md +++ b/docs/serving/services/http-option.md @@ -1,12 +1,12 @@ # HTTPS redirection -Operators can force HTTPS redirection for all Services. See the `httpProtocol` mentioned in the [Turn on AutoTLS](../using-auto-tls.md) page for more details. +Operators can force HTTPS redirection for all Services. See the `http-protocol` mentioned in the [Turn on AutoTLS](../using-auto-tls.md) page for more details. ## Overriding the default HTTP behavior You can override the default behavior for each Service or global configuration. -* **Global key:** `httpProtocol` +* **Global key:** `http-protocol` * **Per-revision annotation key:** `networking.knative.dev/httpOption` * **Possible values:** * `enabled` — Services accept HTTP traffic. @@ -36,7 +36,7 @@ You can override the default behavior for each Service or global configuration. name: config-network namespace: knative-serving data: - httpProtocol: "enabled" + http-protocol: "enabled" ``` === "Global (Operator)" diff --git a/docs/serving/services/ingress-class.md b/docs/serving/services/ingress-class.md index 086726996..eb67aa5f5 100644 --- a/docs/serving/services/ingress-class.md +++ b/docs/serving/services/ingress-class.md @@ -1,5 +1,7 @@ # Configuring Services custom ingress class + + 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 diff --git a/docs/serving/using-a-tls-cert.md b/docs/serving/using-a-tls-cert.md index b756af605..c937ea441 100644 --- a/docs/serving/using-a-tls-cert.md +++ b/docs/serving/using-a-tls-cert.md @@ -184,7 +184,7 @@ follow the steps in the relevant tab to manually add a certificate: Where `` is the name of the file you created in the previous step. 1. Update the Knative Contour plugin to use the certificate as a fallback - when auto-TLS is disabled by running the command: + when autoTLS is disabled by running the command: ```bash kubectl patch configmap config-contour -n knative-serving \ diff --git a/docs/serving/using-auto-tls.md b/docs/serving/using-auto-tls.md index 6067cdfea..2dcc1dd3a 100644 --- a/docs/serving/using-auto-tls.md +++ b/docs/serving/using-auto-tls.md @@ -225,7 +225,7 @@ in the `knative-serving` namespace to reference your new `ClusterIssuer`. Update the [`config-network` ConfigMap](https://github.com/knative/serving/blob/main/config/core/configmaps/network.yaml) -in the `knative-serving` namespace to enable `autoTLS`and specify how HTTP +in the `knative-serving` namespace to enable `auto-tls` and specify how HTTP requests are handled: 1. Run the following command to edit your `config-network` ConfigMap: @@ -234,11 +234,11 @@ requests are handled: kubectl edit configmap config-network --namespace knative-serving ``` -1. Add the `autoTLS: Enabled` attribute under the `data` section: +1. Add the `auto-tls: Enabled` attribute under the `data` section: ```bash data: - autoTLS: Enabled + auto-tls: Enabled ``` Example: @@ -251,20 +251,20 @@ requests are handled: namespace: knative-serving data: ... - autoTLS: Enabled + auto-tls: Enabled ... ``` 1. Configure how HTTP and HTTPS requests are handled in the - [`httpProtocol`](https://github.com/knative/serving/blob/main/config/core/configmaps/network.yaml#L109) + [`http-protocol`](https://github.com/knative/serving/blob/main/config/core/configmaps/network.yaml#L109) attribute. By default, Knative ingress is configured to serve HTTP traffic - (`httpProtocol: Enabled`). Now that your cluster is configured to use TLS + (`http-protocol: Enabled`). Now that your cluster is configured to use TLS certificates and handle HTTPS traffic, you can specify whether or not any HTTP traffic is allowed. - Supported `httpProtocol` values: + Supported `http-protocol` values: - `Enabled`: Serve HTTP traffic. - `Disabled`: Rejects all HTTP traffic. @@ -273,7 +273,7 @@ requests are handled: ```bash data: - httpProtocol: Redirected + http-protocol: Redirected ``` Example: @@ -286,13 +286,13 @@ requests are handled: namespace: knative-serving data: ... - autoTLS: Enabled - httpProtocol: Redirected + auto-tls: Enabled + http-protocol: Redirected ... ``` **Note:** - When using HTTP-01 challenge, `httpProtocol` field has to be set to `Enabled` to make sure HTTP-01 challenge requests can be accepted by the cluster. + When using HTTP-01 challenge, `http-protocol` field has to be set to `Enabled` to make sure HTTP-01 challenge requests can be accepted by the cluster. 1. Ensure that the file was updated successfully: