Skip to content

Commit 6c427c8

Browse files
committed
Manual formatting fixes
Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
1 parent 7e86e42 commit 6c427c8

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

content/examples/tutorials/report_inventory_remediate_sec_vulnerabilities.markdown

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -76,30 +76,30 @@ bundle agent inventory_CVE_2014_6271
7676
### What does this inventory policy do?
7777

7878
Meta type promises are used to attach additional information to bundles. We
79-
have set 'description' so that future readers of the policy will know what the
79+
have set `description` so that future readers of the policy will know what the
8080
policy is for and how to get more information on the vulnerability. For
81-
the sake of simplicity in this example set 'autorun' as a tag to the bundle.
81+
the sake of simplicity in this example set `autorun` as a tag to the bundle.
8282
This makes the bundle available for automatic activation when using the autorun
8383
feature in the Masterfiles Policy Framework.
8484

8585
Next we set the paths to the binaries that we will use to exeucte our test
86-
command. As of this writing the paths for 'env' and 'echo' are both in the
87-
standard libraries paths bundle, but 'bash' is not. Note that you may need to
86+
command. As of this writing the paths for `env` and `echo` are both in the
87+
standard libraries paths bundle, but `bash` is not. Note that you may need to
8888
adjust the path to bash for your platforms. Then we run our test command and
89-
place the command output into the 'test_result' variable. Since we have no
90-
_CVE_2014_6271_ class defined yet, the next promise to set the variable
91-
'vulnerable' to 'CVE-2014-6271' will be skipped on the first pass. Then the
92-
classes type promise is evaluated and defines the class _CVE_2014_6271_ if the
93-
output matches the regular expression 'vulnerable.\*'. Finally the reports are
94-
evaluated before starting the second pass. If the class 'DEBUG' or
95-
'DEBUG_inventory_CVE_2014_6271' is set the test command output will be shown,
89+
place the command output into the `test_result` variable. Since we have no
90+
`CVE_2014_6271` class defined yet, the next promise to set the variable
91+
`vulnerable` to `CVE-2014-6271` will be skipped on the first pass. Then the
92+
classes type promise is evaluated and defines the class `CVE_2014_6271` if the
93+
output matches the regular expression `vulnerable.\*`. Finally the reports are
94+
evaluated before starting the second pass. If the class `DEBUG` or
95+
`DEBUG_inventory_CVE_2014_6271` is set the test command output will be shown,
9696
and if the vulnerability is present agent is running in inform or verbose mode
9797
message indicating the host is vulnerable along with the description will be
9898
output.
9999

100-
On the second pass only that variable 'vulnerable' will be set with the value
101-
'CVE-2014-6271' if the host is vulnerable. Note how this variable tagged with
102-
'inventory' and 'attribute_name='. These are special meta tags that CFEngine
100+
On the second pass only that variable `vulnerable` will be set with the value
101+
`CVE-2014-6271` if the host is vulnerable. Note how this variable tagged with
102+
`inventory` and `attribute_name=`. These are special meta tags that CFEngine
103103
Enterprise uses in order to display information.
104104

105105
### Deploy the policy
@@ -172,9 +172,9 @@ bundle agent remediate_CVE_2014_6271
172172

173173
### What does this remediation policy do?
174174

175-
For simplicity of the example this policy defines the class allow_update on hub
175+
For simplicity of the example this policy defines the class `allow_update` on hub
176176
and host001, but you could use any class that makes sense to you. If the
177-
allow_update class is set, and the class _CVE_2014_6271_ is defined (indicating
177+
`allow_update` class is set, and the class `CVE_2014_6271` is defined (indicating
178178
the host is vulnerable) then the policy ensures that bash is updated to the
179179
latest version available.
180180

content/overview/how-cfengine-works.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ The four mission phases are sometimes referred to as
196196
- Deploy
197197

198198
Deploying really means launching the policy into production. In CFEngine you
199-
simply publish your policy (in CFEngine parlance these are `promise
200-
proposals`) and the machines see the new proposals and can adjust
199+
simply publish your policy (in CFEngine parlance these are `promise proposals`)
200+
and the machines see the new proposals and can adjust
201201
accordingly. Each machine runs an agent that is capable of keeping the
202202
system on course and maintaining it over time without further assistance.
203203

0 commit comments

Comments
 (0)