Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Latest commit

 

History

History
150 lines (124 loc) · 5.58 KB

reference.md

File metadata and controls

150 lines (124 loc) · 5.58 KB
Raw

Configuration Reference

This document covers the details of configration of the Durable Scaler.

KEDA Durable Scaler Configration

The configuration of the Scale Server. You can refer the actual yaml file in here.

Example Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  name: keda-durable-external-scaler
  namespace: keda
spec:
  selector:
    matchLabels:
      service: keda-durable-external-scaler
  replicas: 1
  template:
    metadata:
      labels:
        service: keda-durable-external-scaler
    spec:
      serviceAccountName: keda-durable-scaler
      containers:
      - image: kedacore/keda-scaler-durable-functions:latest
        name: scaler
        ports:
          - containerPort: 5000
        env:
        - name: CONNECTION_STRING
          valueFrom:
            secretKeyRef:
              name: keda-durable-external-scaler
              key: connection-string 
        - name: TASK_HUB
          value: DurableFunctionsHub
        - name: MAX_POLLING_INTERVAL
          value: "5000"
        - name: Logging__LogLevel__Grpc
          value: Debug
        - name: Logging__LogLevel__Keda.Durable.Scaler.Server.Services.ExternalScalerService
          value: Debug
        - name: Logging__LogLevel__Default
          value: Information
        - name: CERT_PATH
          value: /certs/grpcsv.pfx
        - name: CERT_PASS
          value: keda
        volumeMounts:
        - name: certs
          mountPath: /certs
          readOnly: true
      volumes:
      - name: certs
        secret:
          secretName: keda-durable-external-scaler

Argument Reference

The following arguments are supported:

  • containerPort - (Required) gRPC configuration for the protocol. 5000 for http, 5001 for https. (currently, 5000 only. 5001 will be supporeted soon.)
  • TASK_HUB - (Required) TaskHub name of your Durable Functions.
  • MAX_POLLING_INTERVAL - (Optional) Polling interval (millisecond) for DurableTask. It is not the polling interval of the KEDA scaler. DurableTask, that is used in this Scaler, is polling individually. Default Value is 5000.
  • Logging__LogLevel__Grpc (Optional) Log Level for gRPC. Possible values are Trace, Debug, Information, Warning, Error, and Critical. For more information Log level, Logging and diagnostics in gRPC on .NET
  • Logging__LogLevel__Keda.Durable.Scaler.Server.Services.ExternalScalerService: (Optional) Log Level for core service part of KEDA Durable Scaler Server. Possible values are the same as above.
  • Logging__LogLevel__Default: (Optional) Log Level for all classes of KEDA Durable Scale Server. Possible values are the same above.
  • CERT_PATH: (Required) The path for the certificate of TLS for https.
  • CERT_PASS: (Required) The password the certificate of TLS for https. It recommended to make it secret for production.

Durable Functions Scale Object

Scale Object is configration object of this scaler. Please refer actual example in here.

Example ScaleObject

apiVersion: keda.k8s.io/v1alpha1
kind: ScaledObject
metadata:
  name: durable-keda
  namespace: default
  labels:
    deploymentName: durable-keda
spec:
  scaleTargetRef:
    deploymentName: durable-keda
  triggers:
  - type: external
    metadata:
      scalerAddress: durable-external-scaler-service.keda.svc.cluster.local:5000

Argument Reference

The following arguments are supported:

  • metadata.name: (Required) The name of the ScaleObject. It should be the same as deploymentName.
  • metadata.namespace: (Required) The namespace. It should be the same as deployment of durable functions.
  • metadata.labels.deploymentName: (Required) The name of the deployment of durable functions.
  • spec.scaleTargetRef.deploymentName: (Required) The name of the deployment of durable functions.
  • spec.triggers.metadata.scaleAddress: (Required) Address and port of KEDA Durable Scale Server's endpoint.
  • spec.triggers.metadata.tlsCertFile: (Optional) TLS certfile for https between KEDA and KEDA Durable Scaler Server. Currently not supported. Coming soon.

You can find more argument that is allowed for ScaleObject in here.

Debugging on containers

Endpoint of Durable Functions

For the examples/durable-keda app, you can start orchestration to call http://40.90.221.xxx/api/LoadOrchestration_HttpStart.

$ kubectl get svc  
NAME           TYPE           CLUSTER-IP   EXTERNAL-IP    PORT(S)        AGE
durable-keda   LoadBalancer   10.0.221.5   40.90.221.xxx   80:31180/TCP   2d

Log for KEDA Durable Scale Server

$ kubectl get pod -n keda
NAME                                            READY   STATUS    RESTARTS   AGE
keda-durable-external-scaler-54854fc478-n2mjs   1/1     Running   0          4h19m
keda-operator-57c9c8d7fc-rbxq2                  2/2     Running   0          4d5h
$ kubectl logs -f keda-durable-external-scaler-54854fc478-n2mjs -n keda

Log for KEDA

$ kubectl logs -f keda-operator-57c9c8d7fc-rbxq2 keda-operator -n keda

or

$ kubectl logs -f keda-operator-57c9c8d7fc-rbxq2 keda-metrics-apiserver -n keda

Number of current pod

For the examples/durable-keda app:

$ kubectl get pods