Ansible/Directory Layout - Revision history

Admin: /* Option 3: Ansible Galaxy */

2018-12-07T22:29:26Z

Option 3: Ansible Galaxy

← Older revision		Revision as of 22:29, 7 December 2018
Line 133:		Line 133:

	<pre>		<pre>
	$ ansible-galaxy init playbooks/roles web		$ ansible-galaxy init -p playbooks/roles web
	</pre>		</pre>

Line 161:		Line 161:
	└── main.yml		└── main.yml
	</pre>		</pre>


	==Flags==		==Flags==

	{{AnsibleFlag}}		{{AnsibleFlag}}

Admin: /* Option 1: one size fits all */

2018-12-07T20:11:00Z

Option 1: one size fits all

← Older revision		Revision as of 20:11, 7 December 2018
Line 75:		Line 75:
	fooapp/ # ""		fooapp/ # ""
	</pre>		</pre>

			For details about each of these files (e.g., how to include what with what, how to name things in groups to work correctly, etc), see [[Ansible/Directory Layout/Details]]

	==Option 2: separate environments==		==Option 2: separate environments==

Admin: /* Option 1: one size fits all */

2018-12-07T20:05:16Z

Option 1: one size fits all

← Older revision		Revision as of 20:05, 7 December 2018
Line 2:		Line 2:

	Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#directory-layout Ansible documentation].		Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#directory-layout Ansible documentation].

	~~production/staging directories: This directory layout keeps production/staging environment host files separate.~~

	group_vars directory: contains yaml files that define variables for each of the groups we define.		group_vars directory: contains yaml files that define variables for each of the groups we define.
Line 34:		Line 32:

	<pre>		<pre>
	~~production~~ # inventory file ~~for production servers~~		hosts # inventory file
	~~staging # inventory file for staging environment~~

	group_vars/		group_vars/

Admin: /* Option 1: one size fits all */

2018-12-07T20:04:44Z

Option 1: one size fits all

← Older revision		Revision as of 20:04, 7 December 2018
Line 1:		Line 1:
	==Option 1: one size fits all==		==Option 1: one size fits all==

	Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#~~alternative-~~directory-layout Ansible documentation].		Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#directory-layout Ansible documentation].

	production/staging directories: This directory layout keeps production/staging environment host files separate.		production/staging directories: This directory layout keeps production/staging environment host files separate.

Admin: /* Option 1: one size fits all */

2018-12-07T19:07:55Z

Option 1: one size fits all

← Older revision		Revision as of 19:07, 7 December 2018
Line 13:		Line 13:
	site.yml is the master playbook that defines all the plays.		site.yml is the master playbook that defines all the plays.

	There is also a sub-playbook for each ~~"tier" (type of server)~~ - for example, ~~the~~ web ~~server and the~~ database ~~server are two separate tiers~~.		There is also a sub-playbook for each role - for example, web servers or database servers.

	Each role can either use the default or define its own set of each of the following:		Each role can either use the default, or define its own set of each of the following:
	* tasks		* tasks
	* handlers		* handlers
Line 23:		Line 23:
	* default values		* default values

	The "common" folder defines the above for all roles.		(Roles expect this info to be contained in a main.yml file.)

			The "common" folder defines the default values of all of the above, for all roles.

	The "webserver" folder would define the above for all hosts playing a webserver role.		The "webserver" folder would define the above for all hosts playing a webserver role.
Line 29:		Line 31:
	The "fooapp" folder would define the above for all hosts hosting the fooapp.		The "fooapp" folder would define the above for all hosts hosting the fooapp.

	~~Etc~~...		etc...

	<pre>		<pre>
Line 49:		Line 51:
	webservers.yml # playbook for webservers role		webservers.yml # playbook for webservers role
	dbservers.yml # playbook for dbservers role		dbservers.yml # playbook for dbservers role
			fooapp.yml # playbook for foo app

	roles/		roles/
	common/ # this hierarchy represents a "role"		common/ # this hierarchy represents defaults for a "role"
	tasks/ #		tasks/ #
	main.yml # <-- tasks file can include smaller files if warranted		main.yml # <-- tasks file can include smaller files if warranted

Admin: /* Option 1: one size fits all */

2018-12-07T19:05:01Z

Option 1: one size fits all

← Older revision		Revision as of 19:05, 7 December 2018
Line 3:		Line 3:
	Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-directory-layout Ansible documentation].		Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-directory-layout Ansible documentation].

	This keeps production/staging environment host files separate.		production/staging directories: This directory layout keeps production/staging environment host files separate.

	group_vars ~~folder~~ contains yaml files that define variables for each of the groups we define.		group_vars directory: contains yaml files that define variables for each of the groups we define.

	host_vars ~~folder~~ contains yaml files that define variables for each of the hosts.		host_vars directory: contains yaml files that define variables for each of the hosts.

			library, module_utils, and filter_utils directories: (not currently using any custom filters or modules... but this is where you would put them)

	site.yml is the master playbook that defines all the plays.		site.yml is the master playbook that defines all the plays.

	There is also a sub-playbook for each "tier" - the web server and the database server~~, for example~~.		There is also a sub-playbook for each "tier" (type of server) - for example, the web server and the database server are two separate tiers.

	Each role can either use the default or define its own set of each of the following:		Each role can either use the default or define its own set of each of the following:
