Commit Graph

3 Commits (65e4bede91fa7cd1e8b7ca31da573febdd5a23e8)

Author SHA1 Message Date
Juan Diego Palomino 6224377d87 Trying to update ReplicaSet Docs as per issue 12081 (#12409)
* First draft of the updates to the ReplicaSet Docs

To start with, I tried to cleanup the docs to adhere to the style guide https://kubernetes.io/docs/contribute/style/style-guide/. I then added some description of the ReplicaSet-Pod link via the owner reference field and behavior by it. I also made a clarification on the ReplicaSet demo where it was being redundant for the sake of demonstrating the different forms of usage. I consider this draft incomplete as I still lack knowledge of how the pod labels affect the behavior.

* Clearing up RC refs & explaining acquisition behavior

I'm beginning to address the cr by cleaning up references to the ReplicationController and making it clear that RCs are discouraged/old. I then expanded on the behavior of ReplicaSet in the presence of pods it can acquire but are not created directly by it.

* Mismatched link seems to have disappeared from preview
"As with all other Kubernetes API objects," etc... is present in the sibling  concepts/workloads/controllers/ files, so I am hesitant to change that w/o changing the others, but I did abbreviate it.

"The `.spec.template` is the only required field of the `.spec`." is false, we also need the selector

Trying to address passive voice

Cleaned up Writing a ReplicaSet Manifest section

removed How to use a ReplicaSet section as it has redundant info from the examples and Alternatives section

Expanded examples a bit

Cleared up passive voice

* refactoring link to example yaml

* adding pod-rs test case

* Addressing Steve Perry's comments

Capitalize Pod throughout.

Link is not rendering correctly. Use () instead of [] for the path.

Ending with "for the creation" seems vague to me. Maybe this:
"...reach the desired number. When a ReplicaSet needs to create new Pods, it uses its Pod template."

Suggestion: "is via the Pod's metadata.ownerReferences field." That way the reader won't jump to the incorrect conclusion that we're talking about the ReplicaSet's metadata.ownerReferences field.

with fields, including a selector that

and plans accordingly

Our style for headings is sentence case. So this heading would be "How a ReplicaSet works".

Several headings in this topic need to be converted to sentence case.

cleaned up frontend.yaml example

added example checking the Pod's owner reference being set to it's parent ReplicaSet

* Previous commit broke Pod example links due to casing

* Forgot 1 comment

Suggestion: In the ReplicaSet, .spec.template.metadata.labels must match spec.selector, or ...

* Addressing grammar/syntax errors
2019-02-06 10:09:22 -08:00
CaoShuFeng 7817e90e2f fix replicaset example (#9603) 2018-07-22 08:12:17 -07:00
Qiming b5f6df9926 Consolidate YAML files [part-8] (#9347)
* Consolidate YAML files [part-8]

This PR exacts the YAML files referenced from the following subdirs:

- docs/concepts/workloads
- docs/concepts/configuration
- docs/concepts/policy

The following problems are fixed:

- docs/concepts/workloads/controllers/ doesnt have a 'cronjob.yaml for
  test
- the exactly same `pod.yaml` was used in both the task/config-pod-container
  topic and the concepts/configuration topics.

* Update examples_test.go

* Add missing yaml file.
2018-07-02 17:35:20 -07:00