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

[OCPBUGS-42396]Add variable reference for resource_requests_limits rules #12987

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+80 −1
Open

[OCPBUGS-42396]Add variable reference for resource_requests_limits rules #12987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions applications/openshift/general/resource_requests_limits_in_daemonset/rule.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,31 @@ description: |-
for a container to use more resource than its request for that resource specifies.
However, a container is not allowed to use more than its resource limit.

<p>
To exempt a namespace with no resource requests/limits allocated in the daemonsets, the variable
{{.var_daemonset_limit_namespaces_exempt_regex}} is being flagged.
Namespaces matching the variable <tt>ocp4-var-daemonset-limit-namespaces-exempt-regex</tt> regex
are excluded from this check.
An example allowing an SCC named <tt>additional</tt> follows:
</p>
<pre>
apiVersion: compliance.openshift.io/v1alpha1
kind: TailoredProfile
metadata:
name: moderate-exempt-reource-request-limits
spec:
description: Allows an additional scc
setValues:
- name: ocp4-var-daemonset-limit-namespaces-exempt-regex
rationale: set the value to namespaces to be exempted
value: "test1|test2"
extends: ocp4-moderate
title: Modified moderate to exempt a namespace with no resource requests/limits in daemonset
</pre>
<p>
Finally, reference this <tt>TailoredProfile</tt> in a <tt>ScanSettingBinding</tt>
</p>

# todo : better if we can keep openshift document link for this reference,

rationale: |-
Expand Down
31 changes: 30 additions & 1 deletion applications/openshift/general/resource_requests_limits_in_deployment/rule.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,36 @@ description: |-
for a container to use more resource than its request for that resource specifies.
However, a container is not allowed to use more than its resource limit.

# todo : better if we can keep openshift document link for this reference,
<p>
To exempt a namespace with no resource requests/limits allocated in the one or more deployments, the variable
{{.var_deployment_limit_namespaces_exempt_regex}} is being flagged.
Namespaces matching the variable <tt>ocp4-var-deployment-limit-namespaces-exempt-regex</tt> regex
are excluded from this check.
An example allowing an SCC named <tt>additional</tt> follows:
</p>
<pre>
apiVersion: compliance.openshift.io/v1alpha1
kind: TailoredProfile
metadata:
name: moderate-exempt-reource-request-limits
spec:
description: Allows an additional scc
setValues:
- name: ocp4-var-deployment-limit-namespaces-exempt-regex
rationale: set the value to namespaces to be exempted
value: "test1|test2"
extends: ocp4-moderate
title: Modified moderate to exempt a namespace with no resource requests/limits in deployment
</pre>
<p>
Finally, reference this <tt>TailoredProfile</tt> in a <tt>ScanSettingBinding</tt>
</p>

<p>
To configure resource requests/limits for a deployement, follow the directions in
{{{ weblink(link="https://docs.openshift.com/container-platform/latest/applications/deployments/managing-deployment-processes.html#deployments-setting-resources_deployment-operations",
text="the documentation") }}}
</p>

rationale: |-
Resource requests/limits provide constraints that limit aggregate resource consumption
Expand Down
25 changes: 25 additions & 0 deletions applications/openshift/general/resource_requests_limits_in_statefulset/rule.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,31 @@ description: |-
for a container to use more resource than its request for that resource specifies.
However, a container is not allowed to use more than its resource limit.

<p>
To exempt a namespace with no resource requests/limits allocated in the one or more statefulsets, the variable
{{.var_statefulset_limit_namespaces_exempt_regex}} is being flagged.
Namespaces matching the variable <tt>ocp4-var-statefulset-limit-namespaces-exempt-regex</tt> regex
are excluded from this check.
An example allowing an SCC named <tt>additional</tt> follows:
</p>
<pre>
apiVersion: compliance.openshift.io/v1alpha1
kind: TailoredProfile
metadata:
name: moderate-exempt-reource-request-limits
spec:
description: Allows an additional scc
setValues:
- name: ocp4-var-statefulset-limit-namespaces-exempt-regex
rationale: set the value to namespaces to be exempted
value: "test1|test2"
extends: ocp4-moderate
title: Modified moderate to exempt a namespace with no resource requests/limits in statefulset
</pre>
<p>
Finally, reference this <tt>TailoredProfile</tt> in a <tt>ScanSettingBinding</tt>
</p>

# todo : better if we can keep openshift document link for this reference,

rationale: |-
Expand Down
Loading