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.

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

Modify rule S6897: Add examples for LimitRange #4018

Merged
merged 1 commit into from
Jun 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions rules/S6897/kubernetes/rule.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ might crash, causing downtime for all containers running on that node.

=== Code examples

To avoid potential issues, specify a storage request for each container using ephemeral storage with `resources.requests.ephemeral-storage`.
To avoid potential issues, specify a storage request for each container using ephemeral storage with `resources.requests.ephemeral-storage`,
or create a `LimitRange` resource, that sets a default storage request for all containers in all pod specifications belonging to the same namespace.

==== Noncompliant code example

Expand All @@ -52,6 +53,21 @@ spec:
mountPath: "/tmp"
----

[source,yaml,diff-id=2,diff-type=noncompliant]
----
apiVersion: v1
kind: Pod
metadata:
name: example
spec:
containers:
- name: web # Noncompliant
image: nginx
volumeMounts:
- name: ephemeral
mountPath: "/tmp"
----

==== Compliant solution

[source,yaml,diff-id=1,diff-type=compliant]
Expand All @@ -72,10 +88,38 @@ spec:
mountPath: "/tmp"
----

[source,yaml,diff-id=2,diff-type=compliant]
----
apiVersion: v1
kind: LimitRange
metadata:
name: storage-limit-range
namespace: namespace-with-limit-range
spec:
limits:
- defaultRequest:
ephemeral-storage: "10Mi"
type: Container
---
apiVersion: v1
kind: Pod
metadata:
name: example
namespace: namespace-with-limit-range
spec:
containers:
- name: web
image: nginx
volumeMounts:
- name: ephemeral
mountPath: "/tmp"
----

=== How does this work?

You can set a request through the property `resources.requests.ephemeral-storage` of a
container. Alternatively, you can set a default request for a namespace with `LimitRange`.
container. Alternatively, you can set a default request for a namespace with `LimitRange`
through `spec.limits[].defaultRequest.ephemeral-storage`.

== Resources

Expand Down