Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: keptn Scheduler architecture documentation #1777

Merged
merged 4 commits into from
Aug 26, 2023

Conversation

YashPimple
Copy link
Member

Relate: #770
Fixes: #1682

signed-off-by: YashPimple yashpimple22@gmail.com

@YashPimple YashPimple requested review from a team as code owners July 25, 2023 10:05
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 25, 2023
@netlify
Copy link

netlify bot commented Jul 25, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit f27644b
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64e4f90173bd9000086b6184
😎 Deploy Preview https://deploy-preview-1777--keptn-lifecycle-toolkit.netlify.app/docs/concepts/architecture/components/scheduler
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@YashPimple YashPimple changed the title Enhance: Keptn Scheduler architecture documentation docs: Keptn Scheduler architecture documentation Jul 25, 2023
@YashPimple YashPimple changed the title docs: Keptn Scheduler architecture documentation docs : Keptn Scheduler architecture documentation Jul 25, 2023
@YashPimple YashPimple changed the title docs : Keptn Scheduler architecture documentation docs: Keptn Scheduler architecture documentation Jul 25, 2023
@YashPimple YashPimple changed the title docs: Keptn Scheduler architecture documentation docs: keptn Scheduler architecture documentation Jul 25, 2023
@RealAnna
Copy link
Contributor

RealAnna commented Jul 25, 2023

Hi @YashPimple thankyou for your contribution! I added a few suggestions, the main changes needed regards the scheduling logic. The keptn scheduler implements a plugin of the default k8s scheduler, this means that it just adds our own custom logic to one step of the default scheduler logic where we wait for a specific evaluation CRD to be successful before binding pods to nodes. I would not specify in this document how all other parts work, since this would overwhelm the reader.

Copy link
Contributor

@RealAnna RealAnna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commented above

Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice start, Yash, but I think this includes a lot of information that is already present in the rest of the documentation and we don't want to be needlessly duplicating information -- it becomes a maintenance headache.

This should probably be a shorter piece that talks about how the scheduler works "under the hood", as it were. It can reference other parts of the docs that have details about the resources and some how-to instructions but should basically talk about how the scheduler processes what it finds.

@YashPimple
Copy link
Member Author

Nice start, Yash, but I think this includes a lot of information that is already present in the rest of the documentation and we don't want to be needlessly duplicating information -- it becomes a maintenance headache.

This should probably be a shorter piece that talks about how the scheduler works "under the hood", as it were. It can reference other parts of the docs that have details about the resources and some how-to instructions but should basically talk about how the scheduler processes what it finds.

Thanks for your feedback! Will keep it concise and focus on the scheduler's inner workings also avoid duplication . Looking forward to crafting a more streamlined and informative piece.
Thanks again for the guidance! 🙌

@YashPimple
Copy link
Member Author

Hi @YashPimple thankyou for your contribution! I added a few suggestions, the main changes needed regards the scheduling logic. The keptn scheduler implements a plugin of the default k8s scheduler, this means that it just adds our own custom logic to one step of the default scheduler logic where we wait for a specific evaluation CRD to be successful before binding pods to nodes. I would not specify in this document how all other parts work, since this would overwhelm the reader.

Thank you @RealAnna for your valuable feedback! I will prioritize refining the scheduling logic for the keptn scheduler plugin, while also ensuring to maintain a clear and concise explanation👍🏻

Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
@RealAnna
Copy link
Contributor

Hey @YashPimple this is great 🚀 I left a few nitpicks on some things, but I think we can merge soon 😃

Copy link
Contributor

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job, Yash!

Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
@YashPimple
Copy link
Member Author

@RealAnna @StackScribe I have resolved the changes as per suggested in the Scheduler docs. Do have a look 👍🏻

Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
@sonarcloud
Copy link

sonarcloud bot commented Aug 22, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@RealAnna RealAnna dismissed their stale review August 25, 2023 08:42

adapted according to suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation scheduler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

describe architecture of the Keptn scheduler
4 participants