Merge remote-tracking branch 'origin/v2' into feature/kafka-scaler-of…

…fset-reset-policy

.github/workflows/pr-validation.yml

@@ -5,7 +5,7 @@ jobs:
     name: Validate
     runs-on: ubuntu-latest
     # build-tools is built from ../../tools/build-tools.Dockerfile
-    container: kedacore/build-tools:latest
+    container: kedacore/build-tools:v2
     steps:
       - name: Check out code
         uses: actions/checkout@v1
@@ -20,6 +20,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
 
+      - name: Verify Generated clientset is up to date
+        run: make verify-clientset
+
       - name: Test
         run: make test
 

.github/workflows/v2-build.yml

@@ -0,0 +1,46 @@
+name: master build
+on:
+  push:
+    branches:
+      - v2
+jobs:
+  validate:
+    name: Validate
+    runs-on: ubuntu-latest
+    # build-tools is built from ../../tools/build-tools.Dockerfile
+    container: kedacore/build-tools:v2
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+        with:
+          fetch-depth: 1
+
+      - name: Go modules cache
+        uses: actions/cache@v1
+        with:
+          path: /go/pkg
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Test
+        run: make test
+
+      - name: Login to Docker Hub
+        env:
+          DOCKER_HUB_ACCESS_TOKEN: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+          DOCKER_HUB_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
+        run: echo $DOCKER_HUB_ACCESS_TOKEN | docker login -u $DOCKER_HUB_USERNAME --password-stdin
+
+      - name: Publish
+        run: make publish
+
+      - name: Run end to end tests
+        env:
+          AZURE_SUBSCRIPTION: ${{ secrets.AZURE_SUBSCRIPTION }}
+          AZURE_RESOURCE_GROUP: ${{ secrets.AZURE_RESOURCE_GROUP }}
+          AZURE_SP_ID: ${{ secrets.AZURE_SP_ID }}
+          AZURE_SP_KEY: ${{ secrets.AZURE_SP_KEY }}
+          AZURE_SP_TENANT: ${{ secrets.AZURE_SP_TENANT }}
+          TEST_STORAGE_CONNECTION_STRING: ${{ secrets.TEST_STORAGE_CONNECTION_STRING }}
+        run: make e2e-test

CHANGELOG.md

@@ -2,49 +2,43 @@
 
 ## Deprecations
 
