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

https://issues.redhat.com/browse/ACM-14244 #7208

Open
wants to merge 1 commit into
base: 2.12_stage
Choose a base branch
from
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions troubleshooting/main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ include::trouble_submariner_general.adoc[leveloffset=+2]
include::trouble_submariner_degraded.adoc[leveloffset=+2]
include::trouble_restore_status.adoc[leveloffset=+2]
include::trouble_policy_templates.adoc[leveloffset=+2]
include::trouble_policy_addon_crash.adoc[leveloffset=+2]
35 changes: 35 additions & 0 deletions troubleshooting/trouble_policy_addon_crash.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[#grc-policy-framework-pod-crash]
= Troubleshooting _governance-policy-framework-addon_ pod on managed clusters

The `governance-policy-framework-addon` pod crashes on managed clusters.

[#symptom-grc-policy-framework-pod]
== Symptom: Troubleshooting _governance-policy-framework-addon_ pod on managed clusters

When you run out of memory because there are too many policy events created from continuous compliance changes, the `governance-policy-framework-addon` pod crashes.

You might receive the following pod status:

[source,bash]
----
OOMKilled
----

[#resolving-grc-policy-framework-pod]
== Resolving the problem: Troubleshooting _governance-policy-framework-addon_ pod on managed clusters

To resolve this error, you must reduce the cached memory for the pod. Complete the following steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like this documentation is talking about the implementation details of the code change that reduced the cache size. We should not be mentioning code things like this in the documentation.

I'll let @gparvin relay what his intentions were with the Jira.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To resolve the issue can we just link to the Known Issue? That way we aren't managing the same content twice? I think the known issue has the correct steps to resolve the problem, the user shouldn't try to reduce memory in other ways. Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which known issue?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


. To reduce the memory cache for the fields to the bare minimum value, run the following command:

+
[source,bash]
----
func TransformStripManagedFields() toolscache.TransformFunc
----
//whats the minimum version?

. Limit the events that are cached by configuring your policy controllers to send events with a label that denotes it as a status update. The `status-sync` controller uses the label selector to watch API request.
//is there an example of the configuration?

//is there a verification step to make sure the policy events are no longer cached?
Loading