Merge pull request #348 from zalando-incubator/pitr-zmon

fixes for ZMON client

.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.14.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,6 +1,8 @@
 FROM registry.opensource.zalan.do/library/alpine-3.12:latest
 LABEL maintainer="Team Teapot @ Zalando SE <team-teapot@zalando.de>"
 
+RUN apk add --no-cache tzdata
+
 # add binary
 ADD build/linux/kube-metrics-adapter /
 

Makefile

@@ -10,6 +10,10 @@ 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
@@ -18,14 +22,22 @@ 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) $(OPENAPI)
+	./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 \
@@ -36,17 +48,17 @@ $(OPENAPI): go.mod
 		-O zz_generated.openapi \
 		-r /dev/null
 
-build.local: build/$(BINARY)
+build.local: build/$(BINARY) $(GENERATED_CRDS)
 build.linux: build/linux/$(BINARY)
 build.osx: build/osx/$(BINARY)
 
-build/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
+build/$(BINARY): go.mod $(SOURCES) $(GENERATED)
 	CGO_ENABLED=0 go build -o build/$(BINARY) $(BUILD_FLAGS) -ldflags "$(LDFLAGS)" .
 
-build/linux/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
+build/linux/$(BINARY): go.mod $(SOURCES) $(GENERATED)
 	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/linux/$(BINARY) -ldflags "$(LDFLAGS)" .
 
-build/osx/$(BINARY): go.mod $(SOURCES) $(OPENAPI)
+build/osx/$(BINARY): go.mod $(SOURCES) $(GENERATED)
 	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
@@ -110,6 +110,8 @@ metadata:
     metric-config.pods.requests-per-second.json-path/port: "9090"
     metric-config.pods.requests-per-second.json-path/scheme: "https"
     metric-config.pods.requests-per-second.json-path/aggregator: "max"
+    metric-config.pods.requests-per-second.json-path/interval: "60s" # optional
+    metric-config.pods.requests-per-second.json-path/min-pod-ready-age: "30s" # optional
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -174,6 +176,11 @@ metric-config.pods.requests-per-second.json-path/connect-timeout: 500ms
 
 The default for both of the above values is 15 seconds.
 
+The `min-pod-ready-age` configuration option instructs the service to start collecting metrics from the pods only if they are "older" (time elapsed after pod reached "Ready" state) than the specified amount of time.
+This is handy when pods need to warm up before HPAs will start tracking their metrics.
+
+The default value is 0 seconds.
+
 ## Prometheus collector
 
 The Prometheus collector is a generic collector which can map Prometheus
@@ -202,16 +209,6 @@ 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
@@ -234,6 +231,7 @@ metadata:
     # 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])))
+    metric-config.external.processed-events-per-second.prometheus/interval: "60s" # optional
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -411,6 +409,7 @@ metadata:
           // Rename "_value" to "metricvalue" for letting the metrics server properly unmarshal the result.
           |> rename(columns: {_value: "metricvalue"})
           |> keep(columns: ["metricvalue"])
+    metric-config.external.queue-depth.influxdb/interval: "60s" # optional
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -532,6 +531,7 @@ metadata:
     # 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-*"
+    metric-config.external.my-zmon-check.zmon/interval: "60s" # optional
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -587,8 +587,8 @@ For instance if you define the entity filter
 then you might want to get an average over the metrics for those three
 entities. This would be possible by using the `avg` aggregator. The default
 aggregator is `last` which returns only the latest metric point from the
-query. The supported aggregation functions are `avg`, `dev`, `count`,
-`first`, `last`, `max`, `min`, `sum`, `diff`. See the [KariosDB docs](https://kairosdb.github.io/docs/build/html/restapi/Aggregators.html) for
+query. The supported aggregation functions are `avg`, `count`,
+`last`, `max`, `min`, `sum`, `diff`. See the [KariosDB docs](https://kairosdb.github.io/docs/build/html/restapi/Aggregators.html) for
 details.
 
 The `duration` defines the duration used for the timeseries query. E.g. if you
@@ -629,6 +629,7 @@ metadata:
     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"
+    metric-config.external.unique-metric-name.json-path/interval: "60s" # optional
 spec:
   scaleTargetRef:
     apiVersion: apps/v1
@@ -649,12 +650,141 @@ spec:
         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:
+The HTTP collector similar to the Pod Metrics collector. 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`.
+
+### Scrape Interval
+
+It's possible to configure the scrape interval for each of the metric types via
+an annotation:
+
+```yaml
+metric-config.<metricType>.<metricName>.<collectorType>/interval: "30s"
+```
+
+The default is `60s` but can be reduced to let the adapter collect metrics more
+often.
+
+## ScalingSchedule Collectors
+
+The `ScalingSchedule` and `ClusterScalingSchedule` collectors allow
+collecting time-based metrics from the respective CRD objects specified
+in the HPA.
+
+### Supported metrics
+
+| Metric | Description | Type | K8s Versions |
+| ---------- | -------------- | ------- | -- |
+| ObjectName | The metric is calculated and stored for each `ScalingSchedule` and `ClusterScalingSchedule` referenced in the HPAs | `ScalingSchedule` and `ClusterScalingSchedule` | `>=1.16` |
+
+### Example
+
+This is an example of using the ScalingSchedule collectors to collect
+metrics from a deployed kind of the CRD. First, the schedule object:
+
+```yaml
+apiVersion: zalando.org/v1
+kind: ClusterScalingSchedule
+metadata:
+  name: "scheduling-event"
+spec:
+  schedules:
+  - type: OneTime
+    date: "2021-10-02T08:08:08+02:00"
+    durationMinutes: 30
+    value: 100
+  - type: Repeating
+    durationMinutes: 10
+    value: 120
+    period:
+      startTime: "15:45"
+      timezone: "Europe/Berlin"
+      days:
+      - Mon
+      - Wed
+      - Fri
+```
+
+This resource defines a scheduling event named `scheduling-event` with
+two schedules of the kind `ClusterScalingSchedule`.
+
+`ClusterScalingSchedule` objects aren't namespaced, what means it can be
+referenced by any HPA in any namespace in the cluster. `ScalingSchedule`
+have the exact same fields and behavior, but can be referenced just by
+HPAs in the same namespace. The schedules can have the type `Repeating`
+or `OneTime`.
+
+This example configuration will generate the following result: at
+`2021-10-02T08:08:08+02:00` for 30 minutes a metric with the value of
+100 will be returned. Every Monday, Wednesday and Friday, starting at 15
+hours and 45 minutes (Berlin time), a metric with the value of 120 will
+be returned for 10 minutes. It's not the case of this example, but if multiple
+schedules collide in time, the biggest value is returned.
+
+Check the CRDs definitions
+([ScalingSchedule](./docs/scaling_schedules_crd.yaml),
+[ClusterScalingSchedule](./docs/cluster_scaling_schedules_crd.yaml)) for
+a better understanding of the possible fields and their behavior.
+
+An HPA can reference the deployed `ClusterScalingSchedule` object as
+this example:
+
+```yaml
+apiVersion: autoscaling/v2beta2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: "myapp-hpa"
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: myapp
+  minReplicas: 1
+  maxReplicas: 15
+  metrics:
+  - type: Object
+    object:
+      describedObject:
+        apiVersion: zalando.org/v1
+        kind: ClusterScalingSchedule
+        name: "scheduling-event"
+      metric:
+        name: "scheduling-event"
+      target:
+        type: AverageValue
+        averageValue: "10"
+```
+
+The name of the metric is equal to the name of the referenced object.
+The `target.averageValue` in this example is set to 10. This value will
+be used by the HPA controller to define the desired number of pods,
+based on the metric obtained (check the [HPA algorithm
+details](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#algorithm-details)
+for more context). This HPA configuration explicitly says that each pod
+of this application supports 10 units of the `ClusterScalingSchedule`
+metric. Multiple applications can share the same
+`ClusterScalingSchedule` or `ScalingSchedule` event and have a different
+number of pods based on its `target.averageValue` configuration.
+
+In our specific example at `2021-10-02T08:08:08+02:00` as the metric has
+the value 100, this application will scale to 10 pods (100/10). Every
+Monday, Wednesday and Friday, starting at 15 hours and 45 minutes
+(Berlin time) the application will scale to 12 pods (120/10). Both
+scaling up will last at least the configured duration times of the
+schedules. After that, regular HPA scale down behavior applies.
+
+Note that these number of pods are just considering these custom
+metrics, the normal HPA behavior still applies, such as: in case of
+multiple metrics the biggest number of pods is the utilized one, HPA max
+and min replica configuration, autoscaling policies, etc.
+
+These collectors are disabled by default, you have to start the server
+with the `--scaling-schedule` flag to enable it. Remember to deploy the CRDs
+`ScalingSchedule` and `ClusterScalingSchedule` and allow the service
+account used by the server to read, watch and list them.

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/custom-metrics-apiservice.yaml

@@ -1,4 +1,4 @@
-apiVersion: apiregistration.k8s.io/v1beta1
+apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
   name: v1beta1.custom.metrics.k8s.io

docs/deployment.yaml

@@ -28,6 +28,7 @@ spec:
         - --prometheus-server=http://prometheus.kube-system.svc.cluster.local
         - --skipper-ingress-metrics
         - --aws-external-metrics
+        - --scaling-schedule
         env:
         - name: AWS_REGION
           value: eu-central-1

docs/external-metrics-apiservice.yaml

@@ -1,4 +1,4 @@
-apiVersion: apiregistration.k8s.io/v1beta1
+apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
   name: v1beta1.external.metrics.k8s.io

docs/helm/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: kube-metrics-adapter
-version: 0.1.9
+version: 0.1.11
 description: kube-metrics-adapter helm chart
 home: https://github.com/zalando-incubator/kube-metrics-adapter
 maintainers:

docs/helm/templates/cluster_scaling_schedules_crd.yaml

@@ -0,0 +1,119 @@
+{{- if .Values.scalingSchedule.enabled }}
+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: []
+{{- end}}

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

@@ -1,5 +1,5 @@
 {{- if .Values.enableCustomMetricsApi }}
-apiVersion: apiregistration.k8s.io/v1beta1
+apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
   name: v1beta1.custom.metrics.k8s.io
@@ -12,4 +12,4 @@ spec:
   insecureSkipTLSVerify: {{ .Values.tls.skipTLSVerify }}
   groupPriorityMinimum: 100
   versionPriority: 100
-{{- end}}
+{{- end}}

docs/helm/templates/deployment.yaml

@@ -182,6 +182,9 @@ spec:
             {{- if .Values.zmon.tokenName }}
             - --zmon-token-name={{ .Values.zmon.tokenName }}
             {{- end}}
+            {{- if .Values.scalingSchedule.enabled }}
+            - --scaling-schedule
+            {{- end}}
           resources:
             limits:
               cpu: {{ .Values.resources.limits.cpu }}

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

@@ -1,5 +1,5 @@
 {{- if .Values.enableExternalMetricsApi }}
-apiVersion: apiregistration.k8s.io/v1beta1
+apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
   name: v1beta1.external.metrics.k8s.io

docs/helm/templates/rbac.yaml

@@ -73,6 +73,17 @@ rules:
   - get
   - list
   - watch
+{{- if .Values.scalingSchedule.enabled }}
+- apiGroups:
+  - zalando.org
+  resources:
+  - clusterscalingschedules
+  - scalingschedules
+  verbs:
+  - get
+  - list
+  - watch
+{{- end}}
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

docs/helm/templates/scaling_schedules_crd.yaml

@@ -0,0 +1,119 @@
+{{- if .Values.scalingSchedule.enabled }}
+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: []
+{{- end}}

docs/helm/values.yaml

@@ -4,7 +4,7 @@ replicas: 1
 
 registry:
   image: registry.opensource.zalan.do/teapot/kube-metrics-adapter
-  imageTag: v0.1.9
+  imageTag: v0.1.10
   imagePullPolicy: IfNotPresent
 
 service:
@@ -92,3 +92,6 @@ resources:
   requests:
     cpu: 100m
     memory: 100Mi
+
+scalingSchedule:
+  enabled: false

docs/rbac.yaml

@@ -78,6 +78,15 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - zalando.org
+  resources:
+  - clusterscalingschedules
+  - scalingschedules
+  verbs:
+  - get
+  - list
+  - watch
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

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: []

go.mod

@@ -2,35 +2,32 @@ module github.com/zalando-incubator/kube-metrics-adapter
 
 require (
 	github.com/NYTimes/gziphandler v1.0.1 // indirect
-	github.com/aws/aws-sdk-go v1.36.19
-	github.com/go-openapi/spec v0.20.0
-	github.com/googleapis/gnostic v0.2.0 // indirect
+	github.com/aws/aws-sdk-go v1.39.2
+	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-incubator/custom-metrics-apiserver v0.0.0-20201023074945-51cc7b53320e
-	github.com/mattn/go-colorable v0.1.4 // indirect
-	github.com/mattn/go-isatty v0.0.10 // indirect
-	github.com/onsi/gomega v1.8.1 // indirect
-	github.com/prometheus/client_golang v1.9.0
-	github.com/prometheus/common v0.15.0
-	github.com/sirupsen/logrus v1.7.0
-	github.com/spf13/cobra v0.0.7
+	github.com/kubernetes-sigs/custom-metrics-apiserver v0.0.0-20201216091021-1b9fa998bbaa
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/prometheus/client_golang v1.10.0
+	github.com/prometheus/common v0.25.0
+	github.com/sirupsen/logrus v1.8.1
+	github.com/spf13/cobra v1.1.3
 	github.com/spyzhov/ajson v0.4.2
-	github.com/stretchr/testify v1.6.1
+	github.com/stretchr/testify v1.7.0
 	github.com/zalando-incubator/cluster-lifecycle-manager v0.0.0-20180921141935-824b77fb1f84
 	golang.org/x/crypto v0.0.0-20201124201722-c8d3bf9c5392 // indirect
-	golang.org/x/net v0.0.0-20201224014010-6772e930b67b // indirect
-	golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
-	golang.org/x/tools v0.0.0-20200204192400-7124308813f3 // indirect
-	honnef.co/go/tools v0.0.1-2020.1.3 // indirect
-	k8s.io/api v0.18.14
-	k8s.io/apimachinery v0.18.14
-	k8s.io/apiserver v0.18.14
-	k8s.io/client-go v0.18.14
-	k8s.io/component-base v0.18.14
+	golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	k8s.io/api v0.20.5
+	k8s.io/apimachinery v0.20.5
+	k8s.io/apiserver v0.20.5
+	k8s.io/client-go v0.20.5
+	k8s.io/code-generator v0.20.5
+	k8s.io/component-base v0.20.5
 	k8s.io/klog v1.0.0
-	k8s.io/kube-openapi v0.0.0-20200410145947-61e04a5be9a6
-	k8s.io/metrics v0.18.8
+	k8s.io/kube-openapi v0.0.0-20201113171705-d219536bb9fd
+	k8s.io/metrics v0.20.5
+	sigs.k8s.io/controller-tools v0.5.0
 )
 
-go 1.15
+go 1.16

hack/tools.go

@@ -1,6 +1,23 @@
 // +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/kube-openapi/cmd/openapi-gen"
+import (
+	_ "k8s.io/code-generator"
+	_ "k8s.io/kube-openapi/cmd/openapi-gen"
+	_ "sigs.k8s.io/controller-tools/cmd/controller-gen"
+)

hack/update-codegen.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+# Copyright 2017 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.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+SRC="github.com"
+GOPKG="${SRC}/zalando-incubator/kube-metrics-adapter"
+CUSTOM_RESOURCE_NAME="zalando.org"
+CUSTOM_RESOURCE_VERSION="v1"
+
+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.
+
+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"
+
+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
+cp -r "$OUTPUT_BASE/$GOPKG/pkg/client" ./pkg
+rm -rf "${OUTPUT_BASE:?}${SRC}"

pkg/annotations/parser.go

@@ -12,13 +12,15 @@ const (
 	customMetricsPrefix      = "metric-config."
 	perReplicaMetricsConfKey = "per-replica"
 	intervalMetricsConfKey   = "interval"
+	minPodReadyAgeConfKey    = "min-pod-ready-age"
 )
 
 type AnnotationConfigs struct {
-	CollectorType string
-	Configs       map[string]string
-	PerReplica    bool
-	Interval      time.Duration
+	CollectorType  string
+	Configs        map[string]string
+	PerReplica     bool
+	Interval       time.Duration
+	MinPodReadyAge time.Duration
 }
 
 type MetricConfigKey struct {
@@ -89,6 +91,15 @@ func (m AnnotationConfigMap) Parse(annotations map[string]string) error {
 			continue
 		}
 
+		if parts[1] == minPodReadyAgeConfKey {
+			minPodReadyAge, err := time.ParseDuration(val)
+			if err != nil {
+				return fmt.Errorf("failed to parse min-pod-ready-age value %s for %s: %v", val, key, err)
+			}
+			config.MinPodReadyAge = minPodReadyAge
+			continue
+		}
+
 		config.Configs[parts[1]] = val
 	}
 	return nil

pkg/annotations/parser_test.go

@@ -24,10 +24,11 @@ func TestParser(t *testing.T) {
 		{
 			Name: "pod metrics",
 			Annotations: map[string]string{
-				"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",
-				"metric-config.pods.requests-per-second.json-path/scheme":   "https",
+				"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",
+				"metric-config.pods.requests-per-second.json-path/scheme":            "https",
+				"metric-config.pods.requests-per-second.json-path/min-pod-ready-age": "30s",
 			},
 			MetricName: "requests-per-second",
 			MetricType: autoscalingv2.PodsMetricSourceType,

pkg/apis/zalando.org/register.go

@@ -0,0 +1,6 @@
+package zalando
+
+const (
+	// GroupName is the group name used in this package.
+	GroupName = "zalando.org"
+)

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

@@ -0,0 +1,129 @@
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:object:root=true
+
+// ScalingSchedule describes a namespaced time based metric to be used
+// in autoscaling operations.
+// +k8s:deepcopy-gen=true
+type ScalingSchedule struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec ScalingScheduleSpec `json:"spec"`
+}
+
+// +genclient
+// +genclient:nonNamespaced
+// +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,omitempty"`
+	// Defines the starting date of a OneTime schedule. It has to
+	// be a RFC3339 formated date.
+	// +optional
+	Date *ScheduleDate `json:"date,omitempty"`
+	// 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
+type ScheduleDay string
+
+const (
+	SundaySchedule    ScheduleDay = "Sun"
+	MondaySchedule    ScheduleDay = "Mon"
+	TuesdaySchedule   ScheduleDay = "Tue"
+	WednesdaySchedule ScheduleDay = "Wed"
+	ThursdaySchedule  ScheduleDay = "Thu"
+	FridaySchedule    ScheduleDay = "Fri"
+	SaturdaySchedule  ScheduleDay = "Sat"
+)
+
+// ScheduleDate is a RFC3339 representation of the date for a Schedule
+// of the OneTime type.
+// +kubebuilder:validation:Format="date-time"
+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"`
+}