Add formal definition of workloads #11302
Conversation
k8s-ci-robot
added
size/XS
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit b42c246 https://deploy-preview-11302--kubernetes-io-master-staging.netlify.com |
There was a problem hiding this comment.
The issue is a good catch, but this isn't quite the right solution. A better place for this definition is in the glossary, as the comment in the original issue suggests. In its present proposed location, it lays out oddly on the page, and duplicates material better explained elsewhere in the concepts section.
When you create the glossary entry, consider also editing the language a bit. Workloads themselves aren't K8s objects -- "workload" is a framing term to refer to a set of APIs/resources/objects, but it's not in and of itself an object. The top-level concept topic does a good job of referring to workloads in this more abstract way -- you might get some ideas from it.
|
/hold |
k8s-ci-robot
added
the
do-not-merge/hold
|
@RA489 What do you think of @Bradamant3 's suggestions? We appreciate the contribution and definitely want to include it! |
|
@zparnold sure, i will include it |
k8s-ci-robot
added
size/S
|
@Bradamant3 @zparnold updated as per suggestion. PTAL |
|
@Bradamant3 could you please take a look at the updates made to this PR. |
|
@zparnold @Bradamant3 could you please review this PR. |
There was a problem hiding this comment.
@RA489 apologies for the tardy re-review, especially since a fair amount still needs to be fixed. This isn't easy stuff to write about -- thank you for tackling it, and I'll do my best to stay on top of additional commits.
| short_description: > | ||
| A set of applications for processing information to serve a purpose that is valuable to a single user or group of users. | ||
| A workload is a framing term to refer to a set of APIs/resources/objects. |
There was a problem hiding this comment.
Sorry, I used "framing term" as a way of redirecting the conversation. It wasn't meant as the language for the glossary entry. See the API refdocs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#
And you might want to explore the language of workloads elsewhere in the docs a bit further too.
| Workload is a framing term to refer to a set of APIs/resources/objects. Kubernetes performs the | ||
| deployment and updates the workload with the current state of the application. Workloads let you define the | ||
| rules for application scheduling, scaling, and upgrade. | ||
| Workloads includes the Daemon Sets, Deployments, Jobs, Pods, Replica Sets, Replication Controllers, Stateful Sets. |
There was a problem hiding this comment.
s/includes/include
s/Daemon Sets/DaemonSet
s/Replica Sets/ReplicaSet
s/Replication Controllers/ReplicationController
s/Stateful Sets/StatefulSet
If you're going this far, suggest adding the rest of the list. Or remove the list altogether.
It's also really not true that workload objects define rules for application scheduling, etc ... yes, scheduling happens to workload objects, but this wording is misleading. (Same holds true for scaling and upgrade)
|
@Bradamant3 thanks for the review. |
|
@Bradamant3 PTAL. |
More section should not repeat short description. Both are served together on the built page.
k8s-ci-robot
added
the
sig/docs
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Bradamant3 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
* Add formal definition of workloads * Update workload.md * add light copyedit More section should not repeat short description. Both are served together on the built page.
Adding the formal definition of workloads
fixes #11285