From 964756eb6bc846c64d28aa7382657f18c8e09116 Mon Sep 17 00:00:00 2001 From: Marco <64641556+iompo@users.noreply.github.com> Date: Tue, 15 Feb 2022 20:07:05 +0100 Subject: [PATCH] fix documentation for creating an HTTPScaledObject (#351) * fix documentation for creating an HTTPScaledObject Signed-off-by: Marco Piovesana * chore: Allow blank issues (#352) Signed-off-by: Tom Kerkhove Signed-off-by: Marco Piovesana * Bump github.com/magefile/mage from 1.11.0 to 1.12.1 (#360) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump google.golang.org/grpc from 1.42.0 to 1.43.0 (#358) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * converting bug report issue template to a form issue (#363) Signed-off-by: Aaron Schlesinger Signed-off-by: Marco Piovesana * Allowing cluster-global operation (#269) * Allowing cluster-global operation Signed-off-by: Aaron Schlesinger * passing less unnecessary data in the operator Signed-off-by: Aaron Schlesinger * setting namespace Signed-off-by: Aaron Schlesinger * updating tests: Signed-off-by: Aaron Schlesinger * Updating deployment cache interfaces To accommodate multi-namespace gets and watches Signed-off-by: Aaron Schlesinger * starting on deployment cache informer Signed-off-by: Aaron Schlesinger * switching over to informer-based deployment cache Signed-off-by: Aaron Schlesinger * fixing test compile errors and merging fake and in-memory deployment caches Signed-off-by: Aaron * fixing tests Signed-off-by: Aaron Schlesinger * fixing more compile errs Signed-off-by: Aaron Schlesinger * improving logging, and several other small changes Signed-off-by: Aaron Schlesinger * go mod tidy Signed-off-by: Aaron Schlesinger * Adding config validation Signed-off-by: Aaron Schlesinger * improving ns and svc name var names to indicate interceptor Signed-off-by: Aaron Schlesinger * running go mod tidy Signed-off-by: Aaron Schlesinger * removing unused code Signed-off-by: Aaron Schlesinger * passing a function to transform target to in-cluster URL Signed-off-by: Aaron Schlesinger * not requiring namespace for operator Signed-off-by: Aaron Schlesinger * splitting namespace config for operator into watch and current Signed-off-by: Aaron Schlesinger * removing appInfo, passing current namespace everywhere in its place Signed-off-by: Aaron Schlesinger * using proper namespace when creating scaled object Signed-off-by: Aaron Schlesinger * allowing xkcd chart to set ingress namespace Signed-off-by: Aaron Schlesinger * printing namespace in error Signed-off-by: Aaron Schlesinger * using proper fully-qualified hostname of external scaler in scaledobject Signed-off-by: Aaron Schlesinger * adding note on cluster-global vs. namespaced mode Signed-off-by: Aaron Schlesinger * adding note about installing the xkcd chart in cluster-global mode Signed-off-by: Aaron Schlesinger * fixing hostname test Signed-off-by: Aaron Schlesinger * merging scaler queue counts with routing table hosts. removing merge functionality from interceptors Signed-off-by: Aaron Schlesinger * fix assumption in tests that queue has all hosts from routing table Signed-off-by: Aaron Schlesinger * adding test for MergeCountsWithRoutingTable Signed-off-by: Aaron Schlesinger * sleep for longer to wait for server to start Signed-off-by: Aaron Schlesinger * adding handler test for merging hosts Signed-off-by: Aaron Schlesinger * adding test to GetMetrics test cases for host not in queue pinger Signed-off-by: Aaron Schlesinger Signed-off-by: Marco Piovesana * Return custom header when request was returned from a cold start (#366) * Add X-KEDA-HTTP-Cold-Start header - Add X-KEDA-HTTP-Cold-Start header - Change signature of forwardWaitFunc to include deployment.Status.ReadyReplicas Signed-off-by: Aaron Wislang * Update tests for X-KEDA-HTTP-Cold-Start header Signed-off-by: Aaron Wislang * Update interceptor/main_test.go Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Aaron Wislang * add bracket Signed-off-by: Aaron Wislang Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Marco Piovesana * Updating dependencies (#348) * updating dependencies Signed-off-by: Aaron Schlesinger * NullLogger => Discard() Signed-off-by: Aaron Schlesinger * removing redundant import Signed-off-by: Aaron Schlesinger * updating to use go 1.17.2 Signed-off-by: Aaron Schlesinger * upgrading vulnerable packages Signed-off-by: Aaron Schlesinger * upgrading sftp Signed-off-by: Aaron Schlesinger * force-upgrading sftp Signed-off-by: Aaron Schlesinger Signed-off-by: Marco Piovesana * Bump go.uber.org/zap from 1.19.1 to 1.20.0 (#362) Bumps [go.uber.org/zap](https://github.com/uber-go/zap) from 1.19.1 to 1.20.0. - [Release notes](https://github.com/uber-go/zap/releases) - [Changelog](https://github.com/uber-go/zap/blob/master/CHANGELOG.md) - [Commits](https://github.com/uber-go/zap/compare/v1.19.1...v1.20.0) --- updated-dependencies: - dependency-name: go.uber.org/zap dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump github.com/go-logr/zapr from 0.4.0 to 1.2.2 (#357) Bumps [github.com/go-logr/zapr](https://github.com/go-logr/zapr) from 0.4.0 to 1.2.2. - [Release notes](https://github.com/go-logr/zapr/releases) - [Commits](https://github.com/go-logr/zapr/compare/v0.4.0...v1.2.2) --- updated-dependencies: - dependency-name: github.com/go-logr/zapr dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump k8s.io/apimachinery from 0.23.1 to 0.23.2 (#376) Bumps [k8s.io/apimachinery](https://github.com/kubernetes/apimachinery) from 0.23.1 to 0.23.2. - [Release notes](https://github.com/kubernetes/apimachinery/releases) - [Commits](https://github.com/kubernetes/apimachinery/compare/v0.23.1...v0.23.2) --- updated-dependencies: - dependency-name: k8s.io/apimachinery dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump k8s.io/client-go from 0.23.1 to 0.23.2 (#375) Bumps [k8s.io/client-go](https://github.com/kubernetes/client-go) from 0.23.1 to 0.23.2. - [Release notes](https://github.com/kubernetes/client-go/releases) - [Changelog](https://github.com/kubernetes/client-go/blob/master/CHANGELOG.md) - [Commits](https://github.com/kubernetes/client-go/compare/v0.23.1...v0.23.2) --- updated-dependencies: - dependency-name: k8s.io/client-go dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Compile binaries and docker images with git SHA (#377) * Compile binaries and docker images with git SHA Signed-off-by: Aaron Wislang Signed-off-by: Ubuntu * Fix test Signed-off-by: Aaron Wislang Signed-off-by: Ubuntu * Apply suggestions from @arschles Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Ubuntu Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump github.com/onsi/gomega from 1.17.0 to 1.18.0 (#378) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Configure WhiteSource Bolt for GitHub (#379) Co-authored-by: whitesource-bolt-for-github[bot] <42819689+whitesource-bolt-for-github[bot]@users.noreply.github.com> Co-authored-by: Tom Kerkhove Signed-off-by: Marco Piovesana * adding targetPendingRequests to the xkcd helm chart (#373) Signed-off-by: Aaron Schlesinger Signed-off-by: Marco Piovesana * fixing targetPendingRequests in the HTTPScaledObject v0.2.0 documentation (#372) Signed-off-by: Aaron Schlesinger Signed-off-by: Marco Piovesana * Add TestStreamIsActive (#384) * Return IsActive error vs log and continue Signed-off-by: Aaron Wislang * Add TestStreamIsActive Signed-off-by: Aaron Wislang * Bump github.com/onsi/gomega from 1.17.0 to 1.18.0 (#378) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Aaron Wislang * Configure WhiteSource Bolt for GitHub (#379) Co-authored-by: whitesource-bolt-for-github[bot] <42819689+whitesource-bolt-for-github[bot]@users.noreply.github.com> Co-authored-by: Tom Kerkhove Signed-off-by: Aaron Wislang * adding targetPendingRequests to the xkcd helm chart (#373) Signed-off-by: Aaron Schlesinger Signed-off-by: Aaron Wislang * fixing targetPendingRequests in the HTTPScaledObject v0.2.0 documentation (#372) Signed-off-by: Aaron Schlesinger Signed-off-by: Aaron Wislang * defer grpcServer.Stop() Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Aaron Wislang * Don't check error for gprServer Signed-off-by: Aaron Wislang Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: whitesource-bolt-for-github[bot] <42819689+whitesource-bolt-for-github[bot]@users.noreply.github.com> Co-authored-by: Tom Kerkhove Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump go.uber.org/zap from 1.20.0 to 1.21.0 (#394) Bumps [go.uber.org/zap](https://github.com/uber-go/zap) from 1.20.0 to 1.21.0. - [Release notes](https://github.com/uber-go/zap/releases) - [Changelog](https://github.com/uber-go/zap/blob/master/CHANGELOG.md) - [Commits](https://github.com/uber-go/zap/compare/v1.20.0...v1.21.0) --- updated-dependencies: - dependency-name: go.uber.org/zap dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump google.golang.org/grpc from 1.43.0 to 1.44.0 (#390) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.43.0 to 1.44.0. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](https://github.com/grpc/grpc-go/compare/v1.43.0...v1.44.0) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump github.com/onsi/gomega from 1.18.0 to 1.18.1 (#393) Bumps [github.com/onsi/gomega](https://github.com/onsi/gomega) from 1.18.0 to 1.18.1. - [Release notes](https://github.com/onsi/gomega/releases) - [Changelog](https://github.com/onsi/gomega/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/gomega/compare/v1.18.0...v1.18.1) --- updated-dependencies: - dependency-name: github.com/onsi/gomega dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump k8s.io/apimachinery from 0.23.2 to 0.23.3 (#392) Bumps [k8s.io/apimachinery](https://github.com/kubernetes/apimachinery) from 0.23.2 to 0.23.3. - [Release notes](https://github.com/kubernetes/apimachinery/releases) - [Commits](https://github.com/kubernetes/apimachinery/compare/v0.23.2...v0.23.3) --- updated-dependencies: - dependency-name: k8s.io/apimachinery dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Bump k8s.io/api from 0.23.2 to 0.23.3 (#389) Bumps [k8s.io/api](https://github.com/kubernetes/api) from 0.23.2 to 0.23.3. - [Release notes](https://github.com/kubernetes/api/releases) - [Commits](https://github.com/kubernetes/api/compare/v0.23.2...v0.23.3) --- updated-dependencies: - dependency-name: k8s.io/api dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Marco Piovesana * Update docs/walkthrough.md Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Signed-off-by: Marco Piovesana Co-authored-by: mpiovesana Co-authored-by: Tom Kerkhove Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Aaron Schlesinger <70865+arschles@users.noreply.github.com> Co-authored-by: Aaron Wislang Co-authored-by: whitesource-bolt-for-github[bot] <42819689+whitesource-bolt-for-github[bot]@users.noreply.github.com> --- docs/walkthrough.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/walkthrough.md b/docs/walkthrough.md index 6fd2054..a5a58b5 100644 --- a/docs/walkthrough.md +++ b/docs/walkthrough.md @@ -22,7 +22,7 @@ You'll need to clone the repository to get access to this chart. If you have you ## Creating an `HTTPScaledObject` -You interact with the operator via a CRD called `HTTPScaledObject`. This CRD object points the To get an example app up and running, read the notes below and then run the subsequent command from the root of this repository. +You interact with the operator via a CRD called `HTTPScaledObject`. This CRD object instructs interceptors to forward requests for a given host to your app's backing `Service`. To get an example app up and running, read the notes below and then run the subsequent command from the root of this repository. ```shell kubectl create -n $NAMESPACE -f examples/v0.2.0/httpscaledobject.yaml