From c759726db22c85c9ff5e3a9b913b3566d6cf6872 Mon Sep 17 00:00:00 2001 From: kahirokunn Date: Tue, 21 May 2024 14:11:37 +0900 Subject: [PATCH] fix: Rename keda-add-ons-http-interceptor-proxy to keda-http-add-on-interceptor-proxy Signed-off-by: kahirokunn --- CONTRIBUTING.md | 2 +- docs/design.md | 2 +- docs/integrations.md | 4 ++-- docs/walkthrough.md | 2 +- examples/xkcd/templates/httproute.yaml | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 438b738a7..c7bd7fa84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,7 +97,7 @@ K9s integrates Hey, a CLI tool to benchmark HTTP endpoints similar to AB bench. (b) search for services using - “:service” - (c) HTTP traffic needs to route through the Service that the add on has set up. Find interceptor proxy service i.e. ‘keda-add-ons-http-interceptor-proxy’ and port forward it using + (c) HTTP traffic needs to route through the Service that the add on has set up. Find interceptor proxy service i.e. ‘keda-http-add-on-interceptor-proxy’ and port forward it using (d) Search for the same port-forward in the list you get by command - “:pf” diff --git a/docs/design.md b/docs/design.md index 30fa1e40d..e757f8311 100644 --- a/docs/design.md +++ b/docs/design.md @@ -29,7 +29,7 @@ When the `HTTPScaledObject` is deleted, the operator reverses all of the aforeme ### Autoscaling for HTTP Apps -After an `HTTPScaledObject` is created and the operator creates the appropriate resources, you must send HTTP requests through the interceptor so that the application is scaled. A Kubernetes `Service` called `keda-add-ons-http-interceptor-proxy` was created when you `helm install`ed the add-on. Send requests to that service. +After an `HTTPScaledObject` is created and the operator creates the appropriate resources, you must send HTTP requests through the interceptor so that the application is scaled. A Kubernetes `Service` called `keda-http-add-on-interceptor-proxy` was created when you `helm install`ed the add-on. Send requests to that service. The interceptor keeps track of the number of pending HTTP requests - HTTP requests that it has forwarded but the app hasn't returned. The scaler periodically makes HTTP requests to the interceptor via an internal RPC endpoint - on a separate port from the public server - to get the size of the pending queue. Based on this queue size, it reports scaling metrics as appropriate to KEDA. As the queue size increases, the scaler instructs KEDA to scale up as appropriate. Similarly, as the queue size decreases, the scaler instructs KEDA to scale down. diff --git a/docs/integrations.md b/docs/integrations.md index d3b031579..743757106 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -7,7 +7,7 @@ 1. **Proxy Service in Virtual Service:** - Within the Istio virtual service definition, add a proxy service as a route destination. - - Set the host of this proxy service to `keda-add-ons-http-interceptor-proxy`` (the KEDA HTTP Addon interceptor service). + - Set the host of this proxy service to `keda-http-add-on-interceptor-proxy`` (the KEDA HTTP Addon interceptor service). - Set the port to `8080`` (the default interceptor port). **Example yaml** @@ -22,7 +22,7 @@ spec: http: - route: - destination: - host: keda-add-ons-http-interceptor-proxy + host: keda-http-add-on-interceptor-proxy port: 8080 ``` diff --git a/docs/walkthrough.md b/docs/walkthrough.md index 8651293d8..beb654119 100644 --- a/docs/walkthrough.md +++ b/docs/walkthrough.md @@ -53,7 +53,7 @@ As said above, you need to route your HTTP traffic to the `Service` that the add keda-http-add-on-interceptor-proxy ``` -> This is installed by raw manifests. If you are using the [Helm chart](https://github.com/kedacore/charts/tree/main/http-add-on) to install the add-on, it crates a service named `keda-add-ons-http-interceptor-proxy` as a `ClusterIP` by default. +> This is installed by raw manifests. If you are using the [Helm chart](https://github.com/kedacore/charts/tree/main/http-add-on) to install the add-on, it crates a service named `keda-http-add-on-interceptor-proxy` as a `ClusterIP` by default. #### Installing and Using the [ingress-nginx](https://kubernetes.github.io/ingress-nginx/deploy/#using-helm) Ingress Controller diff --git a/examples/xkcd/templates/httproute.yaml b/examples/xkcd/templates/httproute.yaml index 04351ec67..047d4bc51 100644 --- a/examples/xkcd/templates/httproute.yaml +++ b/examples/xkcd/templates/httproute.yaml @@ -14,7 +14,7 @@ spec: rules: - backendRefs: - kind: Service - name: keda-add-ons-http-interceptor-proxy + name: keda-http-add-on-interceptor-proxy namespace: keda port: 8080 matches: @@ -35,5 +35,5 @@ spec: to: - group: "" kind: Service - name: keda-add-ons-http-interceptor-proxy + name: keda-http-add-on-interceptor-proxy {{- end }}