Skip to content

Commit 6a61b9f

Browse files
Amrita42Amrita42
authored
PED10891-Ansible-basics (#544)
* structure toc * self review * best practices * final changes * tech review feedback-1 * tech feedback-2 * tech fdback * tech review-4 * self review and support cover aded * validate * final review * tech feedback * final tech feedback * dc -dap * typo * tech review feedback * tech review * final tech review * tech review * tfeedback * editorial review * editorial review * final self review
1 parent 0fc306c commit 6a61b9f

File tree

11 files changed

+1062
-0
lines changed

11 files changed

+1062
-0
lines changed

‎DC-SAP-Ansible‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# This file originates from the project https://github.com/openSUSE/doc-kit
2+
# This file can be edited downstream.
3+
4+
MAIN="ansible.asm.xml"
5+
# Point to the ID of the <structure> of your assembly
6+
SRC_DIR="articles"
7+
IMG_SRC_DIR="images"
8+
9+
PROFOS="sles4sap"
10+
PROFCONDITION="16.0"
11+
STRUCTID="ansible"
12+
#PROFCONDITION="suse-product;beta"
13+
#PROFCONDITION="community-project"
14+
15+
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
16+
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

‎DC-SLES-Ansible‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# This file originates from the project https://github.com/openSUSE/doc-kit
2+
# This file can be edited downstream.
3+
4+
MAIN="ansible.asm.xml"
5+
# Point to the ID of the <structure> of your assembly
6+
SRC_DIR="articles"
7+
IMG_SRC_DIR="images"
8+
9+
PROFOS="sles"
10+
PROFCONDITION="16.0"
11+
STRUCTID="ansible"
12+
#PROFCONDITION="suse-product;beta"
13+
#PROFCONDITION="community-project"
14+
15+
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
16+
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

‎articles/ansible.asm.xml‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<?xml-model href="https://cdn.docbook.org/schema/5.2/rng/assemblyxi.rnc"
3+
type="application/relax-ng-compact-syntax"?>
4+
<!DOCTYPE assembly
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<assembly version="5.2" xml:lang="en"
10+
xmlns:xlink="http://www.w3.org/1999/xlink"
11+
xmlns:trans="http://docbook.org/ns/transclusion"
12+
xmlns:its="http://www.w3.org/2005/11/its"
13+
xmlns="http://docbook.org/ns/docbook">
14+
<!-- R E S O U R C E S -->
15+
<resources>
16+
<resource href="../concepts/ansible-intro.xml" xml:id="_ansible-intro"/>
17+
<resource href="../references/ansible-configure.xml" xml:id="_ansible-configure"/>
18+
<resource href="../concepts/ansible-inventory-file.xml" xml:id="_ansible-inventory-file"/>
19+
<resource href="../tasks/ansible-install.xml" xml:id="_ansible-install"/>
20+
<resource href="../references/ansible-basic-usage.xml" xml:id="_ansible-basic-usage"/>
21+
<resource href="../references/ansible-support-coverage.xml" xml:id="_ansible-support-coverage"/>
22+
<resource href="../references/ansible-best-practices.xml" xml:id="_ansible-best-practices"/>
23+
<resource href="../glues/ansible-more-info.xml" xml:id="_ansible-more-info"/>
24+
<resource href="../common/legal.xml" xml:id="_legal"/>
25+
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl"/>
26+
</resources>
27+
<!-- S T R U C T U R E -->
28+
<structure renderas="article" xml:id="ansible" xml:lang="en">
29+
<merge>
30+
<title>Introduction to Ansible core</title>
31+
<revhistory xml:id="rh-ansible">
32+
<revision><date>2025-11-04</date>
33+
<revdescription>
34+
<para>
35+
Initial version
36+
</para>
37+
</revdescription>
38+
</revision>
39+
</revhistory>
40+
41+
<!-- Maintainer-->
42+
<meta name="maintainer" content="[email protected]" its:translate="no"/>
43+
44+
<!-- Series-->
45+
<meta name="series" its:translate="no">Smart Docs</meta>
46+
47+
<!-- Task -->
48+
<meta name="task" its:translate="no">
49+
<phrase>Administration</phrase>
50+
<phrase>Configuration</phrase>
51+
<phrase>Security</phrase>
52+
</meta>
53+
54+
<!-- Docmanager -->
55+
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
56+
<dm:bugtracker>
57+
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
58+
<dm:component>Documentation</dm:component>
59+
<dm:product>SUSE Linux Enterprise Server 16.0</dm:product>
60+
<dm:assignee>[email protected]</dm:assignee>
61+
</dm:bugtracker>
62+
<dm:translation>yes</dm:translation>
63+
</dm:docmanager>
64+
65+
<!-- Architecture -->
66+
<meta name="architecture" its:translate="no">
67+
<phrase>&x86-64;</phrase>
68+
<phrase>&power;</phrase>
69+
<phrase>&zseries;</phrase>
70+
<phrase>&aarch64;</phrase>
71+
</meta>
72+
73+
<!-- Productname & Version -->
74+
<meta name="productname" its:translate="no">
75+
<productname version="16.0" os="sles;sles4sap">&productname;</productname>
76+
</meta>
77+
78+
<!-- Social Media -->
79+
<meta name="title" its:translate="yes">Introduction to Ansible core</meta>
80+
<meta name="social-descr" its:translate="yes">Learn how to simplify IT tasks and system management using Ansible core</meta>
81+
82+
<!-- Search -->
83+
<meta name="description" its:translate="yes">Use Ansible automation platform to efficiently automate IT tasks.</meta>
84+
85+
<abstract>
86+
<variablelist>
87+
<varlistentry>
88+
<term>WHAT?</term>
89+
<listitem>
90+
<para>
91+
Ansible is an IT automation tool that simplifies configuration management, application deployment and
92+
task orchestration by enabling you to define infrastructure as code in a simple way.
93+
</para>
94+
</listitem>
95+
</varlistentry>
96+
<varlistentry>
97+
<term>WHY?</term>
98+
<listitem>
99+
<para>
100+
Learn how to automate IT infrastructure with Ansible, from installation and configuration, to creating
101+
inventory files and a playbooks.
102+
</para>
103+
</listitem>
104+
</varlistentry>
105+
<varlistentry>
106+
<term>EFFORT</term>
107+
<listitem>
108+
<para>
109+
The average reading time of this article is approximately 40 minutes.
110+
</para>
111+
</listitem>
112+
</varlistentry>
113+
<varlistentry>
114+
<term>REQUIREMENTS</term>
115+
<listitem>
116+
<itemizedlist>
117+
<listitem>
118+
<para>
119+
<emphasis>Linux fundamentals:</emphasis> Understanding basic Linux commands, file permissions, directory structures
120+
and use of the command line.
121+
</para>
122+
</listitem>
123+
<listitem>
124+
<para>
125+
<emphasis>Networking:</emphasis> Ansible connects to remote machines via SSH so knowledge of IP addresses, SSH, host names and ports is required.
126+
</para>
127+
</listitem>
128+
<listitem>
129+
<para>
130+
<emphasis>YAML:</emphasis> Ansible playbooks are written in YAML, so knowing how to structure a YAML file is essential.
131+
</para>
132+
</listitem>
133+
</itemizedlist>
134+
</listitem>
135+
</varlistentry>
136+
</variablelist>
137+
</abstract>
138+
</merge>
139+
<module resourceref="_ansible-intro"></module>
140+
<module resourceref="_ansible-install">
141+
</module>
142+
<module resourceref="_ansible-configure">
143+
</module>
144+
<module resourceref="_ansible-inventory-file">
145+
</module>
146+
<module resourceref="_ansible-basic-usage"/>
147+
<module resourceref="_ansible-best-practices"/>
148+
<module resourceref="_ansible-support-coverage"/>
149+
<module resourceref="_ansible-more-info"/>
150+
<module resourceref="_legal"/>
151+
<module resourceref="_gfdl">
152+
<output renderas="appendix"/>
153+
</module>
154+
</structure>
155+
</assembly>

‎concepts/ansible-intro.xml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE topic
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<topic xml:id="ansible-intro"
10+
role="reference" xml:lang="en"
11+
xmlns="http://docbook.org/ns/docbook" version="5.2"
12+
xmlns:its="http://www.w3.org/2005/11/its"
13+
xmlns:xi="http://www.w3.org/2001/XInclude"
14+
xmlns:xlink="http://www.w3.org/1999/xlink"
15+
xmlns:trans="http://docbook.org/ns/transclusion">
16+
<info>
17+
<title>What is Ansible core?</title>
18+
<meta name="maintainer" content="[email protected]" its:translate="no"/>
19+
<abstract>
20+
<para>
21+
Ansible core is an open source IT automation engine that automates provisioning, configuration management, application deployment and other IT processes.
22+
It is has agent less architecture, which means no dedicated connection software is required on the managed nodes.
23+
It operates on the following concepts: </para>
24+
</abstract>
25+
</info>
26+
<itemizedlist>
27+
<listitem>
28+
<para>
29+
<emphasis>Control node:</emphasis> The machine where Ansible is installed and executed. </para>
30+
</listitem>
31+
<listitem>
32+
<para>
33+
<emphasis>Managed nodes:</emphasis> The target servers or devices that Ansible manages.
34+
</para>
35+
</listitem>
36+
<listitem>
37+
<para>
38+
<emphasis>Inventory:</emphasis> A file that defines and groups your managed nodes.
39+
</para>
40+
</listitem>
41+
<listitem>
42+
<para>
43+
<emphasis>Module:</emphasis> A small program that performs actions on a managed node.
44+
</para>
45+
</listitem>
46+
<listitem>
47+
<para>
48+
<emphasis>Task:</emphasis> A single execution of an Ansible module on a managed node.
49+
</para>
50+
</listitem>
51+
<listitem>
52+
<para>
53+
<emphasis>Playbooks:</emphasis> Ansible playbooks provide a repeatable, reusable, simple configuration management and multi-machine deployment system.
54+
</para>
55+
</listitem>
56+
<listitem>
57+
<para>
58+
<emphasis>Collection:</emphasis> A collection of Ansible roles or modules focusing on a specific area.</para>
59+
</listitem>
60+
<listitem>
61+
<para>
62+
<emphasis>Role:</emphasis> A standard, self-contained and portable unit of automation that organizes related tasks, variables and files into a predictable directory structure for easy reuse.
63+
</para>
64+
</listitem>
65+
</itemizedlist>
66+
<important>
67+
<itemizedlist>
68+
<listitem><para><emphasis role="bold">Ansible Core</emphasis> is the foundational software package that includes command-line tools like <literal>ansible</literal> and <literal>ansible-playbook</literal> and the execution engine.
69+
It provides the essential libraries and basic modules needed to connect to managed nodes and execute tasks. </para></listitem>
70+
<listitem><para><emphasis role="bold">Ansible automation components</emphasis> are the content that defines the logic, packaged into playbooks, roles and collections.
71+
These assets provide the instructions for the core engine, with collections serving as a distribution format that bundles reusable roles, modules and plug-ins. </para></listitem>
72+
<listitem><para> <emphasis role="bold">Ansible Orchestration</emphasis> is handled by higher-level tools that provide a UI, API and workflow engine to centrally manage and visually chain multiple automation playbooks together for complex multi-system processes.</para>
73+
</listitem>
74+
</itemizedlist>
75+
</important>
76+
</topic>

0 commit comments

Comments
 (0)