mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
384 lines
14 KiB
ReStructuredText
384 lines
14 KiB
ReStructuredText
13 years ago
|
Getting Started
|
||
|
===============
|
||
13 years ago
|
|
||
12 years ago
|
.. contents::
|
||
|
:depth: 2
|
||
|
|
||
13 years ago
|
Requirements
|
||
|
````````````
|
||
|
|
||
13 years ago
|
Requirements for Ansible are extremely minimal.
|
||
13 years ago
|
|
||
11 years ago
|
For the central Ansible machine, you will need an environment with Python 2.6 or greater installed. If you are running Python 2.5 on an "Enterprise Linux 5" variant, we'll show you how to add 2.6 to your distribution, but most platforms already have a new enough Python. (Note that Windows is not supported as the Ansible control machine.)
|
||
13 years ago
|
|
||
11 years ago
|
You will also want the following Python modules (installed via pip or perhaps via your OS package manager via slightly different names):
|
||
13 years ago
|
|
||
|
* ``paramiko``
|
||
|
* ``PyYAML``
|
||
12 years ago
|
* ``jinja2``
|
||
13 years ago
|
|
||
11 years ago
|
If you are using RHEL or CentOS 5, Python is version 2.4 by default, but you can get Python 2.6 installed easily. `Use EPEL <http://fedoraproject.org/wiki/EPEL>`_ and install these dependencies as follows:
|
||
12 years ago
|
|
||
|
.. code-block:: bash
|
||
|
|
||
|
$ yum install python26 python26-PyYAML python26-paramiko python26-jinja2
|
||
|
|
||
11 years ago
|
|
||
13 years ago
|
On the managed nodes, you only need Python 2.4 or later, but if you are are running less than Python 2.6 on them, you will
|
||
|
also need:
|
||
13 years ago
|
|
||
13 years ago
|
* ``python-simplejson``
|
||
13 years ago
|
|
||
12 years ago
|
.. note::
|
||
|
|
||
|
Ansible's "raw" module (for executing commands in a quick and dirty
|
||
12 years ago
|
way) and the script module don't even need that. So technically, you can use
|
||
12 years ago
|
Ansible to install python-simplejson using the raw module, which
|
||
|
then allows you to use everything else. (That's jumping ahead
|
||
|
though.)
|
||
13 years ago
|
|
||
11 years ago
|
.. note::
|
||
|
|
||
|
If you have SELinux enabled on remote nodes, you will also want to install
|
||
11 years ago
|
libselinux-python on them before using any copy/file/template related functions in
|
||
11 years ago
|
Ansible. You can of course still use the yum module in Ansible to install this package on
|
||
|
remote systems that do not have it.
|
||
|
|
||
12 years ago
|
.. note::
|
||
|
|
||
|
Python 3 is a slightly different language than Python 2 and most python programs (including
|
||
11 years ago
|
Ansible) are not switching over yet. However, some Linux distributions (Gentoo, Arch) may not have a
|
||
12 years ago
|
Python 2.X interpreter installed by default. On those systems, you should install one, and set
|
||
12 years ago
|
the 'ansible_python_interpreter' variable in inventory (see :doc:`patterns`) to point at your 2.X python. Distributions
|
||
12 years ago
|
like Red Hat Enterprise Linux, CentOS, Fedora, and Ubuntu all have a 2.X interpreter installed
|
||
|
by default and this does not apply to those distributions. This is also true of nearly all
|
||
|
Unix systems. If you need to bootstrap these remote systems by installing Python 2.X,
|
||
|
using the 'raw' module will be able to do it remotely.
|
||
12 years ago
|
|
||
13 years ago
|
Getting Ansible
|
||
|
```````````````
|
||
|
|
||
13 years ago
|
If you are interested in using all the latest features, you may wish to keep up to date
|
||
|
with the development branch of the git checkout. This also makes it easiest to contribute
|
||
|
back to the project.
|
||
13 years ago
|
|
||
13 years ago
|
Instructions for installing from source are below.
|
||
13 years ago
|
|
||
11 years ago
|
Ansible's release cycles are usually about two months long. Due to this
|
||
|
short release cycle, minor bugs will generally be fixed in the next release versus maintaining
|
||
13 years ago
|
backports on the stable branch.
|
||
|
|
||
13 years ago
|
You may also wish to follow the `Github project <https://github.com/ansible/ansible>`_ if
|
||
13 years ago
|
you have a github account. This is also where we keep the issue tracker for sharing
|
||
13 years ago
|
bugs and feature ideas.
|
||
13 years ago
|
|
||
13 years ago
|
|
||
13 years ago
|
Running From Checkout
|
||
|
+++++++++++++++++++++
|
||
|
|
||
|
Ansible is trivially easy to run from a checkout, root permissions are not required
|
||
12 years ago
|
to use it:
|
||
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
|
$ git clone git://github.com/ansible/ansible.git
|
||
|
$ cd ./ansible
|
||
|
$ source ./hacking/env-setup
|
||
13 years ago
|
|
||
11 years ago
|
You will want to install the dependencies needed by Ansible with pip if going from a checkout::
|
||
|
|
||
|
# on Ubuntu, for example:
|
||
|
apt-get install python-dev python-pip
|
||
11 years ago
|
pip install PyYAML Jinja2 paramiko
|
||
11 years ago
|
|
||
|
Once running the env-setup script you'll be running from checkout and the default inventory file
|
||
11 years ago
|
will be /etc/ansible/hosts. You can optionally specify an inventory file (see :doc:`patterns`)
|
||
11 years ago
|
other than /etc/ansible/hosts:
|
||
12 years ago
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
13 years ago
|
$ echo "127.0.0.1" > ~/ansible_hosts
|
||
13 years ago
|
$ export ANSIBLE_HOSTS=~/ansible_hosts
|
||
|
|
||
12 years ago
|
You can read more about the inventory file in later parts of the manual.
|
||
|
|
||
12 years ago
|
Now let's test things:
|
||
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
|
$ ansible all -m ping --ask-pass
|
||
13 years ago
|
|
||
13 years ago
|
|
||
13 years ago
|
Make Install
|
||
|
++++++++++++
|
||
|
|
||
13 years ago
|
If you are not working from a distribution where Ansible is packaged yet, you can install Ansible
|
||
12 years ago
|
using "make install". This is done through `python-distutils`:
|
||
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
|
$ git clone git://github.com/ansible/ansible.git
|
||
|
$ cd ./ansible
|
||
|
$ sudo make install
|
||
|
|
||
12 years ago
|
Via Pip
|
||
|
+++++++
|
||
|
|
||
|
Are you a python developer?
|
||
|
|
||
|
Ansible can be installed via Pip, but when you do so, it will ask to install other dependencies used for
|
||
11 years ago
|
things like 'fireball' mode that you might not need::
|
||
12 years ago
|
|
||
|
$ sudo easy_install pip
|
||
|
$ sudo pip install ansible
|
||
|
|
||
|
Readers that use virtualenv can also install Ansible under virtualenv. Do not use easy_install to install
|
||
|
ansible directly.
|
||
13 years ago
|
|
||
13 years ago
|
Via RPM
|
||
|
+++++++
|
||
|
|
||
12 years ago
|
RPMs for the last Ansible release are available for `EPEL
|
||
|
<http://fedoraproject.org/wiki/EPEL>`_ 6 and currently supported
|
||
12 years ago
|
Fedora distributions. RPMs for openSUSE can be found via the
|
||
|
`openSUSE Software Portal <http://software.opensuse.org/package/ansible>`_
|
||
|
(in the systemsmanagement Project) for all currently supported
|
||
|
openSUSE and SLES distributions.
|
||
|
|
||
|
Ansible itself can manage earlier operating
|
||
12 years ago
|
systems that contain python 2.4 or higher.
|
||
|
|
||
12 years ago
|
If you are using RHEL or CentOS and have not already done so, `configure EPEL <http://fedoraproject.org/wiki/EPEL>`_
|
||
|
|
||
12 years ago
|
.. code-block:: bash
|
||
13 years ago
|
|
||
|
# install the epel-release RPM if needed on CentOS, RHEL, or Scientific Linux
|
||
|
$ sudo yum install ansible
|
||
|
|
||
12 years ago
|
For openSUSE and SUSE Linux Enterprise, add the `systemsmanagement repository <http://download.opensuse.org/repositories/systemsmanagement/>`_
|
||
|
for your distribution:
|
||
|
|
||
|
.. code-block:: bash
|
||
|
|
||
|
# replace $dist with the correct distribution found here: http://download.opensuse.org/repositories/systemsmanagement/
|
||
|
$ sudo zypper ar -f http://download.opensuse.org/repositories/systemsmanagement/$dist/systemsmanagement.repo
|
||
|
$ sudo zypper install ansible
|
||
|
|
||
12 years ago
|
You can also use the ``make rpm`` command to build an RPM you can distribute and install.
|
||
12 years ago
|
Make sure you have ``rpm-build``, ``make``, and ``python2-devel`` installed.
|
||
12 years ago
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
|
$ git clone git://github.com/ansible/ansible.git
|
||
|
$ cd ./ansible
|
||
|
$ make rpm
|
||
12 years ago
|
$ sudo rpm -Uvh ~/rpmbuild/ansible-*.noarch.rpm
|
||
13 years ago
|
|
||
11 years ago
|
Via MacPorts on OS X
|
||
|
++++++++++++++++++++
|
||
12 years ago
|
|
||
11 years ago
|
Ansible is easily run or installed from source, but you can also use MacPorts.
|
||
|
To install the stable version of Ansible from MacPorts, run:
|
||
12 years ago
|
|
||
|
.. code-block:: bash
|
||
|
|
||
|
$ sudo port install ansible
|
||
|
|
||
|
If you wish to install the latest build via the MacPorts system from a
|
||
|
git checkout, run:
|
||
|
|
||
|
.. code-block:: bash
|
||
|
|
||
|
$ git clone git://github.com/ansible/ansible.git
|
||
|
$ cd ./ansible/packaging/macports
|
||
|
$ sudo port install
|
||
|
|
||
|
Please refer to the documentation at <http://www.macports.org> for
|
||
|
further information on using Portfiles with MacPorts.
|
||
|
|
||
12 years ago
|
|
||
12 years ago
|
Ubuntu and Debian
|
||
|
+++++++++++++++++
|
||
13 years ago
|
|
||
12 years ago
|
Ubuntu builds are available `in a PPA here <https://launchpad.net/~rquillo/+archive/ansible>`_.
|
||
|
|
||
11 years ago
|
Once configured,
|
||
12 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
12 years ago
|
|
||
12 years ago
|
$ sudo apt-get install ansible
|
||
13 years ago
|
|
||
11 years ago
|
Debian/Ubuntu packages can also be built from the source checkout, run:
|
||
13 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
|
|
||
|
$ make debian
|
||
13 years ago
|
|
||
11 years ago
|
You may also wish to run from source to get the latest, which is covered above.
|
||
|
|
||
12 years ago
|
Gentoo, Arch, Others
|
||
|
++++++++++++++++++++
|
||
|
|
||
12 years ago
|
Gentoo eBuilds are in portage, version 1.0 `coming soon <https://bugs.gentoo.org/show_bug.cgi?id=461830>`_.
|
||
|
|
||
|
.. code-block:: bash
|
||
|
|
||
|
$ emerge ansible
|
||
|
|
||
12 years ago
|
|
||
13 years ago
|
An Arch PKGBUILD is available on `AUR <https://aur.archlinux.org/packages.php?ID=58621>`_
|
||
12 years ago
|
If you have python3 installed on Arch, you probably want to symlink python to python2:
|
||
|
|
||
|
.. code-block:: bash
|
||
13 years ago
|
|
||
12 years ago
|
$ sudo ln -sf /usr/bin/python2 /usr/bin/python
|
||
13 years ago
|
|
||
12 years ago
|
You should also set a 'ansible_python_interpreter' inventory variable (see :doc:`patterns`) for hosts that have python
|
||
12 years ago
|
pointing to python3, so the right python can be found on the managed nodes.
|
||
13 years ago
|
|
||
|
Tagged Releases
|
||
|
+++++++++++++++
|
||
|
|
||
11 years ago
|
Tarballs of releases are available on the ansibleworks.com page.
|
||
13 years ago
|
|
||
11 years ago
|
* `Ansible/downloads <http://ansibleworks.com/releases>`_
|
||
12 years ago
|
|
||
|
These releases are also tagged in the git repository with the release version.
|
||
13 years ago
|
|
||
12 years ago
|
Choosing Between Paramiko and Native SSH
|
||
|
````````````````````````````````````````
|
||
|
|
||
11 years ago
|
By default, ansible 1.3 and later will try to use native SSH for remote communication when possible.
|
||
|
This is done when ControlPersist support is available. Paramiko is however reasonably fast and makes
|
||
|
a good default on versions of Enterprise Linux where ControlPersist is not available. However, Paramiko
|
||
|
does not support some advanced SSH features that folks will want to use. In Ansible 1.2 and before,
|
||
|
the default was strictly paramiko and native SSH had to be explicitly selected with -c ssh or set in the
|
||
|
configuration file.
|
||
12 years ago
|
|
||
12 years ago
|
.. versionadded:: 0.5
|
||
|
|
||
|
If you want to leverage more advanced SSH features (such as Kerberized
|
||
|
SSH or jump hosts), pass the flag "--connection=ssh" to any ansible
|
||
|
command, or set the ANSIBLE_TRANSPORT environment variable to
|
||
|
'ssh'. This will cause Ansible to use openssh tools instead.
|
||
12 years ago
|
|
||
|
If ANSIBLE_SSH_ARGS are not set, ansible will try to use some sensible ControlMaster options
|
||
|
by default. You are free to override this environment variable, but should still pass ControlMaster
|
||
|
options to ensure performance of this transport. With ControlMaster in use, both transports
|
||
|
are roughly the same speed. Without CM, the binary ssh transport is signficantly slower.
|
||
|
|
||
|
If none of this makes sense to you, the default paramiko option is probably fine.
|
||
13 years ago
|
|
||
12 years ago
|
|
||
13 years ago
|
Your first commands
|
||
|
```````````````````
|
||
|
|
||
13 years ago
|
Now that you've installed Ansible, it's time to test it.
|
||
|
|
||
13 years ago
|
Edit (or create) /etc/ansible/hosts and put one or more remote systems in it, for
|
||
13 years ago
|
which you have your SSH key in ``authorized_keys``::
|
||
13 years ago
|
|
||
|
192.168.1.50
|
||
|
aserver.example.org
|
||
|
bserver.example.org
|
||
|
|
||
12 years ago
|
Set up SSH agent to avoid retyping passwords:
|
||
13 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
|
|
||
|
$ ssh-agent bash
|
||
|
$ ssh-add ~/.ssh/id_rsa
|
||
13 years ago
|
|
||
12 years ago
|
(Depending on your setup, you may wish to ansible's --private-key option to specify a pem file instead)
|
||
12 years ago
|
|
||
12 years ago
|
Now ping all your nodes:
|
||
13 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
13 years ago
|
|
||
12 years ago
|
$ ansible all -m ping
|
||
12 years ago
|
|
||
12 years ago
|
Ansible will attempt to remote connect to the machines using your current
|
||
|
user name, just like SSH would. To override the remote user name, just use the '-u' parameter.
|
||
12 years ago
|
|
||
|
If you would like to access sudo mode, there are also flags to do that:
|
||
12 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
|
|
||
|
# as bruce
|
||
|
$ ansible all -m ping -u bruce
|
||
12 years ago
|
# as bruce, sudoing to root
|
||
12 years ago
|
$ ansible all -m ping -u bruce --sudo
|
||
12 years ago
|
# as bruce, sudoing to batman
|
||
12 years ago
|
$ ansible all -m ping -u bruce --sudo --sudo-user batman
|
||
12 years ago
|
|
||
11 years ago
|
(The sudo implementation is changeable in ansible's configuration file if you happen to want to use a sudo
|
||
12 years ago
|
replacement. Flags passed dot sudo can also be set.)
|
||
|
|
||
12 years ago
|
Now run a live command on all of your nodes:
|
||
13 years ago
|
|
||
12 years ago
|
.. code-block:: bash
|
||
|
|
||
|
$ ansible all -a "/bin/echo hello"
|
||
13 years ago
|
|
||
13 years ago
|
Congratulations. You've just contacted your nodes with Ansible. It's
|
||
11 years ago
|
soon going to be time to read some of the more real-world :doc:`examples`, and explore
|
||
13 years ago
|
what you can do with different modules, as well as the Ansible
|
||
13 years ago
|
:doc:`playbooks` language. Ansible is not just about running commands, it
|
||
|
also has powerful configuration management and deployment features. There's more to
|
||
|
explore, but you already have a fully working infrastructure!
|
||
13 years ago
|
|
||
11 years ago
|
A note about Connection (Transport) Modes
|
||
|
`````````````````````````````````````````
|
||
|
|
||
|
Ansible has two major forms of SSH transport implemented, 'ssh' (OpenSSH) and 'paramiko'. Paramiko is a python
|
||
|
SSH implementation and 'ssh' simply calls OpenSSH behind the scenes. There are additionally 'fireball' (an accelerated
|
||
|
remote transport), 'local', and 'chroot' connection modes in Ansible that don't use SSH, but connecting by one of the two
|
||
|
SSH transports is the most common way to manage systems. It is useful to understand the difference between the 'ssh'
|
||
|
and 'paramiko' modes.
|
||
|
|
||
|
Paramiko is provided because older Enterprise Linux operating systems do not have an efficient OpenSSH that support
|
||
|
ControlPersist technology, and in those cases, 'paramiko' is faster than 'ssh'. Thus, until EL6 backports a newer
|
||
|
SSH, 'paramiko' is the faster option on that platform.
|
||
|
|
||
|
However, if you have a newer 'ssh' that supports ControlPersist, usage of the 'ssh' transport unlocks additional
|
||
|
configurability, including the option to use Kerberos. For instance, the latest Fedora and Ubuntu releases
|
||
|
all offer a sufficiently new OpenSSH. With ControlPersist available, 'ssh' is usually about as fast as paramiko.
|
||
|
If you'd like even more speed, read about 'fireball' in the Advanced Playbooks section.
|
||
|
|
||
|
Starting with Ansible 1.2.1, the default transport mode for Ansible is 'smart', which means it will detect
|
||
|
if OpenSSH supports ControlPersist, and will select 'ssh' if available, and otherwise pick 'paramiko'.
|
||
|
Previous versions of Ansible defaulted to 'paramiko'.
|
||
|
|
||
|
A note about Host Key Checking
|
||
|
``````````````````````````````
|
||
|
|
||
|
Ansible 1.2.1 and later have host key checking enabled by default.
|
||
|
|
||
|
If a host is reinstalled and has a different key in 'known_hosts', this will result in a error message until
|
||
|
corrected. If a host is not initially in 'known_hosts' this will result in prompting for confirmation of the key,
|
||
|
which results in a interactive experience if using Ansible, from say, cron.
|
||
|
|
||
|
If you wish to disable this behavior and understand the implications, you can do so by editing /etc/ansible/ansible.cfg or ~/.ansible.cfg::
|
||
|
|
||
11 years ago
|
[defaults]
|
||
11 years ago
|
host_key_checking = False
|
||
|
|
||
11 years ago
|
Alternatively this can be set by an environment variable:
|
||
|
|
||
|
$ export ANSIBLE_HOST_KEY_CHECKING=False
|
||
|
|
||
|
Also note that host key checking in paramiko mode is reasonably slow, therefore switching to 'ssh' is also recommended when using this
|
||
11 years ago
|
feature.
|
||
13 years ago
|
|
||
|
.. seealso::
|
||
|
|
||
13 years ago
|
:doc:`examples`
|
||
|
Examples of basic commands
|
||
|
:doc:`playbooks`
|
||
|
Learning ansible's configuration management language
|
||
13 years ago
|
`Mailing List <http://groups.google.com/group/ansible-project>`_
|
||
|
Questions? Help? Ideas? Stop by the list on Google Groups
|
||
|
`irc.freenode.net <http://irc.freenode.net>`_
|
||
|
#ansible IRC chat channel
|
||
13 years ago
|
|