Skip to content

docs: progressive rollout blog #272

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

Merged
merged 6 commits into from
May 27, 2025
Merged

docs: progressive rollout blog #272

merged 6 commits into from
May 27, 2025

Conversation

ChunyiLyu
Copy link
Member

@ChunyiLyu ChunyiLyu commented May 22, 2025

Description

This relates to issue # #263

Checklist

  • Is this PR about a feature in an upcoming SKE release?
  • Have you cut that new SKE release?
  • Have you updated the release notes?

@ChunyiLyu ChunyiLyu marked this pull request as draft May 22, 2025 11:11
@ChunyiLyu ChunyiLyu changed the title docs: wip draft rollout blog docs: progressive rollout blog May 22, 2025
@ChunyiLyu ChunyiLyu marked this pull request as ready for review May 22, 2025 14:05
@@ -2,8 +2,8 @@
slug: healthcheck-progressive-rollout
title: Kratix, healthcheck, and upgrade
Copy link
Member

Choose a reason for hiding this comment

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

We should maybe ask for a review from Daniel or NT for a buzzier title.

Copy link
Member

Choose a reason for hiding this comment

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

Some nifty options from ChatGPT:
🚀 Feature-Focused
1. “Safer Rollouts with Kratix: Introducing Health Checks for Smarter Updates”
2. “Progressive Rollouts Made Easy: Health Checks Now in Kratix”
3. “New in Kratix: Resource Health Checks for Controlled Deployments”

🔍 Problem-Solution Framing
4. “Taming Risky Upgrades: How Kratix Health Checks Enable Safer Rollouts”
5. “Avoiding All-at-Once Chaos: Progressive Rollouts with Kratix Health Checks”
6. “From Outages to Orchestration: The Power of Health Checks in Kratix”

🧠 Thought Leadership / Technical Insight
7. “Orchestrating Reliability: Using Kratix Health Checks for Progressive Delivery”
8. “Promise Smarter: How Health Checks Enable Intelligent Rollouts in Kratix”
9. “Evolving the Promise: Safer Upgrades with Kratix Health Checks”

🧩 Catchy & Playful
10. “One Promise at a Time: How Kratix Health Checks Unlock Progressive Delivery”
11. “No More Rollout Roulette: Kratix Gets Health Smart”
12. “Kratix Gets a Health Boost—And So Do Your Workloads”

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks Cat! Discussed with NT and settled on "New in Kratix: Health Checks and Progressive Rollout"

@ChunyiLyu ChunyiLyu force-pushed the progressive-rollout-blog branch from 2e67b62 to c3f4471 Compare May 27, 2025 10:24
@ChunyiLyu ChunyiLyu force-pushed the progressive-rollout-blog branch from c3f4471 to 256622a Compare May 27, 2025 10:26
Copy link
Member

@aclevername aclevername left a comment

Choose a reason for hiding this comment

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

few comments

Comment on lines +65 to +70
With Health Checks enabled and set up in your Platform and Destinations, when you update the Promise:
1. Kratix begins updating resource requests
1. One of the Resource Configure workflow acquires the Lease
1. Lease is only released after Health checks report a healthy status, ensuring Resources are upgraded one by one
1. When there's a failed upgrade, Lease are never released and rollout is paused and the failed state is visible in the resource request status
1. Kratix continues upgrading Resources one by one until all of them are upgraded and reported healthy
Copy link
Member

Choose a reason for hiding this comment

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

is this our long term recommendation, or a place holder until we implement this ourselves?

Copy link
Member Author

Choose a reason for hiding this comment

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

More of a placeholder to see if we get interest and attraction.

Copy link
Member

Choose a reason for hiding this comment

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

Worth adding a note on that? The impl might seem bit too "hard" as it if they think they have to support this manually for the long term. for short/medium term seems reasonable

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't want to add a disclaimer to make it sounds like it we are discrediting what we are blogging. At the end of the blog, we do say that we're looking for feedback and working on improvement. I think if people find it too hard, they are welcomed to give us that feedback which serves the purpose of this blog.

Here’s how it works:

You include an additional pipeline stage as part of your Promise resource configure workflow configuration.
This container outputs [HealthDefinition](/ske/api-reference/healthdefinition), which contains structured instructions on how to perform health checks in the Destination.
Copy link
Member

Choose a reason for hiding this comment

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

is the HealthDefintions page supposed to be part of SKE docs, not oss?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. Health definition is reconciled by SKE k8s health agent. Its reference page only lives in under SKE.

Copy link
Member

Choose a reason for hiding this comment

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

but we say it can be reocnciled by your own in the OSS world? seems slightly conflicting

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the placement of the documentation is related to where the controller lives.
For example, Health Record is documented in OSS: https://docs.kratix.io/main/reference/healthrecord, because it is reconciled by kratix. Health Definition is documented in SKE, because it's reconciled by a SKE agent.

@ChunyiLyu ChunyiLyu force-pushed the progressive-rollout-blog branch from b561f00 to d62d85e Compare May 27, 2025 14:10
@ChunyiLyu ChunyiLyu merged commit 88419dd into main May 27, 2025
1 check passed
@ChunyiLyu ChunyiLyu deleted the progressive-rollout-blog branch May 27, 2025 15:09
kirederik pushed a commit that referenced this pull request May 27, 2025
* docs: wip draft rollout blog

* chore: derik's feedback

* blog: cats feedback

* chore: jakes feedback

* chore: a new title

* chore: add derik to the greatness
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants