kedacore / keda-docs

Documentation and landing page for KEDA

KEDA - Docs

Documentation and landing page for the KEDA project at keda.sh.

• Become a listed KEDA user!
• Become a listed KEDA commercial offering!

Contributing

We welcome issues and PRs! For details, see Contributing to KEDA.

If you submit a PR, Netlify will automatically create a deploy preview so that you can view your changes. Once merged, Netlify automatically deploys to the production site keda.sh.

To see deploy logs and more, visit project's dashboard -- Netlify login required.

keda-docs's Issues

Extend How can I use KEDA in a proxy network? troubleshooting docs

The solution described in How can I use KEDA in a proxy network? troubleshooting docs cannot be used in managed Kubernetes clusters like GKE or EKS: https://keda.sh/docs/troubleshooting/

It would be helpful to extend this section with solution for common cloud providers:

• GKE: Add default prom-adapter port 6443 to allowed ports in master node firewall rules. I tested this and it's working.
  • kubernetes-sigs/metrics-server#45 (comment)
  • https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules
• EKS: Update the Kubernetes nodes security groups to allow ingress / incoming https connections from the EKS masters security group and allow 443 egress from the control plane to the nodes. I haven't tested this.
  • kubernetes-sigs/metrics-server#45 (comment)
• AKS and other providers: Could be described by someone who has experience with other providers.

dead link Docs > Operate

https://keda.sh/docs/1.5/operate/

The 404 page also lists links that just link back to itself.

dead link from the menu:

Add nav bar and footer for samples

Thinking we add one more link for samples that links to the samples repo on GitHub?

Thoughts @tomkerkhove

https://keda.sh/docs/deploy/ link is broken

It was used in the https://github.com/kedacore/keda#deploying-keda to point users to the deployment option. This bug was brought be introducing versioned docs.

https://keda.sh/docs/deploy/ could link to the latests docs

Update companies contributing in "partnership" section

Update companies contributing in Partnership section to not only list Microsoft & Red Hat.

Débug outside cluster

Someone could write a walkthrough on how to debug Keda outside the cluster using vscode.

FAQ URL is broken with new design

https://keda.sh/faq/ is now https://keda.sh/docs/faq/ for example.

Question is, do we want to align to new approach or revert?

Provide getting started

Getting started page should walk new folks through the following steps:

1. Installing KEDA
2. Deploying deployment
3. Deploying the trigger auth
4. Deploying the scaled object
5. Monitor with KEDA dashboard

Transfer keda.sh DNS to CNCF

Transfer keda.sh DNS to CNCF

Blog post proposal about Strimzi + KEDA

Hi,
would you interested in a blog post talking about using Strimzi for deploying Kafka and leveraging the KEDA scaler for autoscaling Kafka Streams application?

`namespace` is not documented for Azure Service Bus scaler

namespace is not documented for Azure Service Bus scaler when using pod identity.

Based on: https://github.com/kedacore/keda/blob/master/pkg/scalers/azure_servicebus_scaler.go#L118
Ref: kedacore/keda#1116

In the Community section there are listed Users instead of Partners

In https://keda.sh/community/#partners section, there should be supporting companies of our community, but there are listed Users.

It is correct on the main page https://keda.sh/, see the difference between Users/Community part over there.

Docs are not versioned

Hi,

I've read through the docs about how to use AWS scalers, and added identityOwner just to find out that this feature was not relased yet.

It could be nice if there will be a version picker in the docs, to make sure the user understand he is reading the latest unreleased versioned docs.

Restructure deploy docs to list install & unistall as part of one section

Restructure deploy docs to list install & unistall as part of one section, ie focussed on Helm.

Today we have install with all options and uninstall with all options which is less ideal.

Provide docs on using KEDA with HTTP scaling

Provide docs on using KEDA with HTTP scaling via Osiris.

Current docs we had on kedacore/keda:

HTTP scaling integration
KEDA enables scaling based on event sources where the event resides somewhere to be pulled. For events like HTTP where the event is pushed to the container, KEDA works side by side with HTTP scale-to-zero components like Osiris or Knative serving. By pairing KEDA with an HTTP scale-to-zero component you can provide rich event scaling for both HTTP and non-HTTP.

We should document that we leverage multiple sources in the architecture docs

We should document that we leverage multiple sources in the architecture docs.

Something similar to the following, but prettier.

Without:

With KEDA:

Update KEDA logo and icons

We should update web page with the new fancy logo :)

Move architecture schematic to repo

On KEDA Architecture we have a visual representation of how KEDA works.

It would be good if we could move the original graphic file to the repo to make changes on it.

Do you have this somewhere @jeffhollan?

Duplicate scalers are listed on home page

Duplicate scalers are listed on home page when using multiple versions of our docs.

Document how to debug 1-> n scaling

Explain how to describe hpa to debug if 1->n isn't working

Reduce padding for page headers

Page headers have a lot of padding, would be good if we could reduce that a bit.

What are the requirements for the external scaler?

What are the requirements for the external scaler? From the docs it's not really clear how to use it and how/what the target endpoint should respond.

