kserve / kserve/website

docs: add canary rollout documentation for RawDeployment mode

Open
#734 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
113
Forks
193
Avg merge
5d 20h
Merged PRs (30d)
3

Description

## Summary

KServe v0.20 added canary rollout support for InferenceService in Standard (RawDeployment) mode via a new `spec.canary` field. The existing canary docs (`docs/model-serving/predictive-inference/rollout-strategies/canary.md`) explicitly state "Canary rollout strategy is only supported in serverless deployment mode" and use the old `canaryTrafficPercent` field.

## What needs to be documented

- The new `spec.canary` list field with named canary deployments
- `CanarySpec` fields: `trafficPercent` (0-100), `predictor` with required `name`
- Replica scaling: explicit `minReplicas` or derived from `trafficPercent` ratio
- Zero-restart promotion: retarget stable predictor name to canary Deployment
- Rollback by removing canary entry (orphan cleanup)
- Validation rules: Standard mode only, unique names, sum ≤ 100, no autoscaling fields
- `CanaryReady` aggregate condition and per-canary status
- Update existing canary docs to remove "serverless only" limitation note
- Example YAML showing canary definition, promotion, and rollback

## Related PR

- https://github.com/kserve/kserve/pull/5672

## Since

KServe v0.20

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with docs/model-serving/predictive-inference/rollout-strategies/canary.md and review related PR #5672 for the RawDeployment canary behavior. Document spec.canary, CanarySpec fields, scaling, promotion, rollback, validation, status conditions, and YAML examples. Done means the existing serverless-only note is corrected and the canary lifecycle is fully documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.