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

Reduce doc bloat & prep work for remediation wizard #2968

Merged
merged 6 commits into from
Apr 22, 2024
Merged
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

This file was deleted.

This file was deleted.

33 changes: 33 additions & 0 deletions guides/common/modules/proc_remediating-compliance-failures.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[id="remediating-compliance-failures_{context}"]
= Remediating compliance failures

You can examine compliance reports and, in some cases, remediate cases of non-compliance.
asteflova marked this conversation as resolved.
Show resolved Hide resolved

[WARNING]
====
Always test the recommended remedial actions or scripts in a non-production environment before implementing them in production.
Remediation might render the system non-functional.
====

.Prerequisites
* Your user account has a role assigned that has the `view_arf_reports` and `view_hosts` permissions.

.Procedure
To examine a simplified compliance policy report:
asteflova marked this conversation as resolved.
Show resolved Hide resolved

. In the {ProjectWebUI}, navigate to *Hosts* > *Compliance* > *Reports*.
. In the *Reported At* column, click the time link of the report you want to examine.
{Project} displays a simplified list of policy rules with the results of the scan.

To examine a full compliance policy report and remediate compliance failures manually:
asteflova marked this conversation as resolved.
Show resolved Hide resolved

. In the {ProjectWebUI}, navigate to *Hosts* > *Compliance* > *Reports* to list all compliance reports.
. In the *Actions* column, click *Full Report*.
{Project} displays the complete details of an evaluation report.
. In the *Rule Overview* section, click the title of a rule in the *Title* column to inspect further result details.
. Click *Remediation Shell script*, *Remediation Ansible snippet*, *Remediation Puppet snippet*, or *Remediation Anaconda snippet* to display remediation advice.
Remediation scripts and snippets are not available for all compliance rules.

.Additional resources
* You can apply the remediation script or snippet by using a remote job.
For more information, see {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote_Jobs_managing-hosts[Configuring and setting up remote jobs] in _{ManagingHostsDocTitle}_.
4 changes: 1 addition & 3 deletions guides/doc-Managing_Security_Compliance/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,7 @@ include::common/modules/con_compliance-email-notifications.adoc[leveloffset=+2]

include::common/modules/proc_viewing-compliance-policy-statistics.adoc[leveloffset=+2]

include::common/modules/proc_examining-hosts-per-rule-compliance-result.adoc[leveloffset=+2]

include::common/modules/proc_examining-compliance-failures-of-a-host.adoc[leveloffset=+2]
include::common/modules/proc_remediating-compliance-failures.adoc[leveloffset=+2]

include::common/modules/proc_deleting-a-compliance-report.adoc[leveloffset=+2]

Expand Down