Can you elaborate a bit on this @ahmelsayed?

RabbitMQ Scaler documentation not up to date

Support for the triggerAuthentication has been added in kedacore/keda#385, but it's not updated in the KEDA doc https://keda.sh/docs/1.5/scalers/rabbitmq-queue/#authentication-parameters

Provide new scaler template

Provide a template that can be used to document new scalers so that all scalers use a similar doc approach.

The template should come with a brief doc describing what the goal is and what should be documented.

Remove old Netlify account

Remove old Netlify account which we used before CNCF donation.

Follow-up of #106

Provide docs for using Operator with KEDA

Provide docs for using Operator with KEDA

Document required Kubernetes version

We should document required Kubernetes version for new users under deploy as a prerequisite.

Provide 404 page

Provide 404 page

Provide guidance how to build an external scaler

Our current external scaler docs are very basic, we should enrich them in what it requires to be an external scaler.

Things it should cover are:

• What does it need to expose
• What are the data contracts that are required
• ..

Providing an OpenAPI spec for this might be a good option?

Improve Scaling Jobs docs and jobs scaling logic

Current documentation about jobs scaling is incomplete and the jobs scaler does not behave as one would intuitively expect.

The algorithm for spawning of new jobs is not described in detail in the docs. I would expect that:

1. When a job pulls a new task from the queue, it should dequeue it from the queue on the start.
2. The value of metric exposed by scaler should be the length of the queue (number of tasks that have not been pulled by any job yet).
3. After each pollingInterval KEDA spawns new jobs and their number is equal to value of the metric (length of the queue) - number of jobs that don't have running or completed status.
4. At the same time the number of new jobs is capped by inequality number of new jobs to spawn + number of jobs without running or completed status <= maxReplicaCount.

The 3. point was proposed also in kedacore/keda#525 (comment) to work like this but it still has not been resolved. If there are already jobs in pending status, KEDA does not take them into account and spawns all jobs in the queue again during next polling which can result in huge number of jobs if e.g. the pending jobs cannot be scheduled or are waiting for new nodes to be provisioned.

Further it is not clear, in the context of jobs scaling, what is the meaning of cooldownPeriod, minReplicaCount and threshold in Prometheus trigger (and similar parameters in other triggers).

[v2] Document ScaledJob Spec

ScaledJob migration guide

Add migration part for Jobs:
https://github.com/kedacore/keda-docs/blob/master/content/docs/2.0/migration.md

Provide docs on how to scale jobs

Provide docs on how to scale jobs

does KEDA works with azure BLOB trigger function app??

Created the blob azure function and tried to deploy it on minikube KEDA, am unable to see the HPA for blob trigger.
tried to use the YMl provided in :
https://keda.sh/scalers/azure-storage-blob/

What is KEDA webinar

@jeffhollan & myself did a webinar on KEDA this week and was thinking it might be a good asset for on the website.
https://www.youtube.com/watch?v=Ax-_xo0OgVw

Thoughts?

We could add it next to the KubeCon session or introduce some "Getting Started"/"Learn More"

Should we list who's supporting KEDA?

Should we list who's supporting KEDA?

In the main repo we have listed Microsoft & Red Hat which we might want to list in the community section as well? If other companies, let's say AWS, contribute we can add them as well.

Update KEDA.sh footer to standard LF/CNCF footer

I'd update it to:

© KEDA Authors 2014-2020 | Documentation Distributed under CC-BY-4.0© 2020 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.

Also linking to the trademark usage/policies page, see Prometheus as an example: https://prometheus.io/

Links on index page to Concepts, Architecture,... are broken

https://keda.sh/ ->
Links in the main section on the index page, (white buttons) are broken.
Concepts, Deploying KEDA, Architecture, Scalers, Blog

Probably because of migration to versioned docs.

Install WIP GitHub app

Install WIP GitHub app to avoid merging PRs that are marked as WIP.

https://github.com/apps/wip

Document how the blob scaler works and 5000 limit

Unify contents of Community sections

Community section on the main page is listing supporting companies:

The separate Community page is missing this part:

Would be great to unify both contents.

Provide docs on how to scale deployments

Provide docs on how to scale deployments

Provide docs on how to authenticate with TriggerAuthentication

Provide docs on how to authenticate with TriggerAuthentication

Calendar link for Community call is missing

There is a calendar link for Community call on https://github.com/kedacore/keda#community but is missing in the respective section on https://keda.sh

Transfer Netlify account to CNCF tenant

Transfer Netlify account to CNCF tenant

[v2] Document new features and capabilites

Update diagram

Kubernetes store should be Kubernetes API server in the diagram

[v2] Document ScaledObject Spec

Move site over

@tomkerkhove I hooked up Netlify to this repo, and pointed https://keda.sh to it. You should be able to stick your code here. In our contributor guide we’ll just enforce people need to open a PR on this repo if there are doc impacting features before they’ll get approved

Document how to deploy with Azure Function Core Tools

Document how to deploy with Azure Function Core Tools on https://keda.sh/docs/deploy/.