Check for events to ensure invalid HPAs are ignored

Signed-off-by: Mikkel Oscar Lyderik Larsen <mikkel.larsen@zalando.de>

.github/CODEOWNERS

@@ -1,35 +0,0 @@
-# These owners will be the default owners for everything in
-# the repo. 
-*       @arjunrn
-
-
-
-# Samples for assigning codeowners below:
-# Order is important; the last matching pattern takes the most
-# precedence. When someone opens a pull request that only
-# modifies JS files, only @js-owner and not the global
-# owner(s) will be requested for a review.
-# *.js    @js-owner
-
-# You can also use email addresses if you prefer. They'll be
-# used to look up users just like we do for commit author
-# emails.
-# *.go docs@example.com
-
-# In this example, @doctocat owns any files in the build/logs
-# directory at the root of the repository and any of its
-# subdirectories.
-# /build/logs/ @doctocat
-
-# The `docs/*` pattern will match files like
-# `docs/getting-started.md` but not further nested files like
-# `docs/build-app/troubleshooting.md`.
-# docs/*  docs@example.com
-
-# In this example, @octocat owns any file in an apps directory
-# anywhere in your repository.
-# apps/ @octocat
-
-# In this example, @doctocat owns any file in the `/docs`
-# directory in the root of your repository.
-# /docs/ @doctocat

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: gomod
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "07:00"
+  open-pull-requests-limit: 10
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "07:00"
+  open-pull-requests-limit: 10

.github/workflows/ci.yaml

@@ -0,0 +1,25 @@
+name: ci
+on: [push, pull_request]
+env:
+  GO111MODULE: on
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-go@v2
+      with:
+        go-version: '^1.16'
+    - run: go version
+    - run: go get github.com/mattn/goveralls
+      env:
+        GO111MODULE: off
+    - run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_RELEASE}
+      env:
+        GOLANGCI_RELEASE: v1.37.0
+    - run: make build.docker
+    - run: make test
+    - run: make check
+    - run: goveralls -coverprofile=profile.cov -service=github
+      env:
+        COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,4 +1,5 @@
 build/
 apiserver.local.config/
 .idea/
+profile.cov
 vendor/

.travis.yml

@@ -1,20 +0,0 @@
-language: go
-dist: xenial
-
-go:
-  - "1.13.x"
-
-env:
-- GO111MODULE=on GOLANGCI_RELEASE="v1.21.0"
-
-before_install:
-  - GO111MODULE=off go get github.com/mattn/goveralls
-  - GO111MODULE=off go get github.com/lawrencewoodman/roveralls
-  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_RELEASE}
-
-script:
-  - make test
-  - make build.docker
-  - make check
-  - roveralls
-  - goveralls -v -coverprofile=roveralls.coverprofile -service=travis-ci

Dockerfile

@@ -1,5 +1,5 @@
-FROM registry.opensource.zalan.do/stups/alpine:latest
-MAINTAINER Team Teapot @ Zalando SE <team-teapot@zalando.de>
+FROM registry.opensource.zalan.do/library/alpine-3.12:latest
+LABEL maintainer="Team Teapot @ Zalando SE <team-teapot@zalando.de>"
 
 # add binary
 ADD build/linux/kube-metrics-adapter /

MAINTAINERS

@@ -1,3 +1,2 @@
 Mikkel Larsen <mikkel.larsen@zalando.de>
-Arjun Naik <arjun.naik@zalando.de>
 Team Teapot <team-teapot@zalando.de>

Makefile

@@ -8,31 +8,57 @@ SOURCES       = $(shell find . -name '*.go')
 DOCKERFILE    ?= Dockerfile
 GOPKGS        = $(shell go list ./...)
 BUILD_FLAGS   ?= -v
+OPENAPI       ?= pkg/api/generated/openapi/zz_generated.openapi.go
 LDFLAGS       ?= -X main.version=$(VERSION) -w -s
+CRD_SOURCES    = $(shell find pkg/apis/zalando.org -name '*.go')
+CRD_TYPE_SOURCE = pkg/apis/zalando.org/v1/types.go
+GENERATED_CRDS = docs/scaling_schedules_crd.yaml
+GENERATED      = pkg/apis/zalando.org/v1/zz_generated.deepcopy.go
+
 
 default: build.local
 
 clean:
 	rm -rf build
+	rm -rf $(OPENAPI)
 
-test:
-	go test -v $(GOPKGS)
+test: $(GENERATED)
+	go test -v -coverprofile=profile.cov $(GOPKGS)
 
-check:
+check: $(GENERATED)
 	go mod download
 	golangci-lint run --timeout=2m ./...
 
+
+$(GENERATED): go.mod $(CRD_TYPE_SOURCE)
+	./hack/update-codegen.sh
+
+$(GENERATED_CRDS): $(GENERATED) $(CRD_SOURCES)
+	go run sigs.k8s.io/controller-tools/cmd/controller-gen crd:crdVersions=v1 paths=./pkg/apis/... output:crd:dir=docs || /bin/true || true
+	mv docs/zalando.org_clusterscalingschedules.yaml docs/cluster_scaling_schedules_crd.yaml
+	mv docs/zalando.org_scalingschedules.yaml docs/scaling_schedules_crd.yaml
+
+$(OPENAPI): go.mod
+	go run k8s.io/kube-openapi/cmd/openapi-gen \
+		--go-header-file hack/boilerplate.go.txt \
+		--logtostderr \
+		-i k8s.io/metrics/pkg/apis/custom_metrics,k8s.io/metrics/pkg/apis/custom_metrics/v1beta1,k8s.io/metrics/pkg/apis/custom_metrics/v1beta2,k8s.io/metrics/pkg/apis/external_metrics,k8s.io/metrics/pkg/apis/external_metrics/v1beta1,k8s.io/metrics/pkg/apis/metrics,k8s.io/metrics/pkg/apis/metrics/v1beta1,k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/apimachinery/pkg/api/resource,k8s.io/apimachinery/pkg/version,k8s.io/api/core/v1 \
+		-p pkg/api/generated/openapi \
+		-o . \
+		-O zz_generated.openapi \
+		-r /dev/null
+
 build.local: build/$(BINARY)
 build.linux: build/linux/$(BINARY)
 build.osx: build/osx/$(BINARY)
 
-build/$(BINARY): go.mod $(SOURCES)
+build/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
 	CGO_ENABLED=0 go build -o build/$(BINARY) $(BUILD_FLAGS) -ldflags "$(LDFLAGS)" .
 
-build/linux/$(BINARY): go.mod $(SOURCES)
+build/linux/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
 	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/linux/$(BINARY) -ldflags "$(LDFLAGS)" .
 
-build/osx/$(BINARY): go.mod $(SOURCES)
+build/osx/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
 	GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/osx/$(BINARY) -ldflags "$(LDFLAGS)" .
 
 build.docker: build.linux

README.md

@@ -10,7 +10,7 @@ It supports scaling based on [Prometheus metrics](https://prometheus.io/), [SQS
 
 It discovers Horizontal Pod Autoscaling resources and starts to collect the
 requested metrics and stores them in memory. It's implemented using the
-[custom-metrics-apiserver](https://github.com/kubernetes-incubator/custom-metrics-apiserver)
+[custom-metrics-apiserver](https://github.com/kubernetes-sigs/custom-metrics-apiserver)
 library.
 
 Here's an example of a `HorizontalPodAutoscaler` resource configured to get
@@ -22,7 +22,7 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: myapp-hpa
   annotations:
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
     metric-config.pods.requests-per-second.json-path/json-key: "$.http_server.rps"
     metric-config.pods.requests-per-second.json-path/path: /metrics
     metric-config.pods.requests-per-second.json-path/port: "9090"
@@ -104,7 +104,7 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: myapp-hpa
   annotations:
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
     metric-config.pods.requests-per-second.json-path/json-key: "$.http_server.rps"
     metric-config.pods.requests-per-second.json-path/path: /metrics
     metric-config.pods.requests-per-second.json-path/port: "9090"
@@ -142,7 +142,7 @@ example the following JSON data would be expected:
 ```
 
 The json-path query support depends on the
-[github.com/oliveagle/jsonpath](https://github.com/oliveagle/jsonpath) library.
+[github.com/spyzhov/ajson](https://github.com/spyzhov/ajson) library.
 See the README for possible queries. It's expected that the metric you query
 returns something that can be turned into a `float64`.
 
@@ -166,6 +166,14 @@ will create a URL like this:
 http://<podIP>:9090/metrics?foo=bar&baz=bop
 ```
 
+There are also configuration options for custom (connect and request) timeouts when querying pods for metrics:
+```yaml
+metric-config.pods.requests-per-second.json-path/request-timeout: 2s
+metric-config.pods.requests-per-second.json-path/connect-timeout: 500ms
+```
+
+The default for both of the above values is 15 seconds.
+
 ## Prometheus collector
 
 The Prometheus collector is a generic collector which can map Prometheus
@@ -194,15 +202,24 @@ the trade-offs between the two approaches.
 | `prometheus-query` | Generic metric which requires a user defined query. | External | | `>=1.12` |
 | *custom* | No predefined metrics. Metrics are generated from user defined queries. | Object | *any* | `>=1.12` |
 
+### Configure Scrape Interval
+
+There is a way to set the interval via an annotation like:
+
+```yaml
+metric-config.external.prometheus-query.prometheus/interval: 30s
+```
+
+Default is 1 minute.
+
 ### Example: External Metric
 
 This is an example of an HPA configured to get metrics based on a Prometheus
 query. The query is defined in the annotation
-`metric-config.external.prometheus-query.prometheus/processed-events-per-second`
+`metric-config.external.processed-events-per-second.prometheus/query`
 where `processed-events-per-second` is the query name which will be associated
-with the result of the query. A matching `query-name` label must be defined in
-the `matchLabels` of the metric definition. This allows having multiple
-prometheus queries associated with a single HPA.
+with the result of the query.
+This allows having multiple prometheus queries associated with a single HPA.
 
 ```yaml
 apiVersion: autoscaling/v2beta2
@@ -213,10 +230,9 @@ metadata:
     # This annotation is optional.
     # If specified, then this prometheus server is used,
     # instead of the prometheus server specified as the CLI argument `--prometheus-server`.
-    metric-config.external.prometheus-query.prometheus/prometheus-server: http://prometheus.my-namespace.svc
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
-    # <configKey> == query-name
-    metric-config.external.prometheus-query.prometheus/processed-events-per-second: |
+    metric-config.external.processed-events-per-second.prometheus/prometheus-server: http://prometheus.my-namespace.svc
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
+    metric-config.external.processed-events-per-second.prometheus/query: |
       scalar(sum(rate(event-service_events_count{application="event-service",processed="true"}[1m])))
 spec:
   scaleTargetRef:
@@ -229,10 +245,10 @@ spec:
   - type: External
     external:
       metric:
-        name: prometheus-query
+        name: processed-events-per-second
         selector:
           matchLabels:
-            query-name: processed-events-per-second
+            type: prometheus
       target:
         type: AverageValue
         averageValue: "10"
@@ -263,7 +279,7 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: myapp-hpa
   annotations:
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
     metric-config.object.processed-events-per-second.prometheus/query: |
       scalar(sum(rate(event-service_events_count{application="event-service",processed="true"}[1m])))
     metric-config.object.processed-events-per-second.prometheus/per-replica: "true"
@@ -364,10 +380,9 @@ we only support Flux instead of InfluxQL.
 
 This is an example of an HPA configured to get metrics based on a Flux query.
 The query is defined in the annotation
-`metric-config.external.flux-query.influxdb/queue_depth`
-where `queue_depth` is the query name which will be associated with the result of the query.
-A matching `query-name` label must be defined in the `matchLabels` of the metric definition.
-This allows having multiple flux queries associated with a single HPA.
+`metric-config.external.<metricName>.influxdb/query` where `<metricName>` is
+the query name which will be associated with the result of the query.  This
+allows having multiple flux queries associated with a single HPA.
 
 ```yaml
 apiVersion: autoscaling/v2beta2
@@ -381,13 +396,13 @@ metadata:
     #  - --influxdb-address
     #  - --influxdb-token
     #  - --influxdb-org
-    metric-config.external.flux-query.influxdb/address: "http://influxdbv2.my-namespace.svc"
-    metric-config.external.flux-query.influxdb/token: "secret-token"
+    metric-config.external.queue-depth.influxdb/address: "http://influxdbv2.my-namespace.svc"
+    metric-config.external.queue-depth.influxdb/token: "secret-token"
     # This could be either the organization name or the ID.
-    metric-config.external.flux-query.influxdb/org: "deadbeef"
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
+    metric-config.external.queue-depth.influxdb/org: "deadbeef"
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
     # <configKey> == query-name
-    metric-config.external.flux-query.influxdb/queue_depth: |
+    metric-config.external.queue-depth.influxdb/query: |
         from(bucket: "apps")
           |> range(start: -30s)
           |> filter(fn: (r) => r._measurement == "queue_depth")
@@ -407,10 +422,10 @@ spec:
   - type: External
     external:
       metric:
-        name: flux-query
+        name: queue-depth
         selector:
           matchLabels:
-            query-name: queue_depth
+            type: influxdb
       target:
         type: Value
         value: "1"
@@ -472,9 +487,10 @@ spec:
   - type: External
     external:
       metric:
-        name: sqs-queue-length
+        name: my-sqs
         selector:
           matchLabels:
+            type: sqs-queue-length
             queue-name: foobar
             region: eu-central-1
       target:
@@ -513,9 +529,9 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: myapp-hpa
   annotations:
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
-    metric-config.external.zmon-check.zmon/key: "custom.*"
-    metric-config.external.zmon-check.zmon/tag-application: "my-custom-app-*"
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
+    metric-config.external.my-zmon-check.zmon/key: "custom.*"
+    metric-config.external.my-zmon-check.zmon/tag-application: "my-custom-app-*"
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -527,9 +543,10 @@ spec:
   - type: External
     external:
       metric:
-          name: zmon-check
+          name: my-zmon-check
           selector:
             matchLabels:
+              type: zmon
               check-id: "1234" # the ZMON check to query for metrics
               key: "custom.value"
               tag-application: my-custom-app
@@ -579,9 +596,65 @@ specify a duration of `5m` then the query will return metric points for the
 last 5 minutes and apply the specified aggregation with the same duration .e.g
 `max(5m)`.
 
-The annotations `metric-config.external.zmon-check.zmon/key` and
-`metric-config.external.zmon-check.zmon/tag-<name>` can be optionally used if
+The annotations `metric-config.external.my-zmon-check.zmon/key` and
+`metric-config.external.my-zmon-check.zmon/tag-<name>` can be optionally used if
 you need to define a `key` or other `tag` with a "star" query syntax like
 `values.*`. This *hack* is in place because it's not allowed to use `*` in the
 metric label definitions. If both annotations and corresponding label is
 defined, then the annotation takes precedence.
+
+## HTTP Collector
+
+The http collector allows collecting metrics from an external endpoint specified in the HPA.
+Currently only `json-path` collection is supported.
+
+### Supported metrics
+
+| Metric | Description | Type | K8s Versions |
+| ------------ | -------------- | ------- | -- |
+| *custom* | No predefined metrics. Metrics are generated from user defined queries. | Pods | `>=1.12` |
+
+### Example
+
+This is an example of using the HTTP collector to collect metrics from a json
+metrics endpoint specified in the annotations.
+
+```yaml
+apiVersion: autoscaling/v2beta2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: myapp-hpa
+  annotations:
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
+    metric-config.external.unique-metric-name.json-path/json-key: "$.some-metric.value"
+    metric-config.external.unique-metric-name.json-path/endpoint: "http://metric-source.app-namespace:8080/metrics"
+    metric-config.external.unique-metric-name.json-path/aggregator: "max"
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: myapp
+  minReplicas: 1
+  maxReplicas: 10
+  metrics:
+  - type: External
+    external:
+      metric:
+        name: unique-metric-name
+        selector:
+          matchLabels:
+            type: json-path
+      target:
+        averageValue: 1
+        type: AverageValue
+```
+
+The HTTP collector similar to the Pod Metrics collector. The metric name should always be `http`.
+This value is also used in the annotations to configure the metrics adapter to query the required
+target. The following configuration values are supported:
+
+- `json-key` to specify the JSON path of the metric to be queried
+- `endpoint` the fully formed path to query for the metric. In the above example a Kubernetes _Service_
+    in the namespace `app-namespace` is called.
+- `aggregator` is only required if the metric is an array of values and specifies how the values
+    are aggregated. Currently this option can support the values: `sum`, `max`, `min`, `avg`.

docs/cluster_scaling_schedules_crd.yaml

@@ -0,0 +1,119 @@
+
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.5.0
+  creationTimestamp: null
+  name: clusterscalingschedules.zalando.org
+spec:
+  group: zalando.org
+  names:
+    kind: ClusterScalingSchedule
+    listKind: ClusterScalingScheduleList
+    plural: clusterscalingschedules
+    singular: clusterscalingschedule
+  scope: Cluster
+  versions:
+  - name: v1
+    schema:
+      openAPIV3Schema:
+        description: ClusterScalingSchedule describes a cluster scoped time based
+          metric to be used in autoscaling operations.
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: ScalingScheduleSpec is the spec part of the ScalingSchedule.
+            properties:
+              schedules:
+                description: Schedules is the list of schedules for this ScalingSchedule
+                  resource. All the schedules defined here will result on the value
+                  to the same metric. New metrics require a new ScalingSchedule resource.
+                items:
+                  description: Schedule is the schedule details to be used inside
+                    a ScalingSchedule.
+                  properties:
+                    date:
+                      description: Defines the starting date of a OneTime schedule.
+                        It has to be a RFC3339 formated date.
+                      format: date-time
+                      type: string
+                    durationMinutes:
+                      description: The duration in minutes that the configured value
+                        will be returned for the defined schedule.
+                      type: integer
+                    period:
+                      description: Defines the details of a Repeating schedule.
+                      properties:
+                        days:
+                          description: The days that this schedule will be active.
+                          items:
+                            description: ScheduleDay represents the valid inputs for
+                              days in a SchedulePeriod.
+                            enum:
+                            - Sun
+                            - Mon
+                            - Tue
+                            - Wed
+                            - Thu
+                            - Fri
+                            - Sat
+                            type: string
+                          type: array
+                        startTime:
+                          description: The startTime has the format HH:MM
+                          pattern: (([0-1][0-9])|([2][0-3])):([0-5][0-9])
+                          type: string
+                        timezone:
+                          description: The location name corresponding to a file in
+                            the IANA Time Zone database, like Europe/Berlin.
+                          type: string
+                      required:
+                      - days
+                      - startTime
+                      - timezone
+                      type: object
+                    type:
+                      description: Defines if the schedule is a OneTime schedule or
+                        Repeating one. If OneTime, date has to be defined. If Repeating,
+                        Period has to be defined.
+                      enum:
+                      - OneTime
+                      - Repeating
+                      type: string
+                    value:
+                      description: The metric value that will be returned for the
+                        defined schedule.
+                      type: integer
+                  required:
+                  - durationMinutes
+                  - type
+                  - value
+                  type: object
+                type: array
+            required:
+            - schedules
+            type: object
+        required:
+        - spec
+        type: object
+    served: true
+    storage: true
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []

docs/helm/Chart.yaml

@@ -0,0 +1,9 @@
+apiVersion: v2
+name: kube-metrics-adapter
+version: 0.1.9
+description: kube-metrics-adapter helm chart
+home: https://github.com/zalando-incubator/kube-metrics-adapter
+maintainers:
+  - name: The Zalando Incubator
+    email: opensource@zalando.de
+    url: https://github.com/zalando-incubator

docs/helm/templates/custom-metrics-apiservice.yaml

@@ -0,0 +1,15 @@
+{{- if .Values.enableCustomMetricsApi }}
+apiVersion: apiregistration.k8s.io/v1beta1
+kind: APIService
+metadata:
+  name: v1beta1.custom.metrics.k8s.io
+spec:
+  service:
+    name: kube-metrics-adapter
+    namespace: {{ .Values.namespace }}
+  group: custom.metrics.k8s.io
+  version: v1beta1
+  insecureSkipTLSVerify: {{ .Values.tls.skipTLSVerify }}
+  groupPriorityMinimum: 100
+  versionPriority: 100
+{{- end}}

docs/helm/templates/deployment.yaml

@@ -0,0 +1,191 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}
+  labels:
+    application: kube-metrics-adapter
+    version: {{ .Values.registry.imageTag }}
+spec:
+  replicas: {{ .Values.replicas }}
+  selector:
+    matchLabels:
+      application: kube-metrics-adapter
+  template:
+    metadata:
+      labels:
+        application: kube-metrics-adapter
+        version: {{ .Values.registry.imageTag }}
+    spec:
+      serviceAccountName: kube-metrics-adapter
+      containers:
+        - name: kube-metrics-adapter
+          image: {{ .Values.registry.image}}:{{ .Values.registry.imageTag }}
+          args:
+            {{- if .Values.addDirectoryHeader }}
+            - --add_dir_header={{ .Values.addDirectoryHeader }}
+            {{- end}}
+            {{- if .Values.log.alsoToStderr }}
+            - --alsologtostderr={{ .Values.log.alsoToStderr }}
+            {{- end}}
+            {{- if .Values.authentication.kubeConfig }}
+            - --authentication-kubeconfig={{ .Values.authentication.kubeConfig }}
+            {{- end}}
+            {{- if .Values.authentication.skipLookup }}
+            - --authentication-skip-lookup={{ .Values.authentication.skipLookup }}
+            {{- end}}
+            {{- if .Values.authentication.tokenWebhookCacheTtl }}
+            - --authentication-token-webhook-cache-ttl={{ .Values.authentication.tokenWebhookCacheTtl }}
+            {{- end}}
+            {{- if .Values.authentication.tolerateLookupFailure }}
+            - --authentication-tolerate-lookup-failure={{ .Values.authentication.tolerateLookupFailure }}
+            {{- end}}
+            {{- if .Values.authorization.alwaysAllowPaths }}
+            - --authorization-always-allow-paths={{ .Values.authorization.alwaysAllowPaths }}
+            {{- end}}
+            {{- if .Values.authorization.kubeConfig }}
+            - --authorization-kubeconfig={{ .Values.authorization.kubeConfig }}
+            {{- end}}
+            {{- if .Values.authorization.webhookCache.authorizedTtl }}
+            - --authorization-webhook-cache-authorized-ttl={{ .Values.authorization.webhookCache.authorizedTtl }}
+            {{- end}}
+            {{- if .Values.authorization.webhookCache.unauthorizedTtl }}
+            - --authorization-webhook-cache-unauthorized-ttl={{ .Values.authorization.webhookCache.unauthorizedTtl }}
+            {{- end}}
+            {{- if .Values.aws.externalMetrics }}
+            - --aws-external-metrics={{ .Values.aws.externalMetrics }}
+            {{- end}}
+            {{- if .Values.aws.region }}
+            - --aws-region={{ .Values.aws.region }}
+            {{- end}}
+            {{- if .Values.tls.certificateDirectory }}
+            - --cert-dir={{ .Values.tls.certificateDirectory }}
+            {{- end}}
+            {{- if .Values.tls.clientCaFile }}
+            - --client-ca-file={{ .Values.tls.clientCaFile }}
+            {{- end}}
+            {{- if .Values.contentionProfiling }}
+            - --contention-profiling={{ .Values.contentionProfiling }}
+            {{- end}}
+            {{- if .Values.credentialsDirectory }}
+            - --credentials-dir={{ .Values.credentialsDirectory }}
+            {{- end}}
+            {{- if .Values.disregardIncompatibleHPAs }}
+            - --disregard-incompatible-hpas={{ .Values.disregardIncompatibleHPAs }}
+            {{- end}}
+            {{- if .Values.enableCustomMetricsApi }}
+            - --enable-custom-metrics-api={{ .Values.enableCustomMetricsApi }}
+            {{- end}}
+            {{- if .Values.enableExternalMetricsApi }}
+            - --enable-external-metrics-api={{ .Values.enableExternalMetricsApi }}
+            {{- end}}
+            {{- if .Values.http2MaxStreamsPerConnection }}
+            - --http2-max-streams-per-connection={{ .Values.http2MaxStreamsPerConnection }}
+            {{- end}}
+            {{- if .Values.influxDB.address }}
+            - --influxdb-address={{ .Values.influxDB.address }}
+            {{- end}}
+            {{- if .Values.influxDB.organization }}
+            - --influxdb-org={{ .Values.influxDB.organization }}
+            {{- end}}
+            {{- if .Values.influxDB.token }}
+            - --influxdb-token={{ .Values.influxDB.token }}
+            {{- end}}
+            {{- if .Values.listerKubeConfig }}
+            - --lister-kubeconfig={{ .Values.listerKubeConfig }}
+            {{- end}}
+            {{- if .Values.log.flushFrequency }}
+            - --log-flush-frequency={{ .Values.log.flushFrequency }}
+            {{- end}}
+            {{- if .Values.log.backtraceAtTraceLocation }}
+            - --log_backtrace_at={{ .Values.log.backtraceAtTraceLocation }}
+            {{- end}}
+            {{- if .Values.log.directory }}
+            - --log_dir={{ .Values.log.directory }}
+            {{- end}}
+            {{- if .Values.log.file }}
+            - --log_file={{ .Values.log.file }}
+            {{- end}}
+            {{- if .Values.log.fileMaxSize }}
+            - --log_file_max_size={{ .Values.log.fileMaxSize }}
+            {{- end}}
+            {{- if .Values.log.toStderr }}
+            - --logtostderr={{ .Values.log.toStderr }}
+            {{- end}}
+            {{- if .Values.prometheus.metricsAddress }}
+            - --metrics-address={{ .Values.prometheus.metricsAddress }}
+            {{- end}}
+            {{- if .Values.profiling }}
+            - --profiling={{ .Values.profiling }}
+            {{- end}}
+            {{- if .Values.prometheus.server }}
+            - --prometheus-server={{ .Values.prometheus.server }}
+            {{- end}}
+            {{- if .Values.requestHeader.allowedNames }}
+            - --requestheader-allowed-names={{ .Values.requestHeader.allowedNames }}
+            {{- end}}
+            {{- if .Values.requestHeader.clientCaFile }}
+            - --requestheader-client-ca-file={{ .Values.requestHeader.clientCaFile }}
+            {{- end}}
+            {{- if .Values.requestHeader.extraHeadersPrefix }}
+            - --requestheader-extra-headers-prefix={{ .Values.requestHeader.extraHeadersPrefix }}
+            {{- end}}
+            {{- if .Values.requestHeader.groupHeaders }}
+            - --requestheader-group-headers={{ .Values.requestHeader.groupHeaders }}
+            {{- end}}
+            {{- if .Values.requestHeader.usernameHeaders }}
+            - --requestheader-username-headers={{ .Values.requestHeader.usernameHeaders }}
+            {{- end}}
+            - --secure-port={{ .Values.service.internalPort }}
+            {{- if .Values.log.skipHeaders }}
+            - --skip_headers={{ .Values.log.skipHeaders }}
+            {{- end}}
+            {{- if .Values.log.skipLogHeaders }}
+            - --skip_log_headers={{ .Values.log.skipLogHeaders }}
+            {{- end}}
+            {{- if .Values.skipperBackendsAnnotation }}
+            - --skipper-backends-annotation={{ .Values.skipperBackendsAnnotation }}
+            {{- end}}
+            {{- if .Values.skipperIngressMetrics }}
+            - --skipper-ingress-metrics={{ .Values.skipperIngressMetrics }}
+            {{- end}}
+            {{- if .Values.log.stderrThreshold }}
+            - --stderrthreshold={{ .Values.log.stderrThreshold }}
+            {{- end}}
+            {{- if .Values.tls.certFile }}
+            - --tls-cert-file={{ .Values.tls.certFile }}
+            {{- end}}
+            {{- if .Values.tls.cipherSuites }}
+            - --tls-cipher-suites={{ .Values.tls.cipherSuites }}
+            {{- end}}
+            {{- if .Values.tls.minVersion }}
+            - --tls-min-version={{ .Values.tls.minVersion }}
+            {{- end}}
+            {{- if .Values.tls.privateKeyFile }}
+            - --tls-private-key-file={{ .Values.tls.privateKeyFile }}
+            {{- end}}
+            {{- if .Values.tls.sniCertKey }}
+            - --tls-sni-cert-key={{ .Values.tls.sniCertKey }}
+            {{- end}}
+            {{- if .Values.token }}
+            - --token={{ .Values.token }}
+            {{- end}}
+            {{- if .Values.log.level }}
+            - --v={{ .Values.log.level }}
+            {{- end}}
+            {{- if .Values.vmodule }}
+            - --vmodule={{ .Values.vmodule }}
+            {{- end}}
+            {{- if .Values.zmon.kariosdbEndpoint }}
+            - --zmon-kariosdb-endpoint={{ .Values.zmon.kariosdbEndpoint }}
+            {{- end}}
+            {{- if .Values.zmon.tokenName }}
+            - --zmon-token-name={{ .Values.zmon.tokenName }}
+            {{- end}}
+          resources:
+            limits:
+              cpu: {{ .Values.resources.limits.cpu }}
+              memory: {{ .Values.resources.limits.memory }}
+            requests:
+              cpu: {{ .Values.resources.requests.cpu }}
+              memory: {{ .Values.resources.requests.memory }}

docs/helm/templates/external-metrics-apiservice.yaml

@@ -0,0 +1,15 @@
+{{- if .Values.enableExternalMetricsApi }}
+apiVersion: apiregistration.k8s.io/v1beta1
+kind: APIService
+metadata:
+  name: v1beta1.external.metrics.k8s.io
+spec:
+  service:
+    name: kube-metrics-adapter
+    namespace: {{ .Values.namespace }}
+  group: external.metrics.k8s.io
+  version: v1beta1
+  insecureSkipTLSVerify: {{ .Values.tls.skipTLSVerify }}
+  groupPriorityMinimum: 100
+  versionPriority: 100
+{{- end}}

docs/helm/templates/rbac.yaml

@@ -0,0 +1,154 @@
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: kube-metrics-adapter-server-resources
+rules:
+- apiGroups:
+  - custom.metrics.k8s.io
+  resources: ["*"]
+  verbs: ["*"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: external-metrics-server-resources
+rules:
+- apiGroups:
+  - external.metrics.k8s.io
+  resources: ["*"]
+  verbs: ["*"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: kube-metrics-adapter-resource-reader
+rules:
+- apiGroups:
+  - ""
+  resources:
+  - namespaces
+  - pods
+  - services
+  - configmaps
+  verbs:
+  - get
+  - list
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: kube-metrics-adapter-resource-collector
+rules:
+- apiGroups:
+  - ""
+  resources:
+  - events
+  verbs:
+  - create
+  - patch
+- apiGroups:
+  - ""
+  resources:
+  - pods
+  verbs:
+  - list
+- apiGroups:
+  - apps
+  resources:
+  - deployments
+  - statefulsets
+  verbs:
+  - get
+- apiGroups:
+  - extensions
+  resources:
+  - ingresses
+  verbs:
+  - get
+- apiGroups:
+  - autoscaling
+  resources:
+  - horizontalpodautoscalers
+  verbs:
+  - get
+  - list
+  - watch
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: hpa-controller-custom-metrics
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: kube-metrics-adapter-server-resources
+subjects:
+- kind: ServiceAccount
+  name: horizontal-pod-autoscaler
+  namespace: kube-system
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: hpa-controller-external-metrics
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: external-metrics-server-resources
+subjects:
+- kind: ServiceAccount
+  name: horizontal-pod-autoscaler
+  namespace: kube-system
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: RoleBinding
+metadata:
+  name: kube-metrics-adapter-auth-reader
+  namespace: kube-system
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: Role
+  name: extension-apiserver-authentication-reader
+subjects:
+- kind: ServiceAccount
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: custom-metrics:system:auth-delegator
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: system:auth-delegator
+subjects:
+- kind: ServiceAccount
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: kube-metrics-adapter-resource-collector
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: kube-metrics-adapter-resource-collector
+subjects:
+- kind: ServiceAccount
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: kube-metrics-adapter-resource-reader
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: kube-metrics-adapter-resource-reader
+subjects:
+- kind: ServiceAccount
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}

docs/helm/templates/service-account.yaml

@@ -0,0 +1,5 @@
+kind: ServiceAccount
+apiVersion: v1
+metadata:
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}

docs/helm/templates/service.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: kube-metrics-adapter
+  namespace: {{ .Values.namespace }}
+spec:
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: {{ .Values.service.internalPort }}
+  selector:
+    application: kube-metrics-adapter

docs/helm/values.yaml

@@ -0,0 +1,94 @@
+namespace: kube-system
+
+replicas: 1
+
+registry:
+  image: registry.opensource.zalan.do/teapot/kube-metrics-adapter
+  imageTag: v0.1.9
+  imagePullPolicy: IfNotPresent
+
+service:
+  port: 443
+  internalPort: 443
+
+addDirectoryHeader:
+contentionProfiling:
+profiling:
+enableCustomMetricsApi:
+enableExternalMetricsApi:
+credentialsDirectory:
+disregardIncompatibleHPAs:
+http2MaxStreamsPerConnection:
+listerKubeConfig:
+skipperBackendsAnnotation:
+skipperIngressMetrics:
+token:
+vmodule:
+
+authentication:
+  kubeConfig:
+  skipLookup:
+  tokenWebhookCacheTtl:
+  tolerateLookupFailure:
+
+authorization:
+  kubeConfig:
+  alwaysAllowPaths:
+  webhookCache:
+    authorizedTtl:
+    unauthorizedTtl:
+
+aws:
+  externalMetrics:
+  region:
+
+influxDB:
+  address:
+  organization:
+  token:
+
+log:
+  alsoToStderr:
+  toStderr:
+  flushFrequency:
+  backtraceAtTraceLocation:
+  directory:
+  file:
+  fileMaxSize:
+  level:
+  stderrThreshold:
+  skipHeaders:
+  skipLogHeaders:
+
+prometheus:
+  server: http://prometheus.kube-system.svc.cluster.local
+  metricsAddress:
+
+requestHeader:
+  allowedNames:
+  clientCaFile:
+  extraHeadersPrefix:
+  groupHeaders:
+  usernameHeaders:
+
+tls:
+  skipTLSVerify: true
+  certificateDirectory:
+  clientCaFile:
+  certFile:
+  cipherSuites:
+  minVersion:
+  privateKeyFile:
+  sniCertKey:
+
+zmon:
+  kariosdbEndpoint:
+  tokenName:
+
+resources:
+  limits:
+    cpu: 100m
+    memory: 100Mi
+  requests:
+    cpu: 100m
+    memory: 100Mi

docs/scaling_schedules_crd.yaml

@@ -0,0 +1,119 @@
+
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.5.0
+  creationTimestamp: null
+  name: scalingschedules.zalando.org
+spec:
+  group: zalando.org
+  names:
+    kind: ScalingSchedule
+    listKind: ScalingScheduleList
+    plural: scalingschedules
+    singular: scalingschedule
+  scope: Namespaced
+  versions:
+  - name: v1
+    schema:
+      openAPIV3Schema:
+        description: ScalingSchedule describes a namespaced time based metric to be
+          used in autoscaling operations.
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: ScalingScheduleSpec is the spec part of the ScalingSchedule.
+            properties:
+              schedules:
+                description: Schedules is the list of schedules for this ScalingSchedule
+                  resource. All the schedules defined here will result on the value
+                  to the same metric. New metrics require a new ScalingSchedule resource.
+                items:
+                  description: Schedule is the schedule details to be used inside
+                    a ScalingSchedule.
+                  properties:
+                    date:
+                      description: Defines the starting date of a OneTime schedule.
+                        It has to be a RFC3339 formated date.
+                      format: date-time
+                      type: string
+                    durationMinutes:
+                      description: The duration in minutes that the configured value
+                        will be returned for the defined schedule.
+                      type: integer
+                    period:
+                      description: Defines the details of a Repeating schedule.
+                      properties:
+                        days:
+                          description: The days that this schedule will be active.
+                          items:
+                            description: ScheduleDay represents the valid inputs for
+                              days in a SchedulePeriod.
+                            enum:
+                            - Sun
+                            - Mon
+                            - Tue
+                            - Wed
+                            - Thu
+                            - Fri
+                            - Sat
+                            type: string
+                          type: array
+                        startTime:
+                          description: The startTime has the format HH:MM
+                          pattern: (([0-1][0-9])|([2][0-3])):([0-5][0-9])
+                          type: string
+                        timezone:
+                          description: The location name corresponding to a file in
+                            the IANA Time Zone database, like Europe/Berlin.
+                          type: string
+                      required:
+                      - days
+                      - startTime
+                      - timezone
+                      type: object
+                    type:
+                      description: Defines if the schedule is a OneTime schedule or
+                        Repeating one. If OneTime, date has to be defined. If Repeating,
+                        Period has to be defined.
+                      enum:
+                      - OneTime
+                      - Repeating
+                      type: string
+                    value:
+                      description: The metric value that will be returned for the
+                        defined schedule.
+                      type: integer
+                  required:
+                  - durationMinutes
+                  - type
+                  - value
+                  type: object
+                type: array
+            required:
+            - schedules
+            type: object
+        required:
+        - spec
+        type: object
+    served: true
+    storage: true
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []

example/deploy/hpa.yaml

@@ -6,7 +6,7 @@ metadata:
   labels:
     application: custom-metrics-consumer
   annotations:
-    # metric-config.<metricType>.<metricName>.<collectorName>/<configKey>
+    # metric-config.<metricType>.<metricName>.<collectorType>/<configKey>
     metric-config.pods.queue-length.json-path/json-key: "$.queue.length"
     metric-config.pods.queue-length.json-path/path: /metrics
     metric-config.pods.queue-length.json-path/port: "9090"
@@ -50,9 +50,10 @@ spec:
   - type: External
     external:
       metric:
-        name: sqs-queue-length
+        name: app-queue-length
         selector:
           matchLabels:
+            type: sqs-queue-length
             queue-name: foobar
             region: eu-central-1
       target:

go.mod

@@ -2,32 +2,35 @@ module github.com/zalando-incubator/kube-metrics-adapter
 
 require (
 	github.com/NYTimes/gziphandler v1.0.1 // indirect
-	github.com/aws/aws-sdk-go v1.29.4
-	github.com/coreos/go-systemd v0.0.0-20180705093442-88bfeed483d3 // indirect
-	github.com/golang/groupcache v0.0.0-20180513044358-24b0969c4cb7 // indirect
-	github.com/googleapis/gnostic v0.2.0 // indirect
-	github.com/grpc-ecosystem/grpc-gateway v1.4.1 // indirect
-	github.com/influxdata/influxdb-client-go v0.1.4
-	github.com/kubernetes-incubator/custom-metrics-apiserver v0.0.0-20190918110929-3d9be26a50eb
-	github.com/oliveagle/jsonpath v0.0.0-20180606110733-2e52cf6e6852
-	github.com/prometheus/client_golang v0.9.2
-	github.com/prometheus/common v0.0.0-20181126121408-4724e9255275
-	github.com/sirupsen/logrus v1.4.2
-	github.com/soheilhy/cmux v0.1.4 // indirect
-	github.com/spf13/cobra v0.0.3
-	github.com/stretchr/testify v1.4.0
-	github.com/tmc/grpc-websocket-proxy v0.0.0-20171017195756-830351dc03c6 // indirect
+	github.com/aws/aws-sdk-go v1.37.20
+	github.com/go-openapi/spec v0.20.3
+	github.com/influxdata/influxdb-client-go v0.2.0
+	github.com/influxdata/line-protocol v0.0.0-20201012155213-5f565037cbc9 // indirect
+	github.com/kubernetes-sigs/custom-metrics-apiserver v0.0.0-20201216091021-1b9fa998bbaa
+	github.com/magefile/mage v1.11.0 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/prometheus/client_golang v1.9.0
+	github.com/prometheus/common v0.18.0
+	github.com/sirupsen/logrus v1.8.0
+	github.com/spf13/cobra v1.1.1
+	github.com/spyzhov/ajson v0.4.2
+	github.com/stretchr/testify v1.7.0
 	github.com/zalando-incubator/cluster-lifecycle-manager v0.0.0-20180921141935-824b77fb1f84
-	golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
-	gopkg.in/inf.v0 v0.9.1 // indirect
-	k8s.io/api v0.0.0-20190918155943-95b840bb6a1f
-	k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655
-	k8s.io/apiserver v0.0.0-20190918160949-bfa5e2e684ad // indirect
-	k8s.io/client-go v0.0.0-20190918160344-1fbdaa4c8d90
-	k8s.io/code-generator v0.17.4
-	k8s.io/component-base v0.0.0-20190918160511-547f6c5d7090
+	golang.org/x/crypto v0.0.0-20201124201722-c8d3bf9c5392 // indirect
+	golang.org/x/net v0.0.0-20210226172049-e18ecbb05110 // indirect
+	golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d
+	golang.org/x/sys v0.0.0-20210301091718-77cc2087c03b // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	k8s.io/api v0.20.4
+	k8s.io/apimachinery v0.20.4
+	k8s.io/apiserver v0.20.4
+	k8s.io/client-go v0.20.4
+	k8s.io/code-generator v0.20.4
+	k8s.io/component-base v0.20.4
 	k8s.io/klog v1.0.0
-	k8s.io/metrics v0.0.0-20190226180357-f3f09b9076d1
+	k8s.io/kube-openapi v0.0.0-20201113171705-d219536bb9fd
+	k8s.io/metrics v0.20.4
+	sigs.k8s.io/controller-tools v0.5.0
 )
 
-go 1.13
+go 1.16

hack/boilerplate.go.txt

@@ -1,5 +1,5 @@
 /*
-Copyright YEAR The Kubernetes Authors.
+Copyright The Kubernetes Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -13,3 +13,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+

hack/tools.go

@@ -1,5 +1,23 @@
-package main
+// +build tools
+
+/*
+Copyright 2019 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// This package imports things required by build scripts, to force `go mod` to see them as dependencies
+package tools
 
 import (
 	_ "k8s.io/code-generator"
+	_ "k8s.io/kube-openapi/cmd/openapi-gen"
+	_ "sigs.k8s.io/controller-tools/cmd/controller-gen"
 )

hack/update-codegen.sh

@@ -17,30 +17,56 @@
 set -o errexit
 set -o nounset
 set -o pipefail
-set -x
+
 SRC="github.com"
-GOPKG="$SRC/zalando-incubator/kube-metrics-adapter"
+GOPKG="${SRC}/zalando-incubator/kube-metrics-adapter"
 CUSTOM_RESOURCE_NAME="zalando.org"
 CUSTOM_RESOURCE_VERSION="v1"
 
-SCRIPT_ROOT="$(dirname ${BASH_SOURCE[0]})/.."
-CODEGEN_PKG=${CODEGEN_PKG:-$(cd "${SCRIPT_ROOT}"; ls -d -1 ./vendor/k8s.io/code-generator 2>/dev/null || echo ../code-generator)}
-OUTPUT_BASE="$(dirname ${BASH_SOURCE})/"
-
-go mod vendor
+SCRIPT_ROOT="$(dirname "${BASH_SOURCE[0]}")/.."
+OUTPUT_BASE="$(dirname "${BASH_SOURCE[0]}")/"
 
 # generate the code with:
 # --output-base    because this script should also be able to run inside the vendor dir of
 #                  k8s.io/kubernetes. The output-base is needed for the generators to output into the vendor dir
 #                  instead of the $GOPATH directly. For normal projects this can be dropped.
-bash "${CODEGEN_PKG}"/generate-groups.sh all \
-  "${GOPKG}/pkg/client" "${GOPKG}/pkg/apis" \
-  "${CUSTOM_RESOURCE_NAME}:${CUSTOM_RESOURCE_VERSION}" \
-  --go-header-file hack/boilerplate.go.txt \
+
+OUTPUT_PKG="${GOPKG}/pkg/client"
+APIS_PKG="${GOPKG}/pkg/apis"
+GROUPS_WITH_VERSIONS="${CUSTOM_RESOURCE_NAME}:${CUSTOM_RESOURCE_VERSION}"
+
+echo "Generating deepcopy funcs"
+go run k8s.io/code-generator/cmd/deepcopy-gen \
+  --input-dirs "${APIS_PKG}/${CUSTOM_RESOURCE_NAME}/${CUSTOM_RESOURCE_VERSION}" \
+  -O zz_generated.deepcopy \
+  --bounding-dirs "${APIS_PKG}" \
+  --go-header-file "${SCRIPT_ROOT}/hack/boilerplate.go.txt" \
   --output-base "$OUTPUT_BASE"
 
-# To use your own boilerplate text append:
-#   --go-header-file ${SCRIPT_ROOT}/hack/custom-boilerplate.go.txt
+echo "Generating clientset for ${GROUPS_WITH_VERSIONS} at ${OUTPUT_PKG}/${CLIENTSET_PKG_NAME:-clientset}"
+go run k8s.io/code-generator/cmd/client-gen \
+  --clientset-name versioned \
+  --input-base "" \
+  --input "${APIS_PKG}/${CUSTOM_RESOURCE_NAME}/${CUSTOM_RESOURCE_VERSION}" \
+  --output-package "${OUTPUT_PKG}/clientset" \
+  --go-header-file "${SCRIPT_ROOT}/hack/boilerplate.go.txt" \
+  --output-base "$OUTPUT_BASE"
+
+echo "Generating listers for ${GROUPS_WITH_VERSIONS} at ${OUTPUT_PKG}/listers"
+go run k8s.io/code-generator/cmd/lister-gen \
+  --input-dirs "${APIS_PKG}/${CUSTOM_RESOURCE_NAME}/${CUSTOM_RESOURCE_VERSION}" \
+  --output-package "${OUTPUT_PKG}/listers" \
+  --go-header-file "${SCRIPT_ROOT}/hack/boilerplate.go.txt" \
+  --output-base "$OUTPUT_BASE"
+
+echo "Generating informers for ${GROUPS_WITH_VERSIONS} at ${OUTPUT_PKG}/informers"
+go run k8s.io/code-generator/cmd/informer-gen \
+  --input-dirs "${APIS_PKG}/${CUSTOM_RESOURCE_NAME}/${CUSTOM_RESOURCE_VERSION}" \
+  --versioned-clientset-package "${OUTPUT_PKG}/${CLIENTSET_PKG_NAME:-clientset}/${CLIENTSET_NAME_VERSIONED:-versioned}" \
+  --listers-package "${OUTPUT_PKG}/listers" \
+  --output-package "${OUTPUT_PKG}/informers" \
+  --go-header-file "${SCRIPT_ROOT}/hack/boilerplate.go.txt" \
+  --output-base "$OUTPUT_BASE"
 
 # hack to make the generated code work with Go module based projects
 cp -r "$OUTPUT_BASE/$GOPKG/pkg/apis" ./pkg

pkg/annotations/parser.go

@@ -15,7 +15,7 @@ const (
 )
 
 type AnnotationConfigs struct {
-	CollectorName string
+	CollectorType string
 	Configs       map[string]string
 	PerReplica    bool
 	Interval      time.Duration
@@ -64,14 +64,14 @@ func (m AnnotationConfigMap) Parse(annotations map[string]string) error {
 		config, ok := m[key]
 		if !ok {
 			config = &AnnotationConfigs{
-				CollectorName: metricCollector,
+				CollectorType: metricCollector,
 				Configs:       map[string]string{},
 			}
 			m[key] = config
 		}
 
 		// TODO: fail if collector name doesn't match
-		if config.CollectorName != metricCollector {
+		if config.CollectorType != metricCollector {
 			continue
 		}
 

pkg/annotations/parser_test.go

@@ -86,6 +86,21 @@ func TestParser(t *testing.T) {
 				"org-id":  "deadbeef",
 			},
 		},
+		{
+			Name: "http metrics",
+			Annotations: map[string]string{
+				"metric-config.external.http.json/json-key":   "$.metric.value",
+				"metric-config.external.http.json/endpoint":   "http://metric-source.source-namespace.svc.cluster.local:8000/metrics",
+				"metric-config.external.http.json/aggregator": "avg",
+			},
+			MetricName: "http",
+			MetricType: autoscalingv2.ExternalMetricSourceType,
+			ExpectedConfig: map[string]string{
+				"json-key":   "$.metric.value",
+				"endpoint":   "http://metric-source.source-namespace.svc.cluster.local:8000/metrics",
+				"aggregator": "avg",
+			},
+		},
 	} {
 		t.Run(tc.Name, func(t *testing.T) {
 			hpaMap := make(AnnotationConfigMap)

pkg/apis/zalando.org/v1/register.go

@@ -0,0 +1,38 @@
+// Package v1 contains API Schema definitions for the zalando v1 API group
+// +kubebuilder:object:generate=true
+// +groupName=zalando.org
+package v1
+
+import (
+	"github.com/zalando-incubator/kube-metrics-adapter/pkg/apis/zalando.org"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+var (
+	schemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+	// AddToScheme applies all the stored functions to the scheme. A non-nil error
+	// indicates that one function failed and the attempt was abandoned.
+	AddToScheme = schemeBuilder.AddToScheme
+)
+
+// SchemeGroupVersion is the group version used to register these objects.
+var SchemeGroupVersion = schema.GroupVersion{Group: zalando.GroupName, Version: "v1"}
+
+// Resource takes an unqualified resource and returns a Group-qualified GroupResource.
+func Resource(resource string) schema.GroupResource {
+	return SchemeGroupVersion.WithResource(resource).GroupResource()
+}
+
+// addKnownTypes adds the set of types defined in this package to the supplied scheme.
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(SchemeGroupVersion,
+		&ScalingSchedule{},
+		&ClusterScalingSchedule{},
+		&ScalingScheduleList{},
+		&ClusterScalingScheduleList{},
+	)
+	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
+	return nil
+}

pkg/apis/zalando.org/v1/types.go

@@ -8,10 +8,123 @@ import (
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:object:root=true
 
-// ScheduledScaling describes an application resource.
+// ScalingSchedule describes a namespaced time based metric to be used
+// in autoscaling operations.
 // +k8s:deepcopy-gen=true
-type ScheduledScaling struct {
+type ScalingSchedule struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec ScalingScheduleSpec `json:"spec"`
 }
 
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:object:root=true
+
+// ClusterScalingSchedule describes a cluster scoped time based metric
+// to be used in autoscaling operations.
+// +k8s:deepcopy-gen=true
+// +kubebuilder:resource:scope=Cluster
+type ClusterScalingSchedule struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec ScalingScheduleSpec `json:"spec"`
+}
+
+// ScalingScheduleSpec is the spec part of the ScalingSchedule.
+// +k8s:deepcopy-gen=true
+type ScalingScheduleSpec struct {
+	// Schedules is the list of schedules for this ScalingSchedule
+	// resource. All the schedules defined here will result on the value
+	// to the same metric. New metrics require a new ScalingSchedule
+	// resource.
+	Schedules []Schedule `json:"schedules"`
+}
+
+// Schedule is the schedule details to be used inside a ScalingSchedule.
+// +k8s:deepcopy-gen=true
+type Schedule struct {
+	Type ScheduleType `json:"type"`
+	// Defines the details of a Repeating schedule.
+	// +optional
+	Period SchedulePeriod `json:"period"`
+	// Defines the starting date of a OneTime schedule. It has to
+	// be a RFC3339 formated date.
+	// +optional
+	Date ScheduleDate `json:"date"`
+	// The duration in minutes that the configured value will be
+	// returned for the defined schedule.
+	DurationMinutes int `json:"durationMinutes"`
+	// The metric value that will be returned for the defined schedule.
+	Value int `json:"value"`
+}
+
+// Defines if the schedule is a OneTime schedule or
+// Repeating one. If OneTime, date has to be defined. If Repeating,
+// Period has to be defined.
+// +kubebuilder:validation:Enum=OneTime;Repeating
+type ScheduleType string
+
+const (
+	OneTimeSchedule   ScheduleType = "OneTime"
+	RepeatingSchedule ScheduleType = "Repeating"
+)
+
+// SchedulePeriod is the details to be used for a Schedule of the
+// Repeating type.
+// +k8s:deepcopy-gen=true
+type SchedulePeriod struct {
+	// The startTime has the format HH:MM
+	// +kubebuilder:validation:Pattern="(([0-1][0-9])|([2][0-3])):([0-5][0-9])"
+	StartTime string `json:"startTime"`
+	// The days that this schedule will be active.
+	Days []ScheduleDay `json:"days"`
+	// The location name corresponding to a file in the IANA
+	// Time Zone database, like Europe/Berlin.
+	Timezone string `json:"timezone"`
+}
+
+// ScheduleDay represents the valid inputs for days in a SchedulePeriod.
+// +kubebuilder:validation:Enum=Sun;Mon;Tue;Wed;Thu;Fri;Sat
+// +k8s:deepcopy-gen=true
+type ScheduleDay string
+
+const (
+	SundaySchedule    ScheduleDay = "Sun"
+	MondaySchedule    ScheduleDay = "Mon"
+	TuesdaySchedule   ScheduleDay = "Tue"
+	WednesdaySchedule ScheduleDay = "Wed"
+	ThursdaySchedule  ScheduleDay = "Thu"
+	FridaySchedule    ScheduleDay = "Fri"
+	StaturdaySchedule ScheduleDay = "Sat"
+)
+
+// ScheduleDate is a RFC3339 representation of the date for a Schedule
+// of the OneTime type.
+// +kubebuilder:validation:Format="date-time"
+// +k8s:deepcopy-gen=true
+type ScheduleDate string
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// ScalingScheduleList is a list of namespaced scaling schedules.
+// +k8s:deepcopy-gen=true
+type ScalingScheduleList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []ScalingSchedule `json:"items"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// ScalingScheduleList is a list of cluster scoped scaling schedules.
+// +k8s:deepcopy-gen=true
+type ClusterScalingScheduleList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	Items []ScalingSchedule `json:"items"`
+}