Line 45:		Line 47:

	site.yml # master playbook		site.yml # master playbook
	webservers.yml # playbook for ~~webserver tier~~		webservers.yml # playbook for webservers role
	dbservers.yml # playbook for ~~dbserver tier~~		dbservers.yml # playbook for dbservers role

	roles/		roles/
Line 69:		Line 71:
	lookup_plugins/ # or other types of plugins, like lookup in this case		lookup_plugins/ # or other types of plugins, like lookup in this case

	~~webtier~~/ # same kind of structure as "common" was above, done for the ~~webtier~~ role		webservers/ # same kind of structure as "common" was above, done for the webservers role
	~~monitoring~~/ # ""		dbservers/ # ""
	fooapp/ # ""		fooapp/ # ""
	</pre>		</pre>

Admin at 02:29, 14 November 2018

2018-11-14T02:29:12Z

@@ Line 74: / Line 74: @@
 </pre>
-==Option 2==
+==Option 2: separate environments==
 An alternative layout that keeps the inventory file with the corresponding group and host variable files.
@@ Line 115: / Line 115: @@
 </pre>
 ==Flags==
 {{AnsibleFlag}}

Admin: /* Option 1 */

2018-11-14T02:26:36Z

Option 1

← Older revision		Revision as of 02:26, 14 November 2018
Line 1:		Line 1:
	==Option 1==		==Option 1: one size fits all==

	Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-directory-layout Ansible documentation].		Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-directory-layout Ansible documentation].
Line 73:		Line 73:
	fooapp/ # ""		fooapp/ # ""
	</pre>		</pre>


	==Option 2==		==Option 2==

Admin: Created page with "==Option 1== Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-direc..."

2018-11-13T18:52:15Z

Created page with "==Option 1== Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-direc..."

New page

==Option 1==

Here is a suggested directory layout from the [https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html?highlight=roles#alternative-directory-layout Ansible documentation].

This keeps production/staging environment host files separate.

group_vars folder contains yaml files that define variables for each of the groups we define.

host_vars folder contains yaml files that define variables for each of the hosts.

site.yml is the master playbook that defines all the plays.

There is also a sub-playbook for each "tier" - the web server and the database server, for example.

Each role can either use the default or define its own set of each of the following:
* tasks
* handlers
* templates
* files
* variables
* default values

The "common" folder defines the above for all roles.

The "webserver" folder would define the above for all hosts playing a webserver role.

The "fooapp" folder would define the above for all hosts hosting the fooapp.

Etc...

<pre>
production # inventory file for production servers
staging # inventory file for staging environment

group_vars/
group1.yml # here we assign variables to particular groups
group2.yml
host_vars/
hostname1.yml # here we assign variables to particular systems
hostname2.yml

library/ # if any custom modules, put them here (optional)
module_utils/ # if any custom module_utils to support modules, put them here (optional)
filter_plugins/ # if any custom filter plugins, put them here (optional)

site.yml # master playbook
webservers.yml # playbook for webserver tier
dbservers.yml # playbook for dbserver tier

roles/
common/ # this hierarchy represents a "role"
tasks/ #
main.yml # <-- tasks file can include smaller files if warranted
handlers/ #
main.yml # <-- handlers file
templates/ # <-- files for use with the template resource
ntp.conf.j2 # <------- templates end in .j2
files/ #
bar.txt # <-- files for use with the copy resource
foo.sh # <-- script files for use with the script resource
vars/ #
main.yml # <-- variables associated with this role
defaults/ #
main.yml # <-- default lower priority variables for this role
meta/ #
main.yml # <-- role dependencies
library/ # roles can also include custom modules
module_utils/ # roles can also include custom module_utils
lookup_plugins/ # or other types of plugins, like lookup in this case

webtier/ # same kind of structure as "common" was above, done for the webtier role
monitoring/ # ""
fooapp/ # ""
</pre>

==Option 2==

An alternative layout that keeps the inventory file with the corresponding group and host variable files.

This is useful when the variable files for each environment are not alike, so it is easier not to try and share things.

<pre>
inventories/
production/
hosts # inventory file for production servers
group_vars/
group1.yml # here we assign variables to particular groups
group2.yml
host_vars/
hostname1.yml # here we assign variables to particular systems
hostname2.yml

staging/
hosts # inventory file for staging environment
group_vars/
group1.yml # here we assign variables to particular groups
group2.yml
host_vars/
stagehost1.yml # here we assign variables to particular systems
stagehost2.yml

library/
module_utils/
filter_plugins/

site.yml
webservers.yml
dbservers.yml

roles/
common/
webtier/
monitoring/
fooapp/

</pre>

==Flags==

{{AnsibleFlag}}