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.

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

Update Deployment concept topic #12082

Open
1 of 2 tasks
steveperry-53 opened this issue Jan 4, 2019 · 36 comments
Open
1 of 2 tasks

Update Deployment concept topic #12082

steveperry-53 opened this issue Jan 4, 2019 · 36 comments
Labels
language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@steveperry-53
Copy link
Contributor

steveperry-53 commented Jan 4, 2019 •
edited by sftim
Loading

This is a...

  • Feature Request
  • Bug Report

Proposed Solution:

Study the rather long Deployment concept topic. The current topic is a mix of conceptual information and examples of specific tasks. Possibly move the task content into one or more Task topics. Then see whether the remaining conceptual content can be streamlined.

Remove any suggestion that the containerPort field causes the container to listen on a certain port. Example alternative: "Open port 80 so that the container can send and accept traffic."

Introduce the idea that a Pod has an ownerReference field. Coordinate this with #12081.

Page to Update:
https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

(edited)

Include a fact sheet for the Deployment and the Deployment controller. The fact sheet will condense the behavior of the Deployment controller into a concise set of statements about behavior, guarantees, and steady state. Use the Deployment topic as a prototype for how to write a fact sheet. Eventually, advocate for the use of fact sheets in all controller topics.

See #38682
@steveperry-53
Copy link
Contributor Author

dtornow@ and I will collaborate on this.

@thecrudge
Copy link
Contributor

@steveperry-53 Can you please provide an update on this issue?

@steveperry-53
Copy link
Contributor Author

Let's keep this open. I haven't had much time lately, but dtornow@, chenopis@, and I are still planning to do this.

@sftim
Copy link
Contributor

sftim commented May 25, 2019

a fact sheet for the Deployment and the Deployment controller

I'm aiming to cover some of this as part of updating the Controllers documentation.

@sftim
Copy link
Contributor

sftim commented Jun 14, 2019

#14861 is relevant to this too

@steveperry-53 steveperry-53 removed their assignment Jun 18, 2019
@steveperry-53
Copy link
Contributor Author

Thanks @sftim. Let me know if you'd like review or collaboration.

I'm going to unassign myself, because the reality is that I won't have time to be the driver for this one.

@sftim
Copy link
Contributor

sftim commented Jun 20, 2019 •
edited
Loading

I plan to put up a WIP PR and probably a this-might-be-OK-to-merge PR soon, to show my thinking and get feedback.

@zacharysarah
Copy link
Contributor

@sftim Awesome, thank you. Would you please coordinate your work with @shavidissa (#14861) to avoid merge conflicts?

@sftim
Copy link
Contributor

sftim commented Jul 11, 2019 •
edited
Loading

The preview PR is #15373
@shavidissa what do you think of https://deploy-preview-15373--kubernetes-io-master-staging.netlify.com/docs/concepts/workloads/deployment/?

(assuming that preview is still there!)

@shavidissa
Copy link
Contributor

Hi @sftim ,
I went over the deployment guide changes and it looks good. Nice work 🌟!

The preview PR is #15373
@shavidissa what do you think of https://deploy-preview-15373--kubernetes-io-master-staging.netlify.com/docs/concepts/workloads/deployment/?

(assuming that preview is still there!)

@sftim
Copy link
Contributor

sftim commented Jul 28, 2019

Rolling back a deployment feels like a good example of a section that belongs as a Task

@sftim
Copy link
Contributor

sftim commented Aug 17, 2019

Once I get #15733 merged I can look again at Deployment and getting my updates in.

@sftim
Copy link
Contributor

sftim commented Sep 10, 2019

/priority important-longterm

@k8s-ci-robot k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Sep 10, 2019
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 9, 2019
@sftim
Copy link
Contributor

sftim commented Dec 9, 2019

Never got round to this.
/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 9, 2019
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 8, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 7, 2020
@sftim
Copy link
Contributor

sftim commented Apr 8, 2020

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Apr 8, 2020
@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 10, 2021
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 9, 2021
@sftim
Copy link
Contributor

sftim commented Feb 10, 2021

/remove-lifecycle rotten
/lifecycle frozen

@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Feb 10, 2021
@sftim
Copy link
Contributor

sftim commented Dec 19, 2022

Issue #38540 has a narrow request on similar lines.

@sftim sftim mentioned this issue Dec 29, 2022
Open
@sftim
Copy link
Contributor

sftim commented Apr 26, 2023

Issue #40840 has a narrow request that relates to this.

@sftim sftim mentioned this issue Apr 26, 2023
Closed
@sftim
Copy link
Contributor

sftim commented Jul 24, 2023

#42152 has a narrow request that relates to this.

This was referenced Jul 24, 2023
Closed
Closed
@sftim
Copy link
Contributor

sftim commented Aug 8, 2023

#42452 has a specific request for this page, that I've adapted into a general request.

@sftim
Copy link
Contributor

sftim commented Aug 15, 2023

#42540 has a specific request that relates to this

@sftim sftim mentioned this issue Oct 23, 2023
Closed
@sftim
Copy link
Contributor

sftim commented Oct 23, 2023

Rather than remove any mention of containerPort, I'd like to improve how we explain that field.

@sftim sftim moved this from Triage Accepted to Needs Triage in SIG Docs Longterm issues Nov 6, 2023
@sftim sftim moved this from Needs Triage to Triage Accepted in SIG Docs Longterm issues Nov 6, 2023
@haripriya9647
Copy link
Contributor

/assign

@haripriya9647 haripriya9647 removed their assignment Dec 16, 2023
@sftim sftim mentioned this issue Apr 4, 2024
Closed
@sftim
Copy link
Contributor

sftim commented Apr 4, 2024

Only slightly related, but worth mentioning IMO: #45776

@sftim
Copy link
Contributor

sftim commented Apr 10, 2024

Also see #45780

@sftim sftim mentioned this issue Oct 15, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Docs Longterm issues
Status: Triage Accepted
SIG Docs k/website Board
Status: No status
Milestone
No milestone
Development

No branches or pull requests
9 participants
@zacharysarah @steveperry-53 @k8s-ci-robot @shavidissa @sftim @cody-clark @fejta-bot @thecrudge @haripriya9647