Skip to content

Commit

Permalink
fix: Rename keda-add-ons-http-interceptor-proxy to keda-http-add-on-i…
Browse files Browse the repository at this point in the history
…nterceptor-proxy

Signed-off-by: kahirokunn <[email protected]>
  • Loading branch information
kahirokunn committed Oct 11, 2024
1 parent 54ed066 commit 860438b
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <SHIFT+F>
(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 <SHIFT+F>
(d) Search for the same port-forward in the list you get by command - “:pf”
Expand Down
2 changes: 1 addition & 1 deletion docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -22,7 +22,7 @@ spec:
http:
- route:
- destination:
host: keda-add-ons-http-interceptor-proxy
host: keda-http-add-on-interceptor-proxy
port: 8080
```
Expand Down
8 changes: 4 additions & 4 deletions docs/walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,18 @@ kubectl apply -n $NAMESPACE -f examples/v0.8.0/httpscaledobject.yaml
You've now installed a web application and activated autoscaling by creating an `HTTPScaledObject` for it. For autoscaling to work properly, HTTP traffic needs to route through the `Service` that the add-on has set up. You can use `kubectl port-forward` to quickly test things out:

```console
kubectl port-forward svc/keda-add-ons-http-interceptor-proxy -n ${NAMESPACE} 8080:8080
kubectl port-forward svc/keda-http-add-on-interceptor-proxy -n ${NAMESPACE} 8080:8080
```

### Routing to the Right `Service`

As said above, you need to route your HTTP traffic to the `Service` that the add-on has created during the installation. If you have existing systems - like an ingress controller - you'll need to anticipate the name of these created `Service`s. Each one will be named consistently like so, in the same namespace as the `HTTPScaledObject` and your application (i.e. `$NAMESPACE`):

```console
keda-add-ons-http-interceptor-proxy
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

Expand Down Expand Up @@ -144,7 +144,7 @@ curl -H "Host: myhost.com" <Your IP>/path1
You can also use port-forward to interceptor service for making the request:

```console
kubectl port-forward svc/keda-add-ons-http-interceptor-proxy -n ${NAMESPACE} 8080:8080
kubectl port-forward svc/keda-http-add-on-interceptor-proxy -n ${NAMESPACE} 8080:8080
curl -H "Host: myhost.com" localhost:8080/path1
```

Expand Down
2 changes: 1 addition & 1 deletion examples/xkcd/templates/externalservice.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ metadata:
{{- include "xkcd.labels" . | nindent 4 }}
spec:
type: ExternalName
externalName: keda-add-ons-http-interceptor-proxy.keda
externalName: keda-http-add-on-interceptor-proxy.keda
4 changes: 2 additions & 2 deletions examples/xkcd/templates/httproute.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -35,5 +35,5 @@ spec:
to:
- group: ""
kind: Service
name: keda-add-ons-http-interceptor-proxy
name: keda-http-add-on-interceptor-proxy
{{- end }}

0 comments on commit 860438b

Please sign in to comment.