OSDOCS-16945# CQA work Stor1 - understanding ephemeral storage#106594
OSDOCS-16945# CQA work Stor1 - understanding ephemeral storage#106594lpettyjo wants to merge 1 commit into
Conversation
openshift-ci
Bot
added
the
size/M
lpettyjo
added
branch/enterprise-4.16
branch/enterprise-4.17
branch/enterprise-4.18
branch/enterprise-4.19
branch/enterprise-4.20
branch/enterprise-4.21
branch/enterprise-4.22
and removed
size/M
lpettyjo
added
the
merge-review-needed
bscott-rh
added
merge-review-in-progress
bscott-rh
removed
the
merge-review-in-progress
lpettyjo
force-pushed
the
OSDOCS-16945-understanding-ephemeral-storage
branch
from
87a808d to
a418def
Compare
openshift-merge-robot
added
the
needs-rebase
openshift-ci
Bot
added
the
size/L
lpettyjo
force-pushed
the
OSDOCS-16945-understanding-ephemeral-storage
branch
from
a418def to
7110f36
Compare
openshift-merge-robot
removed
the
needs-rebase
lpettyjo
changed the title
|
The This is because your PR targets the If the update in your PR does NOT apply to version 5.0 onward, please re-target this PR to go directly into the appropriate |
lpettyjo
force-pushed
the
OSDOCS-16945-understanding-ephemeral-storage
branch
from
7110f36 to
b2b9030
Compare
|
@lpettyjo: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
| //* microshift_storage/understanding-ephemeral-storage-microshift.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id=storage-ephemeral-storage-manage-config-and-eviction_{context}] |
There was a problem hiding this comment.
Has this been added to a MiroShift assembly understanding-ephemeral-storage-microshift)?
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id=storage-ephemeral-storage-manage-requests-and-limits_{context}] | ||
| = Ephemeral storage management limits and requests |
There was a problem hiding this comment.
I do not understand the microshift docs that well. Would you be OK to provide a direct link to this module in the MShift docs?
| = Ephemeral storage management limits and requests | ||
|
|
||
| [role="_abstract"] | ||
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus emptyDir volumes, enabling proper scheduling and preventing pods from exhausting node storage. |
There was a problem hiding this comment.
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus emptyDir volumes, enabling proper scheduling and preventing pods from exhausting node storage. | |
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus `emptyDir` volumes, enabling proper scheduling and preventing pods from exhausting node storage. |
Unless lowercase k is correct?
There was a problem hiding this comment.
re: lowercase k - there are a few of these, and it looks like it was that way in existing content. If it's an existing issue probably makes sense to fix as a docs bug broadly.
| For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. | ||
|
|
||
| Ephemeral storage limits and requests units:: | ||
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus emptyDir volumes, enabling proper scheduling and preventing pods from exhausting node storage. |
There was a problem hiding this comment.
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus emptyDir volumes, enabling proper scheduling and preventing pods from exhausting node storage. | |
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus `emptyDir` volumes, enabling proper scheduling and preventing pods from exhausting node storage. |
|
|
||
| [role="_abstract"] | ||
| To manage temporary data that exists only for the duration of a workload, review the properties of ephemeral storage. | ||
| Ephemeral storage provides temporary per-pod storage for scratch data, caches, and logs that do not need to persist beyond the pod's lifetime. Understanding the different ephemeral storage types and their resource management helps you choose the right option for stateless workloads while preventing node storage exhaustion. |
There was a problem hiding this comment.
| Ephemeral storage provides temporary per-pod storage for scratch data, caches, and logs that do not need to persist beyond the pod's lifetime. Understanding the different ephemeral storage types and their resource management helps you choose the right option for stateless workloads while preventing node storage exhaustion. | |
| Ephemeral storage provides temporary per-pod storage for scratch data, caches, and logs that do not need to persist beyond the pod's lifetime. By understanding the different ephemeral storage types and their resource management, you can choose the right option for stateless workloads while preventing node storage exhaustion. |
Removes anthrophomorphism.
There was a problem hiding this comment.
SMEs review might be needed for these abstracts if they are new.
|
|
||
| ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] | ||
| [id="additional-resources_{context}"] | ||
| == Additional resources |
There was a problem hiding this comment.
Should the first add resources be of the format?
[role="additional-resources"]
[id="additional-resources{context}"]
== Additional resources
There was a problem hiding this comment.
[role="additional-resources"]
[id="additional-resources_{context}"]
== Additional resources
Is only for the assembly-level AR section that comes at the very end of the assembly. It is never valid at any other location.
| * Each container requests 2GiB of local ephemeral storage. | ||
| * Each container has a limit of 4GiB of local ephemeral storage. | ||
| * At the pod level, kubelet works out an overall pod storage limit by adding up the limits of all the containers in that pod. | ||
| ** In this case, the total storage usage at the pod level is the sum of the disk usage from all containers plus the pod's `emptyDir` volumes. |
There was a problem hiding this comment.
| ** In this case, the total storage usage at the pod level is the sum of the disk usage from all containers plus the pod's `emptyDir` volumes. | |
| ** In this case, the total storage usage at the pod level is the sum of the disk usage from all containers plus the `emptyDir` volumes of a pod. |
IBM gets hung up on possessives.
| To provision ephemeral local storage, you can create the primary partition by using either root or runtime methods. This storage is always made available in the primary partition, providing temporary space for your workloads. | ||
|
|
||
| == Root | ||
| * *Root*: This partition holds the kubelet root directory, `/var/lib/kubelet/` by default, and `/var/log/` directory. This partition can be shared between user pods, the operating system, and Kubernetes system daemons. This partition can be consumed by pods through `EmptyDir` volumes, container logs, image layers, and container-writable layers. Kubelet manages shared access and isolation of this partition. This partition is ephemeral, and applications cannot expect any performance SLAs, such as disk IOPS, from this partition. |
There was a problem hiding this comment.
I'd recommend a description list instead of manually formatting an unordered list with bold and colons
|
|
||
| [role="_abstract"] | ||
| To manage local storage for stateless applications, use ephemeral storage. Ephemeral storage is designed for the transient nature of pods and containers. You can use this feature to handle operations that require storage only for the duration of the lifecycle for the workload. Both developers and administrators can use the feature. | ||
| To manage local storage for stateless applications, use ephemeral storage. Ephemeral storage is designed for the transient nature of pods and containers. You can use this feature to handle operations that require storage only for the duration of the lifecycle for the workload. Pods use ephemeral local storage for scratch space, caching, and logs. Both developers and administrators can use the feature. |
There was a problem hiding this comment.
This needs to be shorter (50-300 char for short descs). I know that seems nitpicky, but AEM enforces the character limit and will not let you save a topic if the short desc outside that count.
|
|
||
| [role="_abstract"] | ||
| To monitor ephemeral storage usage, use the `/bin/df` utility. By using this tool, you can track disk space consumption on the volumes where ephemeral container data resides, specifically `/var/lib/kubelet` and `/var/lib/containers`. | ||
| Monitor ephemeral storage usage with the `/bin/df` utility. By using this tool, you can track disk space consumption on the volumes where ephemeral container data resides, specifically `/var/lib/kubelet` and `/var/lib/containers`, preventing pod evictions from storage exhaustion. Regular monitoring helps you identify storage-hungry workloads and adjust requests and limits before kubelet evicts pods. |
There was a problem hiding this comment.
Also too long (~400 char)
| = Ephemeral storage management limits and requests | ||
|
|
||
| [role="_abstract"] | ||
| Limits and requests for ephemeral storage are measured in byte quantities. You can express storage as a plain integer or as a fixed-point number by using one of these suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. For example, the following quantities all represent approximately the same value: 128974848, 129e6, 129M, and 123Mi. Pod-level limits aggregate all container limits plus emptyDir volumes, enabling proper scheduling and preventing pods from exhausting node storage. |
There was a problem hiding this comment.
This is also too long. When rewriting:
Avoid granular detail and reorient on user value (why they care about this). The specifics should be in the body, this should focus on why the user is here (think of it as information that you would see in a search blurb and go "aha! that's me, that's my question")
| //* storage/understanding-ephemeral-storage.adoc | ||
| //* microshift_storage/understanding-ephemeral-storage-microshift.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT |
There was a problem hiding this comment.
Would type this as ref
| :toc: | ||
| :toc-title: | ||
| :context: understanding-ephemeral-storage | ||
|
|
||
| toc::[] |
There was a problem hiding this comment.
I'm not familiar with this construct
:toc:
:toc-title:
I don't follow why it would change from toc::[].
I'm not saying I'm right, just that it made me scratch my head 😂 If you can point me at a resource about this I would appreciate it so that I understand 🤓
There was a problem hiding this comment.
Confused about how this stacks with modules/storage-ephemeral-storage-manage.adoc.
Ephemeral storage configuration effects pod scheduling and eviction:
In the old module, this section is entirely excluded for MS. In this new module, only the bullets are excluded.
Ephemeral storage configuration effects pod eviction:
This is included for MS in both the original module and this one.
Also echoing Darragh's question about inclusion of the module
I'm also a bit confused about what this gets around. IIUC, you were making this module because you had to get rid of the == headings in the old module, is that right? But this module also adds an == heading anyway.
| * `spec.containers[].resources.requests.ephemeral-storage` | ||
|
|
||
| [id=storage-ephemeral-storage-limits-requests-units_{context}] | ||
| == Ephemeral storage limits and requests units |
There was a problem hiding this comment.
TBH, I am also confused why you were told to get rid of the == headings at all. The mod docs guidelines have them for concepts:
7 participants
Version(s): 4.20+
Issue: https://issues.redhat.com/browse/OSDOCS-16945
Link to docs preview:
QE review:
Additional information: