From c21026d9f7b1555f347f0c2a05cf483ec05163bf Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Wed, 26 Jun 2019 13:43:09 -0700 Subject: [PATCH 01/13] Document edit for issue 1522 --- docs/serving/knative-kubernetes-services.md | 72 ++++++++++++--------- 1 file changed, 41 insertions(+), 31 deletions(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 14288e527e8..731a651db0e 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -5,25 +5,36 @@ weight: 9 type: "docs" --- -This document describes what is running when running knative serving. +This guide describes the components that are active when running Knative Serving. -After applying the serving yaml, this will install a few knative services and -deployments on your kubernetes cluster. This document provides an overview of -the deployments and the motivations for each one. +## Before You Begin -```sh -$ kubectl get services -n knative-serving +1. Install Knative Serving. Instructions on how to do this are located + [here](https://knative.dev/docs/install/knative-custom-install/). +2. Verify that you have the proper components in your cluster. To view the services installed in your cluster, use the commmand: + ```sh + $ kubectl get services -n knative-serving + ``` + + This should return the following output: + + ```sh NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE activator-service ClusterIP 10.96.61.11 80/TCP,81/TCP,9090/TCP 1h autoscaler ClusterIP 10.104.217.223 8080/TCP,9090/TCP 1h controller ClusterIP 10.101.39.220 9090/TCP 1h webhook ClusterIP 10.107.144.50 443/TCP 1h ``` + 3. To view the deployments in your cluster, use the following command: + + ```sh + $ kubectl get deployments -n knative-serving + ``` -```sh -$ kubectl get deployments -n knative-serving + This should return the following output: + ```sh NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE activator 1 1 1 1 1h autoscaler 1 1 1 1 1h @@ -33,41 +44,40 @@ networking-istio 1 1 1 1 1h webhook 1 1 1 1 1h ``` -## Service: activator +These serivces and deployments are installed by the `serving.yaml` file during install. The next section describes the function of these components. -The responsibilities of the activator are: +## Components -- Receiving & buffering requests for inactive Revisions. -- Reporting metrics to the autoscaler. -- Retrying requests to a Revision after the autoscaler scales such Revision - based on the reported metrics. +### Service: activator -## Service: autoscaler +The activator is responsible for receiving & buffering requests for inactive revisions and reporting metrics to the autoscaler. In addition, it retries requests to a revision after the autoscaler scales the revision based on the reported metrics. -The autoscaler receives request metrics and adjusts the number of pods required -to handle the load of traffic. +### Service: autoscaler -## Service: controller +The autoscaler receives request metrics and adjusts the number of pods required to handle the load of traffic. + +### Service: controller The controller service reconciles all the public knative objects and autoscaling -CRDs. When a user applies a knative service to the kubernetes api, this creates -the config and route. It will convert config into revisions. It will convert -Revision into Deployment and KPA. +CRDs. When a user applies a Knative service to the Kubernetes API, this creates +the configuration and route. It will convert the configuration into revisions, and the revisions into Deployment and Knative Pod Autoscaling (KPA). + +### Service: webhook -## Service: webhook +The webhook intercepts all Kubernetes API calls as well as all CRD insertions and updates. +It sets default values, rejects inconsitent and invalid objects, and validates and mutates Kubernetes API calls. -The webhook intercepts all kubernetes api calls, all crd insertions and updates. -It does two things: +### Deployment: networking-certmanager -1. Set default values -2. Rejects inconsitent and invalid objects. +The certmanager reconciles cluster ingresses into cert manager objects. -It validates and mutates k8s api calls. +### Deployment: networking-istio -## Deployment: networking-certmanager +The networking-istio deployment reconciles a cluster's ingress into a virtual service. -The certmanager reconciles cluster ingress into cert manager objects. +## What's Next -## Deployment: networking-istio +1. For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). +2. For a high-level analysis of Serving, look at the [Kubernetes documentation](https://Kubernetes.io/docs/concepts/services-networking/service/) +3. Check out the Knative Seriving code samples [here](https://knative.dev/docs/serving/samples/) for more hands-on tutorials. -This reconciles cluster ingress into a virtual service. From b7495c8873ed7a1df0cb39efb1fcc9ae641fb56b Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:14:31 -0700 Subject: [PATCH 02/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 731a651db0e..a2e9b888720 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -11,7 +11,7 @@ This guide describes the components that are active when running Knative Serving 1. Install Knative Serving. Instructions on how to do this are located [here](https://knative.dev/docs/install/knative-custom-install/). -2. Verify that you have the proper components in your cluster. To view the services installed in your cluster, use the commmand: +2. To view the services installed in your cluster, use the commmand: ```sh $ kubectl get services -n knative-serving From 135295356891094e42255e2af8aa5559a61f7e5e Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:14:46 -0700 Subject: [PATCH 03/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index a2e9b888720..77fabf6ba53 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -5,7 +5,7 @@ weight: 9 type: "docs" --- -This guide describes the components that are active when running Knative Serving. +This guide describes the [Kubernetes Services](https://kubernetes.io/docs/concepts/services-networking/service/) that are active when running Knative Serving. ## Before You Begin From a1356a839a99ad64fc47c134a7f9b271eb4bb7d0 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:15:03 -0700 Subject: [PATCH 04/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 77fabf6ba53..d18385211e9 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -44,7 +44,7 @@ networking-istio 1 1 1 1 1h webhook 1 1 1 1 1h ``` -These serivces and deployments are installed by the `serving.yaml` file during install. The next section describes the function of these components. +These services and deployments are installed by the `serving.yaml` file during install. The next section describes their function. ## Components From 481cb62a9d431ea5907b49460d061680fd2a4225 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:15:11 -0700 Subject: [PATCH 05/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index d18385211e9..cc88f14dd4f 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -58,7 +58,7 @@ The autoscaler receives request metrics and adjusts the number of pods required ### Service: controller -The controller service reconciles all the public knative objects and autoscaling +The controller service reconciles all the public Knative objects and autoscaling CRDs. When a user applies a Knative service to the Kubernetes API, this creates the configuration and route. It will convert the configuration into revisions, and the revisions into Deployment and Knative Pod Autoscaling (KPA). From 4bb9ef9878bb9460a6c772cef48b86e999466b81 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:15:22 -0700 Subject: [PATCH 06/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index cc88f14dd4f..c8a68a28f16 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -73,7 +73,7 @@ The certmanager reconciles cluster ingresses into cert manager objects. ### Deployment: networking-istio -The networking-istio deployment reconciles a cluster's ingress into a virtual service. +The networking-istio deployment reconciles a cluster's ingress into an [Istio virtual service](https://istio.io/docs/reference/config/networking/v1alpha3/virtual-service/). ## What's Next From 6e6ec02db77f278fe1d4030456735501474b9444 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:15:34 -0700 Subject: [PATCH 07/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index c8a68a28f16..6c43a97149f 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -60,7 +60,7 @@ The autoscaler receives request metrics and adjusts the number of pods required The controller service reconciles all the public Knative objects and autoscaling CRDs. When a user applies a Knative service to the Kubernetes API, this creates -the configuration and route. It will convert the configuration into revisions, and the revisions into Deployment and Knative Pod Autoscaling (KPA). +the configuration and route. It will convert the configuration into revisions and the revisions into deployments and Knative Pod Autoscalers (KPAs). ### Service: webhook From 069cfe3c804722a38309644e1ce1fee332cc4189 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:15:41 -0700 Subject: [PATCH 08/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 6c43a97149f..4541a963624 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -50,7 +50,7 @@ These services and deployments are installed by the `serving.yaml` file during i ### Service: activator -The activator is responsible for receiving & buffering requests for inactive revisions and reporting metrics to the autoscaler. In addition, it retries requests to a revision after the autoscaler scales the revision based on the reported metrics. +The activator is responsible for receiving & buffering requests for inactive revisions and reporting metrics to the autoscaler. It also retries requests to a revision after the autoscaler scales the revision based on the reported metrics. ### Service: autoscaler From 3d90285891acbdecc507433e2d926aa2f896a699 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:24:02 -0700 Subject: [PATCH 09/13] Addressing review comments for issue 1522 --- docs/serving/knative-kubernetes-services.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 731a651db0e..10e94b57971 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -9,8 +9,8 @@ This guide describes the components that are active when running Knative Serving ## Before You Begin -1. Install Knative Serving. Instructions on how to do this are located - [here](https://knative.dev/docs/install/knative-custom-install/). +1. This guide assumes that you have installed Knative Serving. If you have not, + instructions on how to do this are located [here](https://knative.dev/docs/install/knative-custom-install/). 2. Verify that you have the proper components in your cluster. To view the services installed in your cluster, use the commmand: ```sh @@ -77,7 +77,7 @@ The networking-istio deployment reconciles a cluster's ingress into a virtual se ## What's Next -1. For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). -2. For a high-level analysis of Serving, look at the [Kubernetes documentation](https://Kubernetes.io/docs/concepts/services-networking/service/) -3. Check out the Knative Seriving code samples [here](https://knative.dev/docs/serving/samples/) for more hands-on tutorials. +- For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). +- For a high-level analysis of Serving, look at the [Kubernetes documentation](https://Kubernetes.io/docs/concepts/services-networking/service/) +- Check out the Knative Seriving code samples [here](https://knative.dev/docs/serving/samples/) for more hands-on tutorials. From a14e22e308a189c1fa5c289dc32d71bc334fae29 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 09:59:06 -0700 Subject: [PATCH 10/13] Addressing review comments for issue 1522 --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 54a8da3b719..d8ba417e314 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -78,6 +78,6 @@ The networking-istio deployment reconciles a cluster's ingress into an [Istio vi ## What's Next - For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). -- For a high-level analysis of Serving, look at the [Kubernetes documentation](https://Kubernetes.io/docs/concepts/services-networking/service/) +- For a high-level analysis of Serving, look at the [documentation here](https://knative.dev/docs/serving/) - Check out the Knative Seriving code samples [here](https://knative.dev/docs/serving/samples/) for more hands-on tutorials. From 7bd32ca8a89830b02ef5bd50216f4065f3b9ecfb Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 10:14:13 -0700 Subject: [PATCH 11/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index d8ba417e314..3f4813c9b01 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -79,5 +79,5 @@ The networking-istio deployment reconciles a cluster's ingress into an [Istio vi - For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). - For a high-level analysis of Serving, look at the [documentation here](https://knative.dev/docs/serving/) -- Check out the Knative Seriving code samples [here](https://knative.dev/docs/serving/samples/) for more hands-on tutorials. +- Check out the Knative Seriving code samples [here](./samples/) for more hands-on tutorials. From 281d0401bdc7d896af26f160ae8d47a4ead9ecad Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 10:14:31 -0700 Subject: [PATCH 12/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 3f4813c9b01..8233b882e71 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -78,6 +78,6 @@ The networking-istio deployment reconciles a cluster's ingress into an [Istio vi ## What's Next - For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). -- For a high-level analysis of Serving, look at the [documentation here](https://knative.dev/docs/serving/) +- For a high-level analysis of Serving, look at the [documentation here](../) - Check out the Knative Seriving code samples [here](./samples/) for more hands-on tutorials. From f8fccd68df347f763285b777f795812444ebe7c1 Mon Sep 17 00:00:00 2001 From: Katherine Jackson Date: Fri, 28 Jun 2019 10:33:43 -0700 Subject: [PATCH 13/13] Update docs/serving/knative-kubernetes-services.md Co-Authored-By: Sam O'Dell <31352624+samodell@users.noreply.github.com> --- docs/serving/knative-kubernetes-services.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/serving/knative-kubernetes-services.md b/docs/serving/knative-kubernetes-services.md index 8233b882e71..11835ac0e5f 100644 --- a/docs/serving/knative-kubernetes-services.md +++ b/docs/serving/knative-kubernetes-services.md @@ -78,6 +78,6 @@ The networking-istio deployment reconciles a cluster's ingress into an [Istio vi ## What's Next - For a deeper look at the services and deployments involved in Knative Serving, click [here](https://github.com/knative/serving/blob/master/docs/spec/overview.md#service). -- For a high-level analysis of Serving, look at the [documentation here](../) +- For a high-level analysis of Serving, look at the [documentation here](./). - Check out the Knative Seriving code samples [here](./samples/) for more hands-on tutorials.