Skip to content

Commit 69a1a65

Browse files
authored
Merge pull request #386 from michellemacrh/github-385-pr
github-385-pr: Add Ansible Rulebook to glossary
2 parents a1712db + 2cbe8a5 commit 69a1a65

File tree

3 files changed

+51
-3
lines changed
  • supplementary_style_guide/glossary_terms_conventions/general_conventions

3 files changed

+51
-3
lines changed

supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ _Valid values are `amd64`._
328328
// RHEL: General; kept as is
329329
[[ansible-playbook]]
330330
==== image:images/yes.png[yes] Ansible Playbook (noun)
331-
*Description*: Playbooks are Ansible’s configuration, deployment, and orchestration language.
332-
Playbooks can describe a policy you want your remote systems to enforce, or a set of steps in a general IT process.
331+
*Description*: Playbooks are the configuration, deployment, and orchestration language for Ansible Automation Platform.
332+
Playbooks can describe a policy you want your remote systems to enforce or a set of steps in a general IT process.
333333
An _Ansible Playbook_ is a file that contains one or more Ansible plays.
334334
Write as shown: uppercase _A_ and uppercase _P_. When using the term _playbook_ without the Ansible prefix, use lowercase _p_.
335335

@@ -342,7 +342,22 @@ Examples:
342342

343343
*Incorrect forms*: Ansible playbook
344344

345-
*See also*: xref:ansible-play[Ansible play]
345+
*See also*: xref:ansible-play[Ansible play], xref:playbook[playbook]
346+
347+
[[ansible-rulebook]]
348+
==== image:images/yes.png[yes] Ansible Rulebook (noun)
349+
*Description*: An _Ansible Rulebook_ tells Event-Driven Ansible which sources to monitor for an event and what to do when certain conditions are met. Rulebooks are written in YAML and are used like Ansible Playbooks. Write as shown: uppercase _A_ and uppercase _R_. When using the term "rulebook" without the Ansible prefix, use lowercase _r_.
350+
351+
Examples:
352+
353+
* Use a rulebook in Ansible.
354+
* Use an Ansible Rulebook.
355+
356+
*Use it*: yes
357+
358+
*Incorrect forms*: Ansible rulebook
359+
360+
*See also*: xref:rulebook[rulebook]
346361

347362
// RHEL: General; kept as is
348363
[[ansible-task]]

supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,23 @@ When combined with privileges, permissions define a user's or resource's overall
228228

229229
*See also*:
230230

231+
[[playbook]]
232+
==== image:images/yes.png[yes] playbook (noun)
233+
*Description*: _Playbooks_ are the configuration, deployment, and orchestration language for Ansible Automation Platform.
234+
Playbooks can describe a policy you want your remote systems to enforce or a set of steps in a general IT process.
235+
When using the term "playbook" without the Ansible prefix, use lowercase _p_.
236+
237+
Examples:
238+
239+
* Run a playbook in Ansible.
240+
* Run an Ansible Playbook.
241+
242+
*Use it*: yes
243+
244+
*Incorrect forms*: Playbook
245+
246+
*See also*: xref:ansible-playbook[Ansible Playbook]
247+
231248
[[pluggable]]
232249
==== image:images/yes.png[yes] pluggable (noun)
233250
*Description*: "Pluggable" refers to something that is capable of being plugged in, especially in terms of (for example) software modules. "Hot-pluggable" is also widely used with respect to hardware to indicate that it can be connected and recognized without powering down the system.

supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1079,6 +1079,22 @@ Use the name of the tab when you refer to it, for example, "the *Storage* tab".
10791079

10801080
*See also*:
10811081

1082+
[[rulebook]]
1083+
==== image:images/yes.png[yes] rulebook (noun)
1084+
*Description*: A _rulebook_ is a YAML file containing a list of rules, event source definitions, and hosts to run against.
1085+
Rulebooks are used in Event-Driven Ansible. When using the term "rulebook" without the Ansible prefix, use lowercase _r_.
1086+
1087+
Examples:
1088+
1089+
* Use a rulebook in Ansible.
1090+
* Use an Ansible Rulebook.
1091+
1092+
*Use it*: yes
1093+
1094+
*Incorrect forms*: Rulebook
1095+
1096+
*See also*: xref:ansible-rulebook[Ansible Rulebook]
1097+
10821098
[[runlevel]]
10831099
==== image:images/yes.png[yes] runlevel (noun)
10841100
*Description*: A _runlevel_ is a preset operating state on a UNIX system and similar operating systems. A system can be booted in to (that is, started up in to) any of several runlevels, each of which is represented by a single-digit integer. Each runlevel designates a different system configuration and allows access to a different combination of processes (that is, instances of executing programs). There are differences in the runlevels according to the operating system. Seven runlevels are supported in the standard Linux kernel.

0 commit comments

Comments
 (0)