diff --git a/docs/about-analytics-cookies.md b/docs/about-analytics-cookies.md index 6f65f47f0..c0a78462a 100644 --- a/docs/about-analytics-cookies.md +++ b/docs/about-analytics-cookies.md @@ -2,6 +2,9 @@ title: "Learn about Google Analytics cookies" linkTitle: "Learn about cookies" type: "docs" +audience: developer +components: [] +function: community --- By using this website, you are confirming that you accept our use of cookies for diff --git a/docs/install/README.md b/docs/install/README.md index 8f051e86f..cd4c1aea5 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: reference +--- + # Installing Knative !!! note diff --git a/docs/install/installing-backstage-plugins.md b/docs/install/installing-backstage-plugins.md index fad199ed2..7aeba7330 100644 --- a/docs/install/installing-backstage-plugins.md +++ b/docs/install/installing-backstage-plugins.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - eventing +function: how-to +--- + # Installing Knative Backstage Plugins Knative community is planning to provide a set of Backstage plugins for Knative and their respective backends. diff --git a/docs/install/installing-cert-manager.md b/docs/install/installing-cert-manager.md index e09fe9d8d..fb90c34ea 100644 --- a/docs/install/installing-cert-manager.md +++ b/docs/install/installing-cert-manager.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Installing cert-manager for TLS certificates Knative leverages [cert-manager](https://github.com/jetstack/cert-manager) to request TLS certificates diff --git a/docs/install/installing-istio.md b/docs/install/installing-istio.md index 4670df1b8..56b29e77e 100644 --- a/docs/install/installing-istio.md +++ b/docs/install/installing-istio.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Installing Istio for Knative This guide walks you through manually installing and customizing Istio for use diff --git a/docs/install/knative-offerings.md b/docs/install/knative-offerings.md index dd9485d80..d40c42a46 100644 --- a/docs/install/knative-offerings.md +++ b/docs/install/knative-offerings.md @@ -1,3 +1,11 @@ +--- +audience: buyer +components: + - serving + - eventing +function: reference +--- + # Knative Offerings Knative has a rich community with many vendors participating, and many of those diff --git a/docs/install/operator/configuring-eventing-cr.md b/docs/install/operator/configuring-eventing-cr.md index f833b7bbe..abe020969 100644 --- a/docs/install/operator/configuring-eventing-cr.md +++ b/docs/install/operator/configuring-eventing-cr.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - eventing +function: how-to +--- + # Configuring the Eventing Operator custom resource You can configure the Knative Eventing operator by modifying settings in the `KnativeEventing` custom resource (CR). diff --git a/docs/install/operator/configuring-serving-cr.md b/docs/install/operator/configuring-serving-cr.md index 9d64cd6d0..43d789db4 100644 --- a/docs/install/operator/configuring-serving-cr.md +++ b/docs/install/operator/configuring-serving-cr.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring the Knative Serving Operator custom resource You can modify the KnativeServing CR to configure different options for Knative Serving. diff --git a/docs/install/operator/configuring-with-operator.md b/docs/install/operator/configuring-with-operator.md index 7840d304a..ec8fa5423 100644 --- a/docs/install/operator/configuring-with-operator.md +++ b/docs/install/operator/configuring-with-operator.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Configuring Knative by using the Operator The Operator manages the configuration of a Knative installation, including propagating values from the `KnativeServing` and `KnativeEventing` custom resources to system [ConfigMaps](https://kubernetes.io/docs/concepts/configuration/configmap/). diff --git a/docs/install/operator/knative-with-operator-cli.md b/docs/install/operator/knative-with-operator-cli.md index a4382ea5e..725dcbd52 100644 --- a/docs/install/operator/knative-with-operator-cli.md +++ b/docs/install/operator/knative-with-operator-cli.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Install by using the Knative Operator CLI Plugin Knative provides a CLI Plugin to install, configure and manage Knative via the command lines. This CLI plugin facilitates diff --git a/docs/install/operator/knative-with-operators.md b/docs/install/operator/knative-with-operators.md index 9d18bd0c3..9e963ff9c 100644 --- a/docs/install/operator/knative-with-operators.md +++ b/docs/install/operator/knative-with-operators.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Install by using the Knative Operator Knative provides a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to install, configure and manage Knative. diff --git a/docs/install/quickstart-install.md b/docs/install/quickstart-install.md index d0bb12e12..bd003ced4 100644 --- a/docs/install/quickstart-install.md +++ b/docs/install/quickstart-install.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: tutorial +--- + # Install Knative using quickstart Following this quickstart tutorial provides you with a simplified, local Knative installation by using the Knative `quickstart` plugin. diff --git a/docs/install/troubleshooting.md b/docs/install/troubleshooting.md index 3ab546419..038c8c034 100644 --- a/docs/install/troubleshooting.md +++ b/docs/install/troubleshooting.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Troubleshooting a Knative Installation This page describes how you can troubleshoot a Knative installation. Please try these instructions before filing a bug report. diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 05ad772d3..22a52d170 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Uninstalling Knative To uninstall an Operator-based Knative installation, see the following [Uninstall an Operator-based Knative Installation](#uninstall-an-operator-based-knative-installation) procedure. diff --git a/docs/install/upgrade/README.md b/docs/install/upgrade/README.md index 6ca8b5a96..ba50a5803 100644 --- a/docs/install/upgrade/README.md +++ b/docs/install/upgrade/README.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Upgrading Knative Knative supports upgrading by a single [minor](https://semver.org/) version number. For example, if you have v0.21.0 installed, you must upgrade to v0.22.0 before attempting to upgrade to v0.23.0. diff --git a/docs/install/upgrade/check-install-version.md b/docs/install/upgrade/check-install-version.md index 09e32bd63..bc2bd1e02 100644 --- a/docs/install/upgrade/check-install-version.md +++ b/docs/install/upgrade/check-install-version.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Checking your Knative version To check the version of your Knative installation, use one of the following commands, diff --git a/docs/install/upgrade/upgrade-installation-with-operator.md b/docs/install/upgrade/upgrade-installation-with-operator.md index 1cb8f5259..4930cfb44 100644 --- a/docs/install/upgrade/upgrade-installation-with-operator.md +++ b/docs/install/upgrade/upgrade-installation-with-operator.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Upgrading using the Knative Operator This topic describes how to upgrade Knative if you installed using the Operator. diff --git a/docs/install/upgrade/upgrade-installation.md b/docs/install/upgrade/upgrade-installation.md index c6d7abffe..25a2b393b 100644 --- a/docs/install/upgrade/upgrade-installation.md +++ b/docs/install/upgrade/upgrade-installation.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Upgrading with kubectl If you installed Knative using YAML, you can use the `kubectl apply` command in diff --git a/docs/install/yaml-install/README.md b/docs/install/yaml-install/README.md index a5c25fe22..ffda49300 100644 --- a/docs/install/yaml-install/README.md +++ b/docs/install/yaml-install/README.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: reference +--- + # About YAML-based installation You can install the Serving component, Eventing component, or both on your cluster diff --git a/docs/install/yaml-install/eventing/eventing-installation-files.md b/docs/install/yaml-install/eventing/eventing-installation-files.md index 985bb61b1..60152fa88 100644 --- a/docs/install/yaml-install/eventing/eventing-installation-files.md +++ b/docs/install/yaml-install/eventing/eventing-installation-files.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - eventing +function: reference +--- + # Knative Eventing installation files This guide provides reference information about the core Knative Eventing YAML files, including: diff --git a/docs/install/yaml-install/eventing/install-eventing-with-yaml.md b/docs/install/yaml-install/eventing/install-eventing-with-yaml.md index 3f1015b3d..692fb0e11 100644 --- a/docs/install/yaml-install/eventing/install-eventing-with-yaml.md +++ b/docs/install/yaml-install/eventing/install-eventing-with-yaml.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - eventing +function: how-to +--- + # Installing Knative Eventing using YAML files This topic describes how to install Knative Eventing by applying YAML files using the `kubectl` CLI. diff --git a/docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md b/docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md index 345b2e5af..7a815129b 100644 --- a/docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md +++ b/docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Install a networking layer on IBM Z and IBM Power platforms This additional step is required for installing the Kourier networking layer on IBM Z and IBM Power platforms. diff --git a/docs/install/yaml-install/serving/install-serving-with-yaml.md b/docs/install/yaml-install/serving/install-serving-with-yaml.md index 044f341f5..b4e8a38f0 100644 --- a/docs/install/yaml-install/serving/install-serving-with-yaml.md +++ b/docs/install/yaml-install/serving/install-serving-with-yaml.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Installing Knative Serving using YAML files This topic describes how to install Knative Serving by applying YAML files using the `kubectl` CLI. diff --git a/docs/install/yaml-install/serving/serving-installation-files.md b/docs/install/yaml-install/serving/serving-installation-files.md index 20e4de244..222b11913 100644 --- a/docs/install/yaml-install/serving/serving-installation-files.md +++ b/docs/install/yaml-install/serving/serving-installation-files.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Knative Serving installation files This guide provides reference information about the core Knative Serving YAML files, including: diff --git a/docs/reference/relnotes/README.md b/docs/reference/relnotes/README.md index 9b960810e..cd0f617da 100644 --- a/docs/reference/relnotes/README.md +++ b/docs/reference/relnotes/README.md @@ -1,3 +1,12 @@ +--- +audience: developer +components: + - functions + - serving + - eventing +function: reference +--- + # Knative release notes For details about the Knative releases, see the following pages: diff --git a/docs/reference/security/README.md b/docs/reference/security/README.md index 478b4bf77..15d259db2 100644 --- a/docs/reference/security/README.md +++ b/docs/reference/security/README.md @@ -1,3 +1,12 @@ +--- +audience: developer +components: + - functions + - serving + - eventing +function: how-to +--- + # Knative Security and Disclosure Information This page describes Knative security and disclosure information. diff --git a/docs/reference/security/verifying-images.md b/docs/reference/security/verifying-images.md index 759c18649..b5c949913 100644 --- a/docs/reference/security/verifying-images.md +++ b/docs/reference/security/verifying-images.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: how-to +--- + # Verifying Knative Images Knative publishes SBOMs and SLSA provenance documents for each image in the diff --git a/docs/samples/README.md b/docs/samples/README.md index cf5a45402..52c15cef8 100755 --- a/docs/samples/README.md +++ b/docs/samples/README.md @@ -1,3 +1,11 @@ +--- +audience: administrator +components: + - serving + - eventing +function: reference +--- + # Knative code samples You can use Knative code samples to help you get up and running with common use diff --git a/docs/samples/eventing.md b/docs/samples/eventing.md index 594326448..fc5c0737a 100644 --- a/docs/samples/eventing.md +++ b/docs/samples/eventing.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - eventing +function: reference +--- + # Knative Eventing code samples Use the following code samples to help you understand the various use cases for diff --git a/docs/samples/serving.md b/docs/samples/serving.md index 8ec7932ce..806428d6a 100644 --- a/docs/samples/serving.md +++ b/docs/samples/serving.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Knative Serving code samples Use the following code samples to help you understand the various Knative diff --git a/docs/serving/README.md b/docs/serving/README.md index 60e0f6f14..a4e30ebfd 100644 --- a/docs/serving/README.md +++ b/docs/serving/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Knative Serving --8<-- "about-serving.md" diff --git a/docs/serving/accessing-traces.md b/docs/serving/accessing-traces.md index cc2aebd22..d3ecf4dfa 100644 --- a/docs/serving/accessing-traces.md +++ b/docs/serving/accessing-traces.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Accessing request traces Depending on the request tracing tool that you have installed on your Knative diff --git a/docs/serving/app-security/security-guard-about.md b/docs/serving/app-security/security-guard-about.md index 655e97f0a..626b723ea 100644 --- a/docs/serving/app-security/security-guard-about.md +++ b/docs/serving/app-security/security-guard-about.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: explanation +--- + # About Security-Guard Security-Guard provides visibility into the security status of deployed Knative Services, by monitoring the behaviors of user containers and events. Security-Guard also supports optional blocking of events and termination of user container instances, all based on behavior. diff --git a/docs/serving/app-security/security-guard-example-alerts.md b/docs/serving/app-security/security-guard-example-alerts.md index 528bc8dfd..5250e74a1 100644 --- a/docs/serving/app-security/security-guard-example-alerts.md +++ b/docs/serving/app-security/security-guard-example-alerts.md @@ -1,3 +1,9 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- # Security-Guard example alerts diff --git a/docs/serving/app-security/security-guard-install.md b/docs/serving/app-security/security-guard-install.md index 695ffd206..f8927f497 100644 --- a/docs/serving/app-security/security-guard-install.md +++ b/docs/serving/app-security/security-guard-install.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Installing Security-Guard Here we show how to install Security-Guard in Knative. Security-Guard is an enhancement to knative-Serving and needs to be installed after the Knative-Serving is successfully installed. diff --git a/docs/serving/app-security/security-guard-quickstart.md b/docs/serving/app-security/security-guard-quickstart.md index c8d584475..59c4e7d90 100644 --- a/docs/serving/app-security/security-guard-quickstart.md +++ b/docs/serving/app-security/security-guard-quickstart.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: tutorial +--- + # Security-Guard monitoring quickstart This tutorial shows how you can use Security-Guard to protect a deployed Knative Service. diff --git a/docs/serving/architecture.md b/docs/serving/architecture.md index f74039bf6..356e49c7e 100644 --- a/docs/serving/architecture.md +++ b/docs/serving/architecture.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Knative Serving Architecture Knative Serving consists of several components forming the backbone of the Serverless Platform. diff --git a/docs/serving/autoscaling/README.md b/docs/serving/autoscaling/README.md index ae23a0eef..962225636 100644 --- a/docs/serving/autoscaling/README.md +++ b/docs/serving/autoscaling/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Autoscaling Knative Serving provides automatic scaling, or _autoscaling_, for applications to match incoming demand. This is provided by default, by using the Knative Pod Autoscaler (KPA). diff --git a/docs/serving/autoscaling/autoscale-go/README.md b/docs/serving/autoscaling/autoscale-go/README.md index f9c8dc9ac..610554824 100644 --- a/docs/serving/autoscaling/autoscale-go/README.md +++ b/docs/serving/autoscaling/autoscale-go/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Autoscale Sample App - Go A demonstration of the autoscaling capabilities of a Knative Serving Revision. diff --git a/docs/serving/autoscaling/autoscaler-types.md b/docs/serving/autoscaling/autoscaler-types.md index 56f1e5a04..735de924d 100644 --- a/docs/serving/autoscaling/autoscaler-types.md +++ b/docs/serving/autoscaling/autoscaler-types.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Supported Autoscaler types Knative Serving supports the implementation of Knative Pod Autoscaler (KPA) and Kubernetes' Horizontal Pod Autoscaler (HPA). This topic lists the features and limitations of each of these Autoscalers, as well as how to configure them. diff --git a/docs/serving/autoscaling/autoscaling-metrics.md b/docs/serving/autoscaling/autoscaling-metrics.md index bbc901177..601c2cabd 100644 --- a/docs/serving/autoscaling/autoscaling-metrics.md +++ b/docs/serving/autoscaling/autoscaling-metrics.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Metrics The metric configuration defines which metric type is watched by the Autoscaler. diff --git a/docs/serving/autoscaling/autoscaling-targets.md b/docs/serving/autoscaling/autoscaling-targets.md index 5a55b475d..ba454939c 100644 --- a/docs/serving/autoscaling/autoscaling-targets.md +++ b/docs/serving/autoscaling/autoscaling-targets.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Targets Configuring a target provide the Autoscaler with a value that it tries to maintain for the configured metric for a revision. diff --git a/docs/serving/autoscaling/concurrency.md b/docs/serving/autoscaling/concurrency.md index 1e9e2a790..469925c24 100644 --- a/docs/serving/autoscaling/concurrency.md +++ b/docs/serving/autoscaling/concurrency.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Configuring concurrency Concurrency determines the number of simultaneous requests that can be processed by each replica of an application at any given time. diff --git a/docs/serving/autoscaling/kpa-specific.md b/docs/serving/autoscaling/kpa-specific.md index a92a4ddd3..ffb749cdb 100644 --- a/docs/serving/autoscaling/kpa-specific.md +++ b/docs/serving/autoscaling/kpa-specific.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Additional autoscaling configuration for Knative Pod Autoscaler The following settings are specific to the Knative Pod Autoscaler (KPA). diff --git a/docs/serving/autoscaling/rps-target.md b/docs/serving/autoscaling/rps-target.md index 4b569ff9d..c9791f15b 100644 --- a/docs/serving/autoscaling/rps-target.md +++ b/docs/serving/autoscaling/rps-target.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Configuring the requests per second (RPS) target This setting specifies a target for requests-per-second per replica of an application. Your revision must also be configured to use the `rps` [metric annotation](autoscaling-metrics.md). diff --git a/docs/serving/autoscaling/scale-bounds.md b/docs/serving/autoscaling/scale-bounds.md index a3fcd50ca..028e3cf0c 100644 --- a/docs/serving/autoscaling/scale-bounds.md +++ b/docs/serving/autoscaling/scale-bounds.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Configuring scale bounds You can configure upper and lower bounds to control autoscaling behavior. diff --git a/docs/serving/autoscaling/scale-to-zero.md b/docs/serving/autoscaling/scale-to-zero.md index d1ba9ae66..ddb6f7c7c 100644 --- a/docs/serving/autoscaling/scale-to-zero.md +++ b/docs/serving/autoscaling/scale-to-zero.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Configuring scale to zero !!! warning diff --git a/docs/serving/config-ha.md b/docs/serving/config-ha.md index 58caf6d9c..5f60a129c 100644 --- a/docs/serving/config-ha.md +++ b/docs/serving/config-ha.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring high-availability components Active/passive high availability (HA) is a standard feature of Kubernetes APIs that helps to ensure that APIs stay operational if a disruption occurs. In an HA deployment, if an active controller crashes or is deleted, another controller is available to take over processing of the APIs that were being serviced by the controller that is now unavailable. diff --git a/docs/serving/configuration/config-defaults.md b/docs/serving/configuration/config-defaults.md index 7d4c0e723..344c4676a 100644 --- a/docs/serving/configuration/config-defaults.md +++ b/docs/serving/configuration/config-defaults.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Configuring the Defaults ConfigMap The `config-defaults` ConfigMap, known as the Defaults ConfigMap, contains settings that determine how Knative sets default values for resources. diff --git a/docs/serving/configuration/deployment.md b/docs/serving/configuration/deployment.md index d23ea0646..4b6e73836 100644 --- a/docs/serving/configuration/deployment.md +++ b/docs/serving/configuration/deployment.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Configure Deployment resources The `config-deployment` ConfigMap, known as the Deployment ConfigMap, contains settings that determine how Kubernetes `Deployment` resources, which back Knative services, are configured. This ConfigMap is located in the `knative-serving` namespace. diff --git a/docs/serving/configuration/feature-flags.md b/docs/serving/configuration/feature-flags.md index 39652a4a8..4b86e482f 100644 --- a/docs/serving/configuration/feature-flags.md +++ b/docs/serving/configuration/feature-flags.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Feature and extension flags The Knative API is designed to be portable, and abstracts away specific implementation details for user deployments. The intention of the API is to empower users to surface extra features and extensions that are possible within their platform of choice. diff --git a/docs/serving/configuration/rolling-out-latest-revision-configmap.md b/docs/serving/configuration/rolling-out-latest-revision-configmap.md index 4d38b148f..b573fa787 100644 --- a/docs/serving/configuration/rolling-out-latest-revision-configmap.md +++ b/docs/serving/configuration/rolling-out-latest-revision-configmap.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + {% include "gradual-rollout-intro.md" %} ## Procedure diff --git a/docs/serving/convert-deployment-to-knative-service.md b/docs/serving/convert-deployment-to-knative-service.md index aa4447483..5f022a500 100644 --- a/docs/serving/convert-deployment-to-knative-service.md +++ b/docs/serving/convert-deployment-to-knative-service.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Converting a Kubernetes Deployment to a Knative Service This topic shows how to convert a Kubernetes Deployment to a Knative Service. diff --git a/docs/serving/deploying-from-private-registry.md b/docs/serving/deploying-from-private-registry.md index 37bbf4fb3..8de7ccfe3 100644 --- a/docs/serving/deploying-from-private-registry.md +++ b/docs/serving/deploying-from-private-registry.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Deploying images from a private container registry You can configure your Knative cluster to deploy images from a private registry across multiple Services and Revisions. To do this, you must create a list of Kubernetes secrets ([`imagePullSecrets`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#pod-v1-core)) by using your registry credentials. You must then add those secrets to the default [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) for all Services, or the Revision template for a single Service. diff --git a/docs/serving/encryption/cluster-local-domain-tls.md b/docs/serving/encryption/cluster-local-domain-tls.md index 7758f01c7..96c454152 100644 --- a/docs/serving/encryption/cluster-local-domain-tls.md +++ b/docs/serving/encryption/cluster-local-domain-tls.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configure cluster-local domain encryption {% include "encryption-notice.md" %} diff --git a/docs/serving/encryption/configure-certmanager-integration.md b/docs/serving/encryption/configure-certmanager-integration.md index 25b64b871..3f21a484d 100644 --- a/docs/serving/encryption/configure-certmanager-integration.md +++ b/docs/serving/encryption/configure-certmanager-integration.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring Knative cert-manager integration Knative Serving relies on a bridging component to use cert-manager for automated certificate provisioning. diff --git a/docs/serving/encryption/encryption-overview.md b/docs/serving/encryption/encryption-overview.md index c02bf88a4..fb36ecd93 100644 --- a/docs/serving/encryption/encryption-overview.md +++ b/docs/serving/encryption/encryption-overview.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: explanation +--- + # Serving Encryption Overview {% include "encryption-notice.md" %} diff --git a/docs/serving/encryption/external-domain-tls.md b/docs/serving/encryption/external-domain-tls.md index d22a99873..6eeab6bab 100644 --- a/docs/serving/encryption/external-domain-tls.md +++ b/docs/serving/encryption/external-domain-tls.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configure external domain encryption Knative allows to use either use custom TLS certificates or to use automatically generated TLS certificates diff --git a/docs/serving/encryption/system-internal-tls.md b/docs/serving/encryption/system-internal-tls.md index c3d01a8bc..0c070966c 100644 --- a/docs/serving/encryption/system-internal-tls.md +++ b/docs/serving/encryption/system-internal-tls.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configure Knative system-internal encryption {% include "encryption-notice.md" %} diff --git a/docs/serving/istio-authorization.md b/docs/serving/istio-authorization.md index 7d7d3cd70..a7e3a0937 100644 --- a/docs/serving/istio-authorization.md +++ b/docs/serving/istio-authorization.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Enabling requests to Knative services when additional authorization policies are enabled Knative Serving system pods, such as the activator and autoscaler components, require access to your deployed Knative services. diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index bf9a8202c..83bf33357 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Kubernetes services This guide describes the diff --git a/docs/serving/load-balancing/README.md b/docs/serving/load-balancing/README.md index 1d7d66358..0459b44eb 100644 --- a/docs/serving/load-balancing/README.md +++ b/docs/serving/load-balancing/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Load balancing You can turn on Knative load balancing, by placing the _Activator service_ in the request path to act as a load balancer. To do this, you must first ensure that individual pod addressability is enabled. diff --git a/docs/serving/load-balancing/activator-capacity.md b/docs/serving/load-balancing/activator-capacity.md index 4d9cc2324..e4753578e 100644 --- a/docs/serving/load-balancing/activator-capacity.md +++ b/docs/serving/load-balancing/activator-capacity.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring Activator capacity If there is more than one Activator in the system, Knative puts as many Activators on the request path as required to handle the current request load plus the target burst capacity. If the target burst capacity is 0, Knative only puts the Activator into the request path if the Revision is scaled to zero. diff --git a/docs/serving/load-balancing/target-burst-capacity.md b/docs/serving/load-balancing/target-burst-capacity.md index 0ed00a92b..ea5d35d33 100644 --- a/docs/serving/load-balancing/target-burst-capacity.md +++ b/docs/serving/load-balancing/target-burst-capacity.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Configuring target burst capacity _Target burst capacity_ is a [global and per-revision](../autoscaling/autoscaler-types.md#global-versus-per-revision-settings) integer setting that determines the size of traffic burst a Knative application can handle without buffering. diff --git a/docs/serving/observability/logging/collecting-logs.md b/docs/serving/observability/logging/collecting-logs.md index 688b1b0ca..3d4b9b12d 100644 --- a/docs/serving/observability/logging/collecting-logs.md +++ b/docs/serving/observability/logging/collecting-logs.md @@ -1 +1,8 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + --8<-- "collecting-logs.md" diff --git a/docs/serving/observability/logging/config-logging.md b/docs/serving/observability/logging/config-logging.md index dbe2a1458..252f836e0 100644 --- a/docs/serving/observability/logging/config-logging.md +++ b/docs/serving/observability/logging/config-logging.md @@ -1 +1,8 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + --8<-- "configuring-logs.md" diff --git a/docs/serving/observability/logging/request-logging.md b/docs/serving/observability/logging/request-logging.md index c20433218..3561effe9 100644 --- a/docs/serving/observability/logging/request-logging.md +++ b/docs/serving/observability/logging/request-logging.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring Request Log Settings The request logging for knative serving is managed through the `config-observability` ConfigMap in `knative-serving` namespace. The request logs will be printed by the queue-proxy sidecar. diff --git a/docs/serving/observability/metrics/collecting-metrics.md b/docs/serving/observability/metrics/collecting-metrics.md index c9fb720a8..a8abbf126 100644 --- a/docs/serving/observability/metrics/collecting-metrics.md +++ b/docs/serving/observability/metrics/collecting-metrics.md @@ -1 +1,8 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + --8<-- "collecting-metrics.md" diff --git a/docs/serving/observability/metrics/serving-metrics.md b/docs/serving/observability/metrics/serving-metrics.md index 4a2c492a6..3f3291adb 100644 --- a/docs/serving/observability/metrics/serving-metrics.md +++ b/docs/serving/observability/metrics/serving-metrics.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Knative Serving metrics Administrators can monitor Serving control plane based on the metrics exposed by each Serving component. diff --git a/docs/serving/queue-extensions.md b/docs/serving/queue-extensions.md index 811a02bfc..53a3600d2 100644 --- a/docs/serving/queue-extensions.md +++ b/docs/serving/queue-extensions.md @@ -1,3 +1,10 @@ +--- +audience: contributor +components: + - serving +function: how-to +--- + # Extending Queue Proxy image with QPOptions Knative service pods include two containers: diff --git a/docs/serving/request-flow.md b/docs/serving/request-flow.md index d1ce3e0f7..60fb0bfef 100644 --- a/docs/serving/request-flow.md +++ b/docs/serving/request-flow.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # HTTP Request Flows While [the overview](/docs/serving) describes the logical components and diff --git a/docs/serving/revisions/README.md b/docs/serving/revisions/README.md index 9e2a62a32..9c2dd2426 100644 --- a/docs/serving/revisions/README.md +++ b/docs/serving/revisions/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # About Revisions --8<-- "about-revisions.md" diff --git a/docs/serving/revisions/revision-admin-config-options.md b/docs/serving/revisions/revision-admin-config-options.md index 500219330..41e7b9152 100644 --- a/docs/serving/revisions/revision-admin-config-options.md +++ b/docs/serving/revisions/revision-admin-config-options.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: reference +--- + # Administrator configuration options If you have cluster administrator permissions for your Knative installation, you can modify ConfigMaps to change the global default configuration options for Revisions of Knative Services on the cluster. diff --git a/docs/serving/revisions/revision-developer-config-options.md b/docs/serving/revisions/revision-developer-config-options.md index 005afe144..9c64c0d7d 100644 --- a/docs/serving/revisions/revision-developer-config-options.md +++ b/docs/serving/revisions/revision-developer-config-options.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Developer configuration options While Revisions cannot be created manually without modifying the Configuration of a Knative Service, you can modify the spec of an existing Revision to change its behavior. diff --git a/docs/serving/rolling-out-latest-revision.md b/docs/serving/rolling-out-latest-revision.md index 81f834a1e..601a97a03 100644 --- a/docs/serving/rolling-out-latest-revision.md +++ b/docs/serving/rolling-out-latest-revision.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + {% include "gradual-rollout-intro.md" %} ## Procedure diff --git a/docs/serving/services/README.md b/docs/serving/services/README.md index 0adb181b4..b93777a03 100755 --- a/docs/serving/services/README.md +++ b/docs/serving/services/README.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # About Knative Services Knative Services are used to deploy an application. To create an application using Knative, you must create a YAML file that defines a Service. This YAML file specifies metadata about the application, points to the hosted image of the app, and allows the Service to be configured. diff --git a/docs/serving/services/certificate-class.md b/docs/serving/services/certificate-class.md index 80b765d03..6be114465 100644 --- a/docs/serving/services/certificate-class.md +++ b/docs/serving/services/certificate-class.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Configuring a custom certificate class for a Service When `external-domain-tls` 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. diff --git a/docs/serving/services/configure-probing.md b/docs/serving/services/configure-probing.md index 2c4ed57d6..788a968df 100644 --- a/docs/serving/services/configure-probing.md +++ b/docs/serving/services/configure-probing.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Configuring Probing ## General understanding of Knative Probing diff --git a/docs/serving/services/configure-requests-limits-services.md b/docs/serving/services/configure-requests-limits-services.md index 8bfbaa2dd..1f82a995d 100644 --- a/docs/serving/services/configure-requests-limits-services.md +++ b/docs/serving/services/configure-requests-limits-services.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Configure resource requests and limits You can configure resource limits and requests, specifically for CPU and memory, for individual Knative services. diff --git a/docs/serving/services/creating-services.md b/docs/serving/services/creating-services.md index a2cc6e738..f66444aad 100644 --- a/docs/serving/services/creating-services.md +++ b/docs/serving/services/creating-services.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Creating a Service You can create a Knative service by applying a YAML file or using the `kn service create` CLI command. diff --git a/docs/serving/services/custom-domains.md b/docs/serving/services/custom-domains.md index 5d69e8f42..f5630f9d8 100644 --- a/docs/serving/services/custom-domains.md +++ b/docs/serving/services/custom-domains.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Configuring custom domains {{ feature(beta="0.24") }} diff --git a/docs/serving/services/custom-tls-certificate-domain-mapping.md b/docs/serving/services/custom-tls-certificate-domain-mapping.md index c13658f4d..d74164c9b 100644 --- a/docs/serving/services/custom-tls-certificate-domain-mapping.md +++ b/docs/serving/services/custom-tls-certificate-domain-mapping.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Using a custom TLS certificate for DomainMapping {{ feature(beta="0.24") }} diff --git a/docs/serving/services/http-protocol.md b/docs/serving/services/http-protocol.md index 7dfddf913..acab1b7d6 100644 --- a/docs/serving/services/http-protocol.md +++ b/docs/serving/services/http-protocol.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring HTTP ## HTTPS redirection diff --git a/docs/serving/services/ingress-class.md b/docs/serving/services/ingress-class.md index ea3242cc8..1f23928f8 100644 --- a/docs/serving/services/ingress-class.md +++ b/docs/serving/services/ingress-class.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # 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. diff --git a/docs/serving/services/private-services.md b/docs/serving/services/private-services.md index 9b083393c..8f1c0297c 100644 --- a/docs/serving/services/private-services.md +++ b/docs/serving/services/private-services.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Configuring private Services By default, Services deployed through Knative use the `.svc.cluster.local` domain, meaning diff --git a/docs/serving/services/service-metrics.md b/docs/serving/services/service-metrics.md index d9d463159..429e641b7 100644 --- a/docs/serving/services/service-metrics.md +++ b/docs/serving/services/service-metrics.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: reference +--- + # Service metrics Every Knative Service has a proxy container that proxies the connections to the application container. A number of metrics are reported for the queue proxy performance. diff --git a/docs/serving/services/storage.md b/docs/serving/services/storage.md index 95d3ff563..4ec4da585 100644 --- a/docs/serving/services/storage.md +++ b/docs/serving/services/storage.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Volume Support for Knative services You can provide data storage for Knative Services by configuring different volumes types. diff --git a/docs/serving/services/using-queue-extensions.md b/docs/serving/services/using-queue-extensions.md index 6e8699e25..e54396ad3 100644 --- a/docs/serving/services/using-queue-extensions.md +++ b/docs/serving/services/using-queue-extensions.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: explanation +--- + # Using extensions enabled by QPOptions QPOptions is a Queue Proxy feature that enables extending Queue Proxy with additional Go packages. For example, the [security-guard](https://knative.dev/security-guard#section-readme) repository extends Queue Proxy by adding runtime security features to protect user services. diff --git a/docs/serving/setting-up-custom-ingress-gateway.md b/docs/serving/setting-up-custom-ingress-gateway.md index 86664dbad..27945ad6a 100644 --- a/docs/serving/setting-up-custom-ingress-gateway.md +++ b/docs/serving/setting-up-custom-ingress-gateway.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring the ingress gateway Knative uses a shared ingress Gateway to serve all incoming traffic within diff --git a/docs/serving/tag-resolution.md b/docs/serving/tag-resolution.md index 241f524af..59ddd6719 100644 --- a/docs/serving/tag-resolution.md +++ b/docs/serving/tag-resolution.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Tag resolution Knative Serving resolves image tags to a digest when you create a Revision. This diff --git a/docs/serving/traffic-management.md b/docs/serving/traffic-management.md index 7d370450a..5d6252854 100644 --- a/docs/serving/traffic-management.md +++ b/docs/serving/traffic-management.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Traffic management You can manage traffic routing to different Revisions of a Knative Service by modifying the `traffic` spec of the Service resource. diff --git a/docs/serving/troubleshooting/debugging-application-issues.md b/docs/serving/troubleshooting/debugging-application-issues.md index 0e992507a..eccba9319 100644 --- a/docs/serving/troubleshooting/debugging-application-issues.md +++ b/docs/serving/troubleshooting/debugging-application-issues.md @@ -1,3 +1,10 @@ +--- +audience: developer +components: + - serving +function: how-to +--- + # Debugging application issues If you have deployed an application but are having issues, you can use the following steps to troubleshoot the application. diff --git a/docs/serving/using-a-custom-domain.md b/docs/serving/using-a-custom-domain.md index a5a865233..1caa5cd93 100644 --- a/docs/serving/using-a-custom-domain.md +++ b/docs/serving/using-a-custom-domain.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Configuring domain names You can customize the domain of an individual Knative Service, or set a global default domain for all Services created on a cluster. The fully qualified domain name for a route by default is `{route}.{namespace}.svc.cluster.local`. diff --git a/docs/serving/webhook-customizations.md b/docs/serving/webhook-customizations.md index d5f370e32..5af369294 100644 --- a/docs/serving/webhook-customizations.md +++ b/docs/serving/webhook-customizations.md @@ -1,3 +1,10 @@ +--- +audience: administrator +components: + - serving +function: how-to +--- + # Exclude namespaces from the Knative webhook The Knative webhook examines resources that are created, read, updated, or deleted. This includes system namespaces, which can cause issues during an upgrade if the webhook becomes non-responsive. Cluster administrators may want to disable the Knative webhook on system namespaces to prevent issues during upgrades.