Skip to content

Commit 7e7e66d

Browse files
committed
Editing controller files for DITA (ansible#3864)
Configuring automation execution modular compliance chapter 7 https://issues.redhat.com/browse/AAP-46724 Affects `titles/controller-admin-guide`
1 parent 511d568 commit 7e7e66d

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

downstream/assemblies/platform/assembly-controller-pac.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Policy enforcement at automation runtime is a feature that uses encoded rules to
1818

1919
OPA, or link:https://www.openpolicyagent.org/docs/latest/[Open Policy Agent], is a policy engine that offloads policy decisions from your Ansible instance. When it is triggered, the policy enforcement feature connects to OPA to retrieve policies specified in your configuration, and applies policy rules to your automation content. If OPA detects a policy violation, it will stop the action and give your user information about the policy violation.
2020

21-
.Prerequisites
21+
*Prerequisites*
2222

2323
Before you can implement policy enforcement in your {PlatformNameShort} instance, you must have:
2424

@@ -27,7 +27,8 @@ Before you can implement policy enforcement in your {PlatformNameShort} instance
2727
* Configured {PlatformNameShort} with settings required for authenticating to your OPA server.
2828
* Some familiarity with OPA and the Rego language, which is the language policies are written in.
2929
30-
For policy enforcement to work correctly, you must both configure the OPA server in your policy settings, and associate a specific policy with a particular resource (for example, a particular organization, inventory, or job template).
30+
For policy enforcement to work correctly, you must both configure the OPA server in your policy settings, and associate a specific policy with a particular resource.
31+
For example, a particular organization, inventory, or job template.
3132

3233
[NOTE]
3334
====
@@ -49,4 +50,3 @@ include::platform/proc-pac-add-policy-to-inventory.adoc[leveloffset=+2]
4950
include::platform/proc-pac-add-policy-to-template.adoc[leveloffset=+2]
5051

5152
include::platform/ref-pac-inputs-outputs.adoc[leveloffset=+1]
52-

downstream/modules/platform/proc-configure-pac-settings.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ OPA custom authentication header:: Enter a custom header to append to request he
3030
OPA request timeout:: Enter the number of seconds until the connection times out.
3131
OPA request retry count:: Enter a figure for the number of times a request can attempt to connect to the OPA service before failing.
3232
+
33-
. Depending on your authentication type, you may need to fill out the following fields.
33+
. Depending on your authentication type, you might need to fill out the following fields.
3434
.. If you selected Token as your authentication type:
3535
+
3636
OPA authentication token:: Enter the OPA authentication token.
@@ -43,4 +43,4 @@ OPA CA certificate content:: Enter the content of the CA certificate for mTLS au
4343
+
4444
. Beneath the heading labeled *Options*:
4545
Use SSL for OPA connection:: Check this box to enable an SSL connection to the OPA service.
46-
. Click btn:[Save policy settings].
46+
. Click btn:[Save policy settings].

downstream/modules/platform/ref-pac-inputs-outputs.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Information about the user who launched the job, including:
114114

115115
* `id` (integer): the user's unique identifier
116116
* `name` (string): the user name
117-
* `type` (type): the user type (for example, `user`, `system`, etc)
117+
* `type` (type): the user type (for example, `user` or `system`)
118118
* `url` (string): the user's API URL
119119
|`organization`|Object
120120
a|
@@ -146,7 +146,6 @@ Details about the project associated with the job, including:
146146
|`workflow_job_template`|Object|Workflow job template details.
147147
|====
148148

149-
.Example
150149
The following code block shows example input data from a demo job template launch:
151150
[source,rego]
152151
----
@@ -272,7 +271,6 @@ The following code block shows example input data from a demo job template launc
272271
|`violations`|List of strings|Reasons why the action is not permitted
273272
|====
274273

275-
.Example
276274
The following code block shows an example of expected output from the OPA policy query:
277275
[source,rego]
278276
----
@@ -284,4 +282,4 @@ The following code block shows an example of expected output from the OPA policy
284282
],
285283
...
286284
}
287-
----
285+
----

0 commit comments

Comments
 (0)