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.
228 lines
7.8 KiB
ReStructuredText
228 lines
7.8 KiB
ReStructuredText
11 years ago
|
.. _inventory:
|
||
13 years ago
|
|
||
11 years ago
|
Inventory
|
||
|
=========
|
||
13 years ago
|
|
||
13 years ago
|
Ansible works against multiple systems in your infrastructure at the
|
||
|
same time. It does this by selecting portions of systems listed in
|
||
11 years ago
|
Ansible's inventory file, which defaults to being saved in
|
||
|
the location /etc/ansible/hosts.
|
||
|
|
||
|
Not only is this inventory configurable, but you can also use
|
||
|
multiple inventory files at the same time (explained below) and also
|
||
11 years ago
|
pull inventory from dynamic or cloud sources, as described in :doc:`intro_dynamic_inventory`.
|
||
13 years ago
|
|
||
11 years ago
|
.. contents::
|
||
12 years ago
|
:depth: 2
|
||
|
|
||
13 years ago
|
.. _inventoryformat:
|
||
|
|
||
13 years ago
|
Hosts and Groups
|
||
|
++++++++++++++++
|
||
13 years ago
|
|
||
13 years ago
|
The format for /etc/ansible/hosts is an INI format and looks like this::
|
||
13 years ago
|
|
||
|
mail.example.com
|
||
|
|
||
|
[webservers]
|
||
|
foo.example.com
|
||
|
bar.example.com
|
||
|
|
||
|
[dbservers]
|
||
|
one.example.com
|
||
|
two.example.com
|
||
|
three.example.com
|
||
|
|
||
11 years ago
|
The things in brackets are group names, which are used in classifying systems
|
||
|
and deciding what systems you are controlling at what times and for what purpose.
|
||
13 years ago
|
|
||
13 years ago
|
If you have hosts that run on non-standard SSH ports you can put the port number
|
||
11 years ago
|
after the hostname with a colon. Ports listed in your SSH config file won't be used,
|
||
12 years ago
|
so it is important that you set them if things are not running on the default port::
|
||
13 years ago
|
|
||
12 years ago
|
badwolf.example.com:5309
|
||
13 years ago
|
|
||
12 years ago
|
Suppose you have just static IPs and want to set up some aliases that don't live in your host file, or you are connecting through tunnels. You can do things like this::
|
||
|
|
||
|
jumper ansible_ssh_port=5555 ansible_ssh_host=192.168.1.50
|
||
|
|
||
11 years ago
|
In the above example, trying to ansible against the host alias "jumper" (which may not even be a real hostname) will contact 192.168.1.50 on port 5555. Note that this is using a feature of the inventory file to define some special variables. Generally speaking this is not the best
|
||
|
way to define variables that describe your system policy, but we'll share suggestions on doing this later. We're just getting started.
|
||
|
|
||
|
Adding a lot of hosts? If you have a lot of hosts following similar patterns you can do this rather than listing each hostname::
|
||
12 years ago
|
|
||
12 years ago
|
|
||
|
[webservers]
|
||
12 years ago
|
www[01:50].example.com
|
||
12 years ago
|
|
||
11 years ago
|
For numeric patterns, leading zeros can be included or removed, as desired. Ranges are inclusive. You can also define alphabetic ranges::
|
||
12 years ago
|
|
||
|
[databases]
|
||
12 years ago
|
db-[a:f].example.com
|
||
12 years ago
|
|
||
11 years ago
|
You can also select the connection type and user on a per host basis::
|
||
12 years ago
|
|
||
|
[targets]
|
||
|
|
||
|
localhost ansible_connection=local
|
||
|
other1.example.com ansible_connection=ssh ansible_ssh_user=mpdehaan
|
||
|
other2.example.com ansible_connection=ssh ansible_ssh_user=mdehaan
|
||
|
|
||
11 years ago
|
As mentioned above, setting these in the inventory file is only a shorthand, and we'll discuss how to store them in individual files
|
||
|
in the 'host_vars' directory a bit later on.
|
||
13 years ago
|
|
||
11 years ago
|
.. _host_variables:
|
||
|
|
||
13 years ago
|
Host Variables
|
||
|
++++++++++++++
|
||
|
|
||
11 years ago
|
As alluded to above, it is easy to assign variables to hosts that will be used later in playbooks::
|
||
12 years ago
|
|
||
13 years ago
|
[atlanta]
|
||
|
host1 http_port=80 maxRequestsPerChild=808
|
||
|
host2 http_port=303 maxRequestsPerChild=909
|
||
|
|
||
11 years ago
|
.. _group_variables:
|
||
|
|
||
13 years ago
|
Group Variables
|
||
|
+++++++++++++++
|
||
|
|
||
12 years ago
|
Variables can also be applied to an entire group at once::
|
||
13 years ago
|
|
||
|
[atlanta]
|
||
|
host1
|
||
|
host2
|
||
|
|
||
|
[atlanta:vars]
|
||
|
ntp_server=ntp.atlanta.example.com
|
||
|
proxy=proxy.atlanta.example.com
|
||
|
|
||
11 years ago
|
.. _subgroups:
|
||
|
|
||
13 years ago
|
Groups of Groups, and Group Variables
|
||
|
+++++++++++++++++++++++++++++++++++++
|
||
13 years ago
|
|
||
12 years ago
|
It is also possible to make groups of groups and assign
|
||
13 years ago
|
variables to groups. These variables can be used by /usr/bin/ansible-playbook, but not
|
||
12 years ago
|
/usr/bin/ansible::
|
||
13 years ago
|
|
||
|
[atlanta]
|
||
|
host1
|
||
|
host2
|
||
|
|
||
|
[raleigh]
|
||
|
host2
|
||
|
host3
|
||
|
|
||
|
[southeast:children]
|
||
13 years ago
|
atlanta
|
||
|
raleigh
|
||
13 years ago
|
|
||
|
[southeast:vars]
|
||
|
some_server=foo.southeast.example.com
|
||
13 years ago
|
halon_system_timeout=30
|
||
|
self_destruct_countdown=60
|
||
|
escape_pods=2
|
||
13 years ago
|
|
||
|
[usa:children]
|
||
|
southeast
|
||
|
northeast
|
||
|
southwest
|
||
|
southeast
|
||
|
|
||
12 years ago
|
If you need to store lists or hash data, or prefer to keep host and group specific variables
|
||
12 years ago
|
separate from the inventory file, see the next section.
|
||
13 years ago
|
|
||
11 years ago
|
.. _splitting_out_vars:
|
||
|
|
||
12 years ago
|
Splitting Out Host and Group Specific Data
|
||
|
++++++++++++++++++++++++++++++++++++++++++
|
||
|
|
||
11 years ago
|
The preferred practice in Ansible is actually not to store variables in the main inventory file.
|
||
12 years ago
|
|
||
|
In addition to the storing variables directly in the INI file, host
|
||
|
and group variables can be stored in individual files relative to the
|
||
11 years ago
|
inventory file.
|
||
|
|
||
11 years ago
|
These variable files are in YAML format. See :doc:`YAMLSyntax` if you are new to YAML.
|
||
12 years ago
|
|
||
|
Assuming the inventory file path is::
|
||
|
|
||
|
/etc/ansible/hosts
|
||
|
|
||
|
If the host is named 'foosball', and in groups 'raleigh' and 'webservers', variables
|
||
|
in YAML files at the following locations will be made available to the host::
|
||
|
|
||
|
/etc/ansible/group_vars/raleigh
|
||
|
/etc/ansible/group_vars/webservers
|
||
|
/etc/ansible/host_vars/foosball
|
||
|
|
||
|
For instance, suppose you have hosts grouped by datacenter, and each datacenter
|
||
|
uses some different servers. The data in the groupfile '/etc/ansible/group_vars/raleigh' for
|
||
|
the 'raleigh' group might look like::
|
||
13 years ago
|
|
||
|
---
|
||
12 years ago
|
ntp_server: acme.example.org
|
||
|
database_server: storage.example.org
|
||
|
|
||
11 years ago
|
It is ok if these files do not exist, as this is an optional feature.
|
||
12 years ago
|
|
||
11 years ago
|
Tip: In Ansible 1.2 or later the group_vars/ and host_vars/ directories can exist in either
|
||
|
the playbook directory OR the inventory directory. If both paths exist, variables in the playbook
|
||
|
directory will be loaded second.
|
||
|
|
||
12 years ago
|
Tip: Keeping your inventory file and variables in a git repo (or other version control)
|
||
12 years ago
|
is an excellent way to track changes to your inventory and host variables.
|
||
13 years ago
|
|
||
11 years ago
|
.. _behavioral_parameters:
|
||
|
|
||
11 years ago
|
List of Behavioral Inventory Parameters
|
||
|
+++++++++++++++++++++++++++++++++++++++
|
||
|
|
||
11 years ago
|
As alluded to above, setting the following variables controls how ansible interacts with remote hosts. Some we have already
|
||
11 years ago
|
mentioned::
|
||
|
|
||
11 years ago
|
ansible_ssh_host
|
||
|
The name of the host to connect to, if different from the alias you wish to give to it.
|
||
|
ansible_ssh_port
|
||
|
The ssh port number, if not 22
|
||
|
ansible_ssh_user
|
||
|
The default ssh user name to use.
|
||
|
ansible_ssh_pass
|
||
|
The ssh password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys)
|
||
|
ansible_connection
|
||
|
Connection type of the host. Candidates are local, ssh or paramiko. The default is paramiko before Ansible 1.2, and 'smart' afterwards which detects whether usage of 'ssh' would be feasible based on whether ControlPersist is supported.
|
||
|
ansible_ssh_private_key_file
|
||
|
Private key file used by ssh. Useful if using multiple keys and you don't want to use SSH agent.
|
||
|
ansible_python_interpreter
|
||
11 years ago
|
The target host python path. This is useful for systems with more
|
||
11 years ago
|
than one Python or not located at "/usr/bin/python" such as \*BSD, or where /usr/bin/python
|
||
|
is not a 2.X series Python. We do not use the "/usr/bin/env" mechanism as that requires the remote user's
|
||
|
path to be set right and also assumes the "python" executable is named python, where the executable might
|
||
|
be named something like "python26".
|
||
|
ansible\_\*\_interpreter
|
||
|
Works for anything such as ruby or perl and works just like ansible_python_interpreter.
|
||
|
This replaces shebang of modules which will run on that host.
|
||
11 years ago
|
|
||
|
Examples from a host file::
|
||
|
|
||
|
some_host ansible_ssh_port=2222 ansible_ssh_user=manager
|
||
|
aws_host ansible_ssh_private_key_file=/home/example/.ssh/aws.pem
|
||
|
freebsd_host ansible_python_interpreter=/usr/local/bin/python
|
||
|
ruby_module_host ansible_ruby_interpreter=/usr/bin/ruby.1.9.3
|
||
|
|
||
12 years ago
|
|
||
13 years ago
|
.. seealso::
|
||
|
|
||
11 years ago
|
:doc:`intro_dynamic_inventory`
|
||
11 years ago
|
Pulling inventory from dynamic sources, such as cloud providers
|
||
11 years ago
|
:doc:`intro_adhoc`
|
||
13 years ago
|
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
|
|