Skip to content

Commit

Permalink
wording fixes and setting scaffolding (kedacore#3)
Browse files Browse the repository at this point in the history
* wording fixes
  • Loading branch information
jeffhollan authored Nov 13, 2019
1 parent 3d76bd8 commit 36b42ae
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 28 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ Windows:
choco install hugo-extended
```

Mac:

```
brew install hugo
```

Run docs locally:

```
Expand Down
32 changes: 13 additions & 19 deletions content/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,43 @@ weight = 100
+++

#### What is KEDA and why is it useful?
KEDA stands for Kubernetes Event Driven Auto-Scaler. It is built to be able to activate a Kubernetes deployment (i.e. no pods to a single pod) and subsequently to more pods based on events from various event sources.
KEDA stands for Kubernetes-based Event Driven Auto-Scaler. It is built to be able to activate a Kubernetes deployment (i.e. no pods to a single pod) and subsequently to more pods based on events from various event sources.

#### What are the prerequisites for using KEDA?
KEDA is designed to be run on any vanilla Kubernetes cluster. It uses a CRD and needs a Metric Server so you will have to use a Kubernetes version which supports these. Any Kubernetes cluster >= 1.11.10 have been tested and should work.
KEDA is designed to be run on any Kubernetes cluster. It uses a CRD (custom resource definition) and the Kubenretes metric server so you will have to use a Kubernetes version which supports these. Any Kubernetes cluster >= 1.11.10 has been tested and should work.

#### Does KEDA depend on any Azure service?
No, KEDA only takes a dependency on vanilla Kubernetes constructs and can run on any Kubernetes cluster whether in OpenShift, AKS, GKE, EKS or your own.
No, KEDA only takes a dependency on standard Kubernetes constructs and can run on any Kubernetes cluster whether in OpenShift, AKS, GKE, EKS or your own infrastructure.

#### Does KEDA only work with Azure Functions?
No, KEDA can scale up/down any container that you specify in your deployment. There has however been work done in the Azure Function tooling to make it easy to install an Azure Function container.
No, KEDA can scale up/down any container that you specify in your deployment. There has been work done in the Azure Functions tooling to make it easy to scale an Azure Function container.

#### Why should we use KEDA if we are already use Azure Functions in Azure?

* Want to run functions on-premises (potentially in something like an 'intelligent edge' architecture)
* Want to run functions alongside other Kubernetes apps (maybe in a restricted network, app mesh, custom environment, etc.)
* Want to run functions outside of Azure (no vendor lockin)
* Specific need for more control (GPU enabled compute clusters, more knobs and such)
* Run functions on-premises (potentially in something like an 'intelligent edge' architecture)
* Run functions alongside other Kubernetes apps (maybe in a restricted network, app mesh, custom environment, etc.)
* Run functions outside of Azure (no vendor lock-in)
* Specific need for more control (GPU enabled compute clusters, policies, etc.)

#### Can I scale my Http triggered Azure Function on Kubernetes with KEDA?
Yes we currently enable this through Osiris. It is integrated in the Azure Functions tooling i.e. through the Core tools. We are working on making significant investment in this scenario going forward. Stay tuned!

How do I add a new Scaler?
[TODO]
#### Can I scale my HTTP container or function with KEDA and Kubernetes?
KEDA will scale a container using metrics from a scaler. There is no scaler today for HTTP workloads directly. We recommend using the prometheus scaler to create scale rule based on metrics around HTTP events for now.

#### Where can I get to the code for the Scalers?
All scalers have their code [here](https://github.com/kedacore/keda/tree/master/pkg/scalers)

#### Is short polling intervals a problem?
Polling interval really only impacts the time-to-activation (scaling from 0 to 1) but once scaled to one it's really up to the HPA which polls KEDA.
Polling interval really only impacts the time-to-activation (scaling from 0 to 1) but once scaled to one it's really up to the HPA (horizontal pod autoscaler) which polls KEDA.

#### How can I get involved?
There are several ways to get involved.

* Pick up an issue to work on. A good place to start might be issues which are marked as [Good First Issue](https://github.com/kedacore/keda/labels/good%20first%20issue) or [Help Wanted](https://github.com/kedacore/keda/labels/help%20wanted)
* We are always looking to add more scalers. These are some ideas of missing scalers
* We are always looking to add more scalers.
* We are always looking for more samples, documentation etc.
* Please join us in our [weekly standup](https://github.com/kedacore/keda#community-standup)

#### Can KEDA be used in production?
As of September 2019 KEDA is still in beta and hence it is not suggested to use in production. We are fast approaching a 1.0 release and then you should be able to use it in production.

#### Is there an ETA for KEDA release 1.0?
Currently we are targeting the end of 2019 if not earlier for a KEDA 1.0 release.
Yes! KEDA is now 1.0 and suited for production workloads.

#### What does it cost?
There is no charge for using KEDA itself.
2 changes: 1 addition & 1 deletion content/_index/features/event-driven.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "Event-driven"
weight = 40
weight = 5

[asset]
icon = "fas fa-bolt"
Expand Down
2 changes: 1 addition & 1 deletion content/_index/features/scaling-made-simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ weight = 10
icon = "fas fa-rocket"
+++

Just let us know how to scale, we've got this
Bring rich scaling to every container
2 changes: 1 addition & 1 deletion content/_index/hero.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ subtitle = "Kubernetes Event-driven Autoscaling (KEDA)"

[[buttons]]
text = "Architecture"
url = "/Architecture"
url = "/architecture"
color = "info" # primary, secondary, success, danger, warning, info, light, dark, link - default: primary

[[buttons]]
Expand Down
2 changes: 1 addition & 1 deletion content/_index/scalers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ weight = "200"

background = "light"
title = "Scalers"
subtitle = "Syna comes with a lot of fragments, allowing you to design your pages as you want them"
subtitle = "Scalers represent event sources that KEDA can scale based on"
+++
10 changes: 5 additions & 5 deletions content/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ We provide a few approaches to deploy KEDA in your Kubernetes clusters:

- Operator framework
- Helm charts
- Azure Function Core Tool
- Azure Function Core Tools
- YAML declarations

Don't see what you need? Feel free to [create an issue]() on our GitHub repo.
Don't see what you need? Feel free to [create an issue](https://github.com/kedacore/keda) on our GitHub repo.

## Deploying with a Helm chart

Expand All @@ -38,15 +38,15 @@ helm install kedacore/keda-edge --devel --set logLevel=debug --namespace keda --
You can use our ARM image instead by adding `--set image.tag=arm` to your helm install command.

## Deploying with the Azure Functions Core Tools
KEDA supports autoscaling a variety of workloads which include Azure Functions and is included in their [Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools).
KEDA supports autoscaling a variety of workloads, including Azure Functions. KEDA is is included in the [Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools).

Here is how you can easily install KEDA with their CLI:
Here is how you can easily install KEDA with the Azure Functions CLI:
```
func kubernetes install --namespace keda
```

## Deploying using the deploy yaml
If you want to try KEDA on minikube or a different Kubernetes deployment without using Helm you can still deploy it with `kubectl`.
If you want to try KEDA on minikube or a different Kubernetes deployment without using Helm you can still deploy with `kubectl`.

We provide sample YAML declarations which includes our CRD - You can find them in our `/deploy` directory on our [GitHub repo](https://github.com/kedacore/keda).

Expand Down

0 comments on commit 36b42ae

Please sign in to comment.