From 70957308e47b842912ced863c7f232b0f764f4fc Mon Sep 17 00:00:00 2001 From: "Paul S. Schweigert" Date: Thu, 30 Mar 2023 15:08:04 -0400 Subject: [PATCH] remove documentation for container-freezer Signed-off-by: Paul S. Schweigert The container-freezer is being archived as discussed in https://github.com/knative-sandbox/container-freezer/issues/217, so this commit is to remove its documentation from the website. --- config/nav.yml | 1 - docs/serving/autoscaling/README.md | 1 - docs/serving/autoscaling/container-freezer.md | 54 ------------------- docs/serving/configuration/deployment.md | 22 -------- 4 files changed, 78 deletions(-) delete mode 100644 docs/serving/autoscaling/container-freezer.md diff --git a/config/nav.yml b/config/nav.yml index 195708362e..4addffcc57 100644 --- a/config/nav.yml +++ b/config/nav.yml @@ -111,7 +111,6 @@ nav: - Configuring scale bounds: serving/autoscaling/scale-bounds.md - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md - - Configuring container-freezer: serving/autoscaling/container-freezer.md # Serving - developer docs - Developer Topics: - Services: diff --git a/docs/serving/autoscaling/README.md b/docs/serving/autoscaling/README.md index 748e6c4e50..ae23a0eeff 100644 --- a/docs/serving/autoscaling/README.md +++ b/docs/serving/autoscaling/README.md @@ -15,4 +15,3 @@ To use autoscaling for your application if it is enabled on your cluster, you mu * Try out the [Go Autoscale Sample App](autoscale-go/README.md). * Configure your Knative deployment to use the Kubernetes Horizontal Pod Autoscaler (HPA) instead of the default KPA. For how to install HPA, see [Install optional Serving extensions](../../install/yaml-install/serving/install-serving-with-yaml.md#install-optional-serving-extensions). * Configure the [types of metrics](autoscaling-metrics.md) that the Autoscaler consumes. -* Configure your Knative Service to use [container-freezer](container-freezer.md), which freezes the running process when the pod's traffic drops to zero. The most valuable benefit is reducing the cold-start time within this configuration. diff --git a/docs/serving/autoscaling/container-freezer.md b/docs/serving/autoscaling/container-freezer.md deleted file mode 100644 index 13ac1bb945..0000000000 --- a/docs/serving/autoscaling/container-freezer.md +++ /dev/null @@ -1,54 +0,0 @@ -# Configuring container-freezer - -When container-freezer is enabled, queue-proxy calls an endpoint API when its traffic drops to zero or scales up from zero. - -Within the community-maintained endpoint API implementation container-freezer, the running process is frozen when the pod's traffic drops to zero, and resumed when the pod's traffic scales up from zero. However, users can also run their own implementation instead (for example, as a billing component to log when requests are being handled). - -## Configure min-scale - -To use container-freezer, the value of per-revision annotation key `autoscaling.knative.dev/min-scale` must be greater than zero. - -**Example:** -=== "Per Revision" - ```yaml - apiVersion: serving.knative.dev/v1 - kind: Service - metadata: - name: helloworld-go - namespace: default - spec: - template: - metadata: - annotations: - autoscaling.knative.dev/min-scale: "3" - spec: - containers: - - image: gcr.io/knative-samples/helloworld-go - ``` - - -## Configure the endpoint API address - -Queue-proxy calls the endpoint API address when container-freezer is enabled, so you need to configure the API address. - -1. Open the `config-deployment` ConfigMap by running the command: - ```bash - kubectl edit configmap config-deployment -n knative-serving - ``` -1. Edit the file to configure the endpoint API address, for example: - ```yaml - apiVersion: v1 - kind: ConfigMap - metadata: - name: config-deployment - namespace: knative-serving - data: - concurrency-state-endpoint: "http://$HOST_IP:9696" - ``` - - !!! note - If using the community-maintained implementation, use `http://$HOST_IP:9696` as the value for `concurrency-state-endpoint`, as the community-maintained implementation is a daemonset and the appropriate value will be inserted by queue-proxy at runtime. If the user-specific endpoint API implementation is deployed a service in the cluster, use a specific service address such as `http://billing.default.svc:9696`. - -## Next -* Implement your own user-specific endpoint API, and deploy it in cluster. -* Use the community-maintained [container-freezer](https://github.com/knative-sandbox/container-freezer) implementation. diff --git a/docs/serving/configuration/deployment.md b/docs/serving/configuration/deployment.md index 11dd77003c..f2a134fc92 100644 --- a/docs/serving/configuration/deployment.md +++ b/docs/serving/configuration/deployment.md @@ -109,25 +109,3 @@ data: # List of repositories for which tag to digest resolving should be skipped registries-skipping-tag-resolving: registry.example.com ``` - -## Enable container-freezer service - -You can configure queue-proxy to pause pods when not in use by enabling the `container-freezer` service. It calls a stand-alone service (via a user-specified endpoint) when a pod's traffic drops to zero or scales up from zero. To enable it, set `concurrency-state-endpoint` to a non-empty value. With this configuration, you can achieve some features like freezing running processes in pods or billing based on the time it takes to process the requests. - -Before you configure this, you need to implement the endpoint API. The official implementation is container-freezer. You can install it by following the installation instructions in the [container-freezer README](https://github.com/knative-sandbox/container-freezer). - -The following example shows how to enable the container-freezer service. When using `$HOST_IP`, the container-freezer service inserts the appropriate value for each node at runtime: - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: config-deployment - namespace: knative-serving - labels: - serving.knative.dev/release: devel - annotations: - knative.dev/example-checksum: "fa67b403" -data: - concurrency-state-endpoint: "http://$HOST_IP:9696" -```