Adding design doc #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arschles
requested review from
ahmelsayed,
tomkerkhove and
zroubalik
as code owners
tomkerkhove
reviewed
Feb 2, 2021
docs/design.md
Outdated
|
|
||
| ## Architecture Diagram | ||
|
|
||
| Below is a complete architecture diagram. |
There was a problem hiding this comment.
It is missing, is this on purpose?
There was a problem hiding this comment.
Yup, I forgot to mark this as WIP - sorry about that 😄
docs/design.md
Outdated
|
|
||
| There are three major components in this system. You can find more detail and discussion about each in sections below this one. | ||
|
|
||
| - [Operator](./operator) - This component listens for events related to `HTTPScaledObject`s and creates, updates or removes internal machinery as appropriate. |
docs/design.md
Outdated
|
|
||
| - [Operator](./operator) - This component listens for events related to `HTTPScaledObject`s and creates, updates or removes internal machinery as appropriate. | ||
| - [Interceptor](./interceptor) - This component accepts and routes external HTTP traffic to the appropriate internal application, as appropriate. | ||
| - [Scaler](./scaler) - This component tracks the size of the pending HTTP request queue for a given app and reports it to KEDA. It acts as an [external scaler](https://keda.sh/docs/2.1/scalers/external-push/). |
docs/design.md
Outdated
| There are three major components in this system. You can find more detail and discussion about each in sections below this one. | ||
|
|
||
| - [Operator](./operator) - This component listens for events related to `HTTPScaledObject`s and creates, updates or removes internal machinery as appropriate. | ||
| - [Interceptor](./interceptor) - This component accepts and routes external HTTP traffic to the appropriate internal application, as appropriate. |
docs/design.md
Outdated
|
|
||
| We've introduced a new [Custom Resource (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) called `HTTPScaledObject.http.keda.sh` - `HTTPScaledObject` for short. Fundamentally, this resource allows an application developer to submit their HTTP-based application name and container image to the system, and have the system deploy all the necessary internal machinery required to deploy their HTTP application and expose it to the public internet. | ||
|
|
||
| The [operator](./operator) runs inside the Kubernetes namespace to which they're deploying their application and watches for these `HTTPScaledObject` resources. When one is created, it will create a `Deployment` and `Service` for the app, interceptor, and scaler, and a [`ScaledObject`](https://keda.sh/docs/2.1/concepts/scaling-deployments/) which KEDA then uses to scale the application. |
There was a problem hiding this comment.
it will create a
DeploymentandServicefor the app
We might want to check this once it gets more ready for release because I'm not sure if that should be our responsibility where, instead, we could just scale a deployment that is provided to 0 (similar to core KEDA)
There was a problem hiding this comment.
I agree regarding both use cases, I think they cover two different types of users. I created #35 to track that feature.
2 tasks
arschles
force-pushed
the
design-doc
branch
2 times, most recently
from
625c625
to
e28dcdb
Compare
|
@tomkerkhove @zroubalik I've made updates that you requested. Can you take another loook? (the DCO violation is because I committed a suggested fix and apparently GitHub doesn't sign those by default) |
|
LGTM, @tomkerkhove wdyt? |
tomkerkhove
approved these changes
Feb 3, 2021
Fixes kedacore#18 Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've added a design document and linked to it from the README
Checklist
Fixes #18