Skip to content

Document deployment.kubernetes.io/* annotations #53891

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.

Sign up for GitHub

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

Jump to bottom
Open
pmady wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document deployment.kubernetes.io/* annotations #53891

pmady wants to merge 1 commit into from

Conversation

@pmady
Copy link

@pmady pmady commented Jan 2, 2026

Add documentation for three annotations used by the Deployment controller on ReplicaSets:

  • deployment.kubernetes.io/desired-replicas: Tracks desired replica count
  • deployment.kubernetes.io/max-replicas: Tracks max replicas during rolling updates
  • deployment.kubernetes.io/revision: Tracks deployment revision for rollout history

These annotations are internal to the Deployment API implementation and are used to manage rolling updates, scaling operations, and rollback functionality.

Fixes #53890

Description

Issue

Closes: #

@k8s-ci-robot k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 2, 2026
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jan 2, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sayakmukhopadhyay for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 2, 2026
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jan 2, 2026

Welcome @pmady!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 2, 2026
@netlify
Copy link

netlify bot commented Jan 2, 2026 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 468127b
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/695d5de7d2196e00080c0aef
😎 Deploy Preview https://deploy-preview-53891--kubernetes-io-main-staging.netlify.app
📱 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 project configuration.

lmktfy
lmktfy reviewed Jan 6, 2026
View reviewed changes
Copy link
Member

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Content LGTM; the commit message needs amending though.

@pmady pmady force-pushed the add-deployment-annotations branch from 860178a to 2880a43 Compare January 6, 2026 19:06
@pmady
content: document deployment.kubernetes.io/* annotations
468127b 
Add documentation for three annotations used by the Deployment controller
on ReplicaSets:

- deployment.kubernetes.io/desired-replicas: Tracks desired replica count
- deployment.kubernetes.io/max-replicas: Tracks max replicas during rolling updates
- deployment.kubernetes.io/revision: Tracks deployment revision for rollout history

These annotations are internal to the Deployment API implementation and are
used to manage rolling updates, scaling operations, and rollback functionality.

Signed-off-by: pmady <[email protected]>
@pmady pmady force-pushed the add-deployment-annotations branch from 2880a43 to 468127b Compare January 6, 2026 19:09
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 6, 2026
@pmady
Copy link
Author

pmady commented Jan 6, 2026

@lmktfy Updated commit message

@pmady pmady requested a review from lmktfy January 7, 2026 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@katcosgrove katcosgrove Awaiting requested review from katcosgrove

@lmktfy lmktfy Awaiting requested review from lmktfy

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document deployment.kubernetes.io/* annotations

3 participants

@pmady @k8s-ci-robot @lmktfy