-- As of v1.3, support for `brokerList` is deprecated for our Kafka topic scaler and will be removed in v2.0 ([#632](https://github.com/kedacore/keda/issues/632))
-
 ## History
 
-- [v1.5.0](#v150)
+- [v2.0.0](#v200)
 - [v1.4.1](#v141)
 - [v1.4.0](#v140)
 - [v1.3.0](#v130)
 - [v1.2.0](#v120)
 - [v1.1.0](#v110)
 - [v1.0.0](#v100)
 
-## v1.5.0
-
-Learn more about our release in [our milestone](https://github.com/kedacore/keda/milestone/12).
+## v2.0.0
 
 ### New
 
-- **Scalers**
-    - Introduce Active MQ Artemis scaler ([Docs](https://keda.sh/docs/1.5/scalers/artemis/))
-    - Introduce Redis Streams scaler ([Docs](https://keda.sh/docs/1.5/scalers/redis-streams/) | [Details](https://github.com/kedacore/keda/issues/746))
-    - Introduce Cron scaler ([Docs](https://keda.sh/docs/1.5/scalers/cron/) | [Details](https://github.com/kedacore/keda/issues/812))
-- **Secret Providers**
-    - Introduce HashiCorp Vault secret provider ([Docs](https://keda.sh/docs/1.5/concepts/authentication/#hashicorp-vault-secrets) | [Details](https://github.com/kedacore/keda/issues/673))
-- **Other**
-    - Introduction of `nodeSelector` in raw YAML deployment specifications ([Details](https://github.com/kedacore/keda/pull/856))
+- KEDA scales any CustomResource that implements Scale subresource ([#703](https://github.com/kedacore/keda/issues/703))
+- Provide KEDA go-client ([#494](https://github.com/kedacore/keda/issues/494))
+- Define KEDA readiness and liveness probes ([#788](https://github.com/kedacore/keda/issues/788))
+- KEDA Support for configurable scaling behavior in HPA v2beta2 ([#802](https://github.com/kedacore/keda/issues/802))
+- Adding Standard Resource metrics to KEDA ([#874](https://github.com/kedacore/keda/pull/874))
 
 ### Improvements
 
-- Improved message count determination when using `includeUnacked` in RabbitMQ scaler ([Details](https://github.com/kedacore/keda/pull/781))
-- Fix for blank path without trailing slash in RabbitMQ scaler ([Details](https://github.com/kedacore/keda/issues/790))
-- Improved parsing of connection strings to support `BlobEndpoint`, `QueueEndpoint`, `TableEndpoint` & `FileEndpoint` segments ([Details](https://github.com/kedacore/keda/issues/821))
-- Support scaling when no storage checkpoint exists in Azure Event Hubs scaler ([Details](https://github.com/kedacore/keda/issues/797))
-- GCP Pub Scaler should not panic on invalid credentials ([Details](https://github.com/kedacore/keda/issues/616))
-- Make `queueLength` optional in RabbitMQ scaler ([Details](https://github.com/kedacore/keda/issues/880))
+- HPA: move from autoscaling v2beta1 to v2beta2 ([#721](https://github.com/kedacore/keda/issues/721))
+- Introduce shortnames for CRDs ([#774](https://github.com/kedacore/keda/issues/774))
+- kubectl get scaledobject should show related trigger authentication ([#777](https://github.com/kedacore/keda/issues/777))
+- kubectl get triggerauthentication should show information about configured parameters ([#778](https://github.com/kedacore/keda/issues/778))
 
 ### Breaking Changes
 
-None.
+- Change apiGroup from keda.k8s.io to keda.sh ([#552](https://github.com/kedacore/keda/issues/552))
+- Introduce a separate ScaledObject and ScaledJob([#653](https://github.com/kedacore/keda/issues/653))
+- Remove `New()` and `Close()` from the interface of `service ExternalScaler` in `externalscaler.proto`.
+- Removed deprecated brokerList for Kafka scaler ([#882](https://github.com/kedacore/keda/pull/882))
 
 ### Other
-
-None.
+- Update Operator SDK and k8s deps ([#870](https://github.com/kedacore/keda/issues/870))
+- Added ScaledObject Status Conditions to display status of scaling ([#750](https://github.com/kedacore/keda/pull/750))
 
 ## v1.4.1
 
@@ -107,7 +101,6 @@ None.
 ### Improvements
 
 - Make targetQueryValue configurable in postgreSQL scaler ([#643](https://github.com/kedacore/keda/pull/643))
-- Added bootstrapServers to deprecate brokerList ([#621](https://github.com/kedacore/keda/pull/621))
 - Removed the need for deploymentName label ([#644](https://github.com/kedacore/keda/pull/644))
 - Adding Kubernetes recommended labels to resources ([#596](https://github.com/kedacore/keda/pull/596))
 

CREATE-NEW-SCALER.md

@@ -8,14 +8,14 @@ In order to develop a scaler, a developer should do the following:
 2. Create the new scaler struct under the `pkg/scalers` folder.
 3. Implement the methods defined in the [scaler interface](#scaler-interface) section.
 4. Create a constructor according to [this](#constructor).
-5. Change the `getScaler` function in `pkg/handler/scale_handler.go` by adding another switch case that matches your scaler.
+5. Change the `getScaler` function in `pkg/scaling/scale_handler.go` by adding another switch case that matches your scaler.
 6. Run `make build` from the root of KEDA and your scaler is ready.
 
-If you want to deploy locally 
+If you want to deploy locally
 1. Run `export VERSION=local`
 2. Open the terminal and go to the root of the source code
 3. Run `make build`
-5. If you haven't done it yet clone the charts repository: `git  clone git@github.com:kedacore/charts.git` 
+5. If you haven't done it yet clone the charts repository: `git  clone git@github.com:kedacore/charts.git`
 6. In the terminal, navigate to the `chart/keda` folder (the charts downloaded in step 3), and run the following command (don't forget to replace the placeholder text in the command) `helm install . --set image.keda=kedacore/keda:[tag used in step 1],image.pullPolicy=IfNotPresent`.
 
 The last step assumes that you have `helm` already installed in the cluster. In this step we install the helm chart, and we substitute the image with the image we built in step 1. Notice that we are also overriding the image PullPolice to `IfNotPresent` since this is a local cluster.
@@ -29,12 +29,12 @@ The scalers in KEDA are implementations of a KEDA `Scaler` Go interface declared
 This is the key function of a scaler; it returns a value that represents a current state of an external metric (e.g. length of a queue). The return type is an `ExternalMetricValue` struct which has the following fields:
 - `MetricName`: this is the name of the metric that we are returning.
 - `Timestamp`: indicates the time at which the metrics were produced.
-- `WindowSeconds`: //TODO 
+- `WindowSeconds`: //TODO
 - `Value`: A numerical value that represents the state of the metric. It could be the length of a queue, or it can be the amount of lag in a stream, but it can also be a simple representation of the state.
 
-Kubernetes HPA (Horizontal Pod Autoscaler) will poll `GetMetrics` reulgarly through KEDA's metric server (as long as there is at least one pod), and compare the returned value to a configured value in the ScaledObject configuration. Kubernetes will use the following formula to decide whether to scale the pods up and down:  
+Kubernetes HPA (Horizontal Pod Autoscaler) will poll `GetMetrics` reulgarly through KEDA's metric server (as long as there is at least one pod), and compare the returned value to a configured value in the ScaledObject configuration. Kubernetes will use the following formula to decide whether to scale the pods up and down:
 
-`desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricValue )]`. 
+`desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricValue )]`.
 
 For more details check [Kubernetes HPA documentation](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
 
@@ -50,15 +50,15 @@ The return type of this function is `MetricSpec`, but in KEDA's case we will mos
 
 ### IsActive
 
-For some reason, the scaler might need to declare itself as in-active, and the way it can do this is through implementing the function `IsActive`. 
+For some reason, the scaler might need to declare itself as in-active, and the way it can do this is through implementing the function `IsActive`.
 
 KEDA polls ScaledObject object according to the `pollingInterval` confiugred in the ScaledObject; it checks the last time it was polled, it checks if the number of replicas is greater than 0, and if the scaler itself is active. So if the scaler returns false for `IsActive`, and if current number of replicas is greater than 0, and there is no configured minimum pods, then KEDA scales down to 0.
 
 ### Close
 After each poll on the scaler to retrieve the metrics, KEDA calls this function for each scaler to give the scaler the opportunity to close any resources, like http clients for example.
 
 ### Constructor
-What is missing from the `scaler` interface is a function that constructs the scaler itself. Up until the moment of writing this document, KEDA does not have a dynamic way to load scalers (at least not officially)[***]; instead scalers are part of KEDA's code-base, and they are shipped with KEDA's binary. 
+What is missing from the `scaler` interface is a function that constructs the scaler itself. Up until the moment of writing this document, KEDA does not have a dynamic way to load scalers (at least not officially)[***]; instead scalers are part of KEDA's code-base, and they are shipped with KEDA's binary.
 
 Thus, each scaler should have a constructing function, KEDA will [explicitly invoke](https://github.com/kedacore/keda/blob/4d0cf5ef09ef348cf3a158634910f00741ae5258/pkg/handler/scale_handler.go#L565) the construction function based on the `trigger` property configured in the ScaledObject.
 

Makefile

@@ -1,7 +1,7 @@
 ##################################################
 # Variables                                      #
 ##################################################
-VERSION		   ?= master
+VERSION		   ?= 2.0.0-alpha1
 IMAGE_REGISTRY ?= docker.io
 IMAGE_REPO     ?= kedacore
 
@@ -88,8 +88,12 @@ ifndef GOROOT
 	@echo "WARNING: GOROOT is not defined"
 endif
 
+.PHONY: gofmt
+gofmt:
+	go fmt ./...
+
 .PHONY: build
-build: checkenv build-adapter build-controller
+build: gofmt checkenv build-adapter build-controller
 
 .PHONY: build-controller
 build-controller: generate-api pkg/scalers/liiklus/LiiklusService.pb.go
@@ -107,10 +111,28 @@ build-adapter: generate-api pkg/scalers/liiklus/LiiklusService.pb.go
 .PHONY: generate-api
 generate-api:
 	$(GO_BUILD_VARS) operator-sdk generate k8s
-	$(GO_BUILD_VARS) operator-sdk generate openapi
+	$(GO_BUILD_VARS) operator-sdk generate crds --crd-version=v1beta1
+	# withTriggers and withPods are only used for duck typing so we only need the deepcopy methods
+	# However operator-sdk generate doesn't appear to have an option for that
+	# until this issue is fixed: https://github.com/kubernetes-sigs/controller-tools/issues/398 
+	rm deploy/crds/keda.sh_withtriggers_crd.yaml
+	rm deploy/crds/keda.sh_withpods_crd.yaml
 
 pkg/scalers/liiklus/LiiklusService.pb.go: hack/LiiklusService.proto
 	protoc -I hack/ hack/LiiklusService.proto --go_out=plugins=grpc:pkg/scalers/liiklus
 
 pkg/scalers/liiklus/mocks/mock_liiklus.go: pkg/scalers/liiklus/LiiklusService.pb.go
 	mockgen github.com/kedacore/keda/pkg/scalers/liiklus LiiklusServiceClient > pkg/scalers/liiklus/mocks/mock_liiklus.go
+
+##################################################
+# Clientset                                      #
+##################################################
+.PHONY: verify-clientset
+verify-clientset:
+	$(GO_BUILD_VARS) go mod vendor
+	./hack/verify-codegen.sh
+
+.PHONY: generate-clientset
+generate-clientset:
+	$(GO_BUILD_VARS) go mod vendor
+	./hack/update-codegen.sh

README.md

@@ -1,3 +1,17 @@
+<p style="font-size: 30px" align="center"><b>This branch contains unstable KEDA v2.0.0-alpha1, currently under development</b></p>
+
+## How can I try KEDA v2 alpha version?
+Make sure to remove previous KEDA (including CRD) from the cluster. Switch to the `v2` branch and deploy yaml files:
+```bash
+   git fetch --all
+   git checkout v2
+   kubectl apply -f deploy/crds/keda.sh_scaledobjects_crd.yaml
+   kubectl apply -f deploy/crds/keda.sh_scaledjobs_crd.yaml
+   kubectl apply -f deploy/crds/keda.sh_triggerauthentications_crd.yaml
+   kubectl apply -f deploy/
+```
+
+
 <p align="center"><img src="images/keda-logo-transparent.png" width="300"/></p>
 <p style="font-size: 25px" align="center"><b>Kubernetes-based Event Driven Autoscaling</b></p>
 <p style="font-size: 25px" align="center">
@@ -120,8 +134,9 @@ To be KEDA to be fully operational we need to deploy Metrics Server first.
 
 1. Deploy CRDs and KEDA into `keda` namespace
    ```bash
-   kubectl apply -f deploy/crds/keda.k8s.io_scaledobjects_crd.yaml
-   kubectl apply -f deploy/crds/keda.k8s.io_triggerauthentications_crd.yaml
+   kubectl apply -f deploy/crds/keda.sh_scaledobjects_crd.yaml
+   kubectl apply -f deploy/crds/keda.sh_scaledjob_crd.yaml
+   kubectl apply -f deploy/crds/keda.sh_triggerauthentications_crd.yaml
    kubectl apply -f deploy/
    ```
 2. Scale down `keda-operator` Deployment

build/bin/entrypoint

@@ -1,11 +1,3 @@
 #!/bin/sh -e
 
-# This is documented here:
-# https://docs.openshift.com/container-platform/3.11/creating_images/guidelines.html#openshift-specific-guidelines
-
-if ! whoami &>/dev/null; then
-  if [ -w /etc/passwd ]; then
-    echo "${USER_NAME:-keda}:x:$(id -u):$(id -g):${USER_NAME:-keda} user:${HOME}:/sbin/nologin" >> /etc/passwd
-  fi
-fi
 exec ${OPERATOR} $@

build/bin/user_setup

@@ -2,6 +2,7 @@
 set -x
 
 # ensure $HOME exists and is accessible by group 0 (we don't know what the runtime UID will be)
+echo "${USER_NAME}:x:${USER_UID}:0:${USER_NAME} user:${HOME}:/sbin/nologin" >> /etc/passwd
 mkdir -p ${HOME}
 chown ${USER_UID}:0 ${HOME}
 chmod ug+rwx ${HOME}

cmd/adapter/main.go

@@ -6,18 +6,17 @@ import (
 	"os"
 	"runtime"
 
-	"github.com/kedacore/keda/pkg/handler"
+	kedav1alpha1 "github.com/kedacore/keda/pkg/apis/keda/v1alpha1"
 	kedaprovider "github.com/kedacore/keda/pkg/provider"
+	"github.com/kedacore/keda/pkg/scaling"
 	"github.com/kedacore/keda/version"
 
-	"k8s.io/apimachinery/pkg/util/wait"
-	"k8s.io/klog"
-	"k8s.io/klog/klogr"
-
-	kedav1alpha1 "github.com/kedacore/keda/pkg/apis/keda/v1alpha1"
 	"github.com/operator-framework/operator-sdk/pkg/k8sutil"
 	appsv1 "k8s.io/api/apps/v1"
+	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/client-go/kubernetes/scheme"
+	"k8s.io/klog"
+	"k8s.io/klog/klogr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
 
@@ -62,7 +61,7 @@ func (a *Adapter) makeProviderOrDie() provider.MetricsProvider {
 		os.Exit(1)
 	}
 
-	handler := handler.NewScaleHandler(kubeclient, scheme)
+	handler := scaling.NewScaleHandler(kubeclient, nil, scheme)
 
 	namespace, err := k8sutil.GetWatchNamespace()
 	if err != nil {