Ansible Cheat Sheet



ANSIBLE CHEAT SHEET Learn DevOps from experts at edureka.co Ansible Architecture Inventory Files & Hosts Patterns Ad-Hoc Commands SSH Key Generation & Install Ansible What is Ansible? Ungrouped.example.com #An ungrouped host webservers #A group called webservers beta.example.com ansiblehost = 10.0.0.5 #ssh to 10.0.0.5. Useful Ansible commands. Make sure python will load all modules installed in your virtualenv. Ansible-cheatsheet Filelist. DO407-exam-notes.txt - only few notes for the Ansible exam that are hard to remember; ansible-cheatsheet.txt - general notes from 2018-12-04; ec2.ini - AWS dynamic inventory configuration file; ec2.py - AWS dynamic inventory script, slightly modified from the default one; Stargazers over time. Ansible¶ This is growing into a minimal Ansible reference of sorts, since Ansible’s own docs have nothing like a reference. List of keys that common playbook objects can take. Release tarballs. Ansible documentation for older releases.

Here are some commands which are used in Ansible, such as:

  • To install EPEL repo on Centos/RHEL systems.
  • To install Ansible package on Centos/RHEL systems.
  • To perform an update to the packages on Debian/Ubuntu systems.
  • To install the software properties-common-package on Debian/Ubuntu systems.
  • To install Ansible personal package archive on Debian/Ubuntu systems.
  • To install Ansible on Debian/Ubuntu systems.
  • To issue a ping command on all servers defined in the inventory file named hosts.
  • To issue a ping command only on hosts2.
  • To copy the file 'testfile' on all hosts in the inventory file.
  • To install ncdu package on all hosts.
  • To remove ncdu package on all hosts.
  • To build the directory structure for the role named role1.
  • To dry-run p4.yml playbook.
  • To run a p4.yml playbook with password authentication for all hosts.

Ansible Cheat Sheet Pdf


Welcome to the Ansible style guide!To create clear, concise, consistent, useful materials on docs.ansible.com, follow these guidelines:

We want the Ansible documentation to be:

  • clear

  • direct

  • conversational

  • easy to translate

We want reading the docs to feel like having an experienced, friendly colleagueexplain how Ansible works.

This cheat-sheet illustrates a few rules that help achieve the “Ansible tone”:

Rule

Good example

Bad example

Use active voice

You can run a task by

A task can be run by

Use the present tense

This command creates a

This command will create a

Address the reader

As you expand your inventory

When the number of managed nodes grows

Use standard English

Return to this page

Hop back to this page

Use American English

The color of the output

The colour of the output

Headers should be written in sentence case. For example, this section’s title isHeadercase, not HeaderCase or HEADERCASE.

Latin words and phrases like e.g. or etc.are easily understood by English speakers.They may be harder to understand for others and are also tricky for automated translation.

Use the following English terms in place of Latin terms or abbreviations:

Latin

English

i.e

in other words

e.g.

for example

etc

and so on

via

by/ through

vs./versus

rather than/against

The Ansible documentation is written in reStructuredText and processed by Sphinx.We follow these technical or mechanical guidelines on all rST pages:

Section headers in reStructuredTextcan use a variety of notations.Sphinx will ‘learn on the fly’ when creating a hierarchy of headers.To make our documents easy to read and to edit, we follow a standard set of header notations.We use:

  • ### with overline, for parts:

  • *** with overline, for chapters:

  • for sections:

  • --- for subsections:

  • ^^^ for sub-subsections:

  • '' for paragraphs:

The Ansible documentation supports a range of Pygments lexersfor syntax highlighting to make our code examples look good. Each code-block must be correctly indented and surrounded by blank lines.

The Ansible documentation allows the following values:

  • none (no highlighting)

  • ansible-output (a custom lexer for Ansible output)

  • bash

  • console

  • csharp

  • ini

  • json

  • powershell

  • python

  • rst

  • sh

  • shell

  • shell-session

  • text

  • yaml

  • yaml+jinja

Cheat Sheet Terraria

For example, you can highlight Python code using following syntax:

Anchors (also called labels) and linkswork together to help users find related content.Local tables of contents also help users navigate quickly to the information they need.All internal links should use the :ref: syntax.Every page should have at least one anchor to support internal :ref: links.Long pages, or pages with multiple levels of headers, can also include a local TOC.

  • Include at least one anchor on every page

  • Place the main anchor above the main header

  • If the file has a unique title, use that for the main page anchor:

  • You may also add anchors elsewhere on the page

  • All internal links must use :ref: syntax. These links both point to the anchor defined above:

The second example adds custom text for the link.

Ansible 2.10 and later require the extended Fully Qualified Collection Name (FQCN) as part of the links:

For example:

displays as ansible.builtin.first_found lookup plugin.

Modules require different suffixes from other plugins:

  • Module links use this extended FQCN module name with _module for the anchor.

  • Plugin links use this extended FQCN plugin name with the plugin type (_connection for example).

Note

ansible.builtin is the FQCN for modules included in ansible.base. Documentation links are the only place you prepend ansible_collections to the FQCN. This is used by the documentation build scripts to correctly fetch documentation from collections on Ansible Galaxy.

The page you’re reading includes a local TOC.If you include a local TOC:

  • place it below, not above, the main heading and (optionally) introductory text

  • use the :local: directive so the page’s main header is not included

  • do not include a title

The syntax is:

These pages offer more help with grammatical, stylistic, and technical rules for documentation.

Cheat Sheet Isaac

See also

Contributing to the Ansible Documentation

How to contribute to the Ansible documentation

Testing the documentation locally
Ansible Cheat Sheet

How to build the Ansible documentation

irc.freenode.net

#ansible-docs IRC chat channel