diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 4dd255988a6b..4cd39eb326d8 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3051,31 +3051,16 @@ Topics: File: serverless-autoscaling-scale-bounds - Name: Concurrency File: serverless-autoscaling-concurrency -# administer -- Name: Monitor - Dir: monitor - Topics: - # logging - - Name: Cluster logging with OpenShift Serverless - File: cluster-logging-serverless - # Tracing - - Name: Tracing requests using Jaeger - File: serverless-tracing - # Metrics - - Name: Metrics - File: serverless-serving-metrics - # monitoring services - - Name: Monitoring Knative services - File: serverless-service-monitoring - - Name: Autoscaling dashboard - File: serverless-autoscaling-dashboard -# Support -- Name: Support - File: serverless-support + - Name: Traffic management + File: serverless-traffic-management + - Name: Routing + File: serverless-configuring-routes # Admin guide -- Name: Administration guide +- Name: Administer Dir: admin_guide Topics: + - Name: Configuring OpenShift Serverless + File: serverless-configuration # Ingress options - Name: Integrating Service Mesh with OpenShift Serverless File: serverless-ossm-setup @@ -3102,6 +3087,26 @@ Topics: # HA - Name: High availability on OpenShift Serverless File: serverless-ha +- Name: Monitor + Dir: monitor + Topics: + # logging + - Name: Cluster logging with OpenShift Serverless + File: cluster-logging-serverless + # Tracing + - Name: Tracing requests using Jaeger + File: serverless-tracing + # Metrics + - Name: Metrics + File: serverless-serving-metrics + # monitoring services + - Name: Monitoring Knative services + File: serverless-service-monitoring + - Name: Autoscaling dashboard + File: serverless-autoscaling-dashboard +# Support +- Name: Support + File: serverless-support # Security - Name: Security Dir: security @@ -3112,16 +3117,6 @@ Topics: File: serverless-custom-domains - Name: Using a custom TLS certificate for domain mapping File: serverless-custom-tls-cert-domain-mapping -# Knative Serving -- Name: Knative Serving - Dir: knative_serving - Topics: - # Knative services - - Name: Traffic management - File: serverless-traffic-management - # Routes - - Name: Configuring routes for Knative services - File: serverless-configuring-routes # Knative Eventing - Name: Knative Eventing Dir: knative_eventing diff --git a/modules/knative-serving-advanced-config.adoc b/modules/knative-serving-advanced-config.adoc index 282ff307873f..b4623345009c 100644 --- a/modules/knative-serving-advanced-config.adoc +++ b/modules/knative-serving-advanced-config.adoc @@ -5,13 +5,10 @@ [id="knative-serving-advanced-config_{context}"] = Knative Serving advanced configuration options -[IMPORTANT] -==== -Do not modify any YAML contained inside the `config` field. Some of the configuration values in this field are injected by the {ServerlessOperatorName}, and modifying them will cause your deployment to become unsupported. -==== +This section provides information about advanced configuration options for Knative Serving. [id="knative-serving-controller-custom-certs_{context}"] -== Controller Custom Certs +== Controller custom certs If your registry uses a self-signed certificate, you must enable tag-to-digest resolution by creating a config map or secret. To enable tag-to-digest resolution, the Knative Serving controller requires access to the container registry. diff --git a/serverless/admin_guide/serverless-configuration.adoc b/serverless/admin_guide/serverless-configuration.adoc new file mode 100644 index 000000000000..92f8976b6126 --- /dev/null +++ b/serverless/admin_guide/serverless-configuration.adoc @@ -0,0 +1,58 @@ +include::modules/serverless-document-attributes.adoc[] +[id="serverless-configuration"] += Configuring {ServerlessProductName} +include::modules/common-attributes.adoc[] +:context: serverless-configuration + +toc::[] + +The {ServerlessOperatorName} manages the global configuration of a Knative installation, including propagating values from the `KnativeServing` and `KnativeEventing` custom resources to system link:https://kubernetes.io/docs/concepts/configuration/configmap/[config maps]. + +Any updates to config maps which are applied manually are overwritten by the Operator. However, modifying the Knative custom resources allows you to set values for these config maps. + +Knative has multiple config maps that are named with the prefix `config-`. + +All Knative config maps are created in the same namespace as the custom resource that they apply to. For example, if the `KnativeServing` custom resource is created in the `knative-serving` namespace, all Knative Serving config maps are also created in this namespace. + +The `spec.config` in the Knative custom resources have one `` entry for each config map, named `config-`, with a value which is be used for the config map `data`. + +.Examples of global configuration + +You can specify that the `KnativeServing` custom resource uses the `config-domain` config map as follows: + +```yaml +apiVersion: operator.knative.dev/v1alpha1 +kind: KnativeServing +metadata: + name: knative-serving + namespace: knative-serving +spec: + config: + domain: <1> + example.org: | + selector: + app: prod + example.com: "" +``` +<1> Specifies the `config-domain` config map. + +You can apply values to multiple config maps. This example sets `stable-window` to 60s in the `config-autoscaler` config map, as well as specifying the `config-domain` config map: + +```yaml +apiVersion: operator.knative.dev/v1alpha1 +kind: KnativeServing +metadata: + name: knative-serving + namespace: knative-serving +spec: + config: + domain: <1> + example.org: | + selector: + app: prod + example.com: "" + autoscaler: <2> + stable-window: "60s" +``` +<1> Specifies the `config-domain` config map. +<2> Specifies the `stable-window` setting in the `config-autoscaler` config map. diff --git a/serverless/knative_serving/serverless-configuring-routes.adoc b/serverless/develop/serverless-configuring-routes.adoc similarity index 97% rename from serverless/knative_serving/serverless-configuring-routes.adoc rename to serverless/develop/serverless-configuring-routes.adoc index 5b227fc234e1..fe618f3a751d 100644 --- a/serverless/knative_serving/serverless-configuring-routes.adoc +++ b/serverless/develop/serverless-configuring-routes.adoc @@ -1,6 +1,6 @@ include::modules/serverless-document-attributes.adoc[] [id="serverless-configuring-routes"] -= Configuring routes for Knative services += Routing :context: serverless-configuring-routes include::modules/common-attributes.adoc[] diff --git a/serverless/knative_serving/serverless-traffic-management.adoc b/serverless/develop/serverless-traffic-management.adoc similarity index 100% rename from serverless/knative_serving/serverless-traffic-management.adoc rename to serverless/develop/serverless-traffic-management.adoc diff --git a/serverless/knative_serving/images b/serverless/knative_serving/images deleted file mode 120000 index 5e67573196d8..000000000000 --- a/serverless/knative_serving/images +++ /dev/null @@ -1 +0,0 @@ -../images \ No newline at end of file diff --git a/serverless/knative_serving/modules b/serverless/knative_serving/modules deleted file mode 120000 index 464b823aca16..000000000000 --- a/serverless/knative_serving/modules +++ /dev/null @@ -1 +0,0 @@ -../modules \ No newline at end of file