Ansible - Revision history

Aarch0x40: Corrected syntax for system service declaration

2023-11-02T04:11:29Z

Corrected syntax for system service declaration

← Older revision		Revision as of 04:11, 2 November 2023
Line 68:		Line 68:
	<pre>		<pre>
	- name: Make "lighttpd" start on boot and start now, if not started.		- name: Make "lighttpd" start on boot and start now, if not started.
	ansible-builtin.service:		ansible.builtin.service:
	name: lighttpd		name: lighttpd
	enabled: true		enabled: true

Psykose: language nit

2023-01-30T00:26:52Z

language nit

← Older revision		Revision as of 00:26, 30 January 2023
Line 99:		Line 99:
	=== ansible-lint ===		=== ansible-lint ===

	You can check if using "[https://ansible-lint.readthedocs.io/ proven practices]",		You can check if you're using "[https://ansible-lint.readthedocs.io/ proven practices]",
	by installing the {{Pkg\|ansible-lint}} package and running:		by installing the {{Pkg\|ansible-lint}} package and running:

Encode: Add note about needing to install ansible-lint

2023-01-28T20:51:35Z

Add note about needing to install ansible-lint

← Older revision		Revision as of 20:51, 28 January 2023
Line 99:		Line 99:
	=== ansible-lint ===		=== ansible-lint ===

	~~Check~~ if using "[https://ansible-lint.readthedocs.io/ proven practices]":		You can check if using "[https://ansible-lint.readthedocs.io/ proven practices]",
			by installing the {{Pkg\|ansible-lint}} package and running:

	{{Cmd\|$ ansible-lint -s ./PATH}}		{{Cmd\|$ ansible-lint -s ./PATH}}

Encode: Add ansible-lint

2023-01-28T20:46:05Z

Add ansible-lint

← Older revision		Revision as of 20:46, 28 January 2023
Line 6:		Line 6:
	It uses SSH for the communication between the involved systems, no server or client daemons are needed, and no additional software beside Python on managed nodes is required.		It uses SSH for the communication between the involved systems, no server or client daemons are needed, and no additional software beside Python on managed nodes is required.

	= Installation =		== Installation ==

	On the control node (master host), you can install the {{Pkg\|ansible-core}} package and/or the {{Pkg\|ansible}} package, which is a "batteries included" package that brings in {{Pkg\|ansible-core}} along with a set of curated [https://docs.ansible.com/collections.html collections]. Both are available from the [[Repositories#Community\|community]] repository:		On the control node (master host), you can install the {{Pkg\|ansible-core}} package and/or the {{Pkg\|ansible}} package, which is a "batteries included" package that brings in {{Pkg\|ansible-core}} along with a set of curated [https://docs.ansible.com/collections.html collections]. Both are available from the [[Repositories#Community\|community]] repository:
Line 14:		Line 14:
	{{Cmd\|# apk add ansible}}		{{Cmd\|# apk add ansible}}

	== Create a SSH key ==		=== Create a SSH key ===

	Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.		Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.
Line 20:		Line 20:
	{{Cmd\|$ ssh-keygen -t ed25519}}		{{Cmd\|$ ssh-keygen -t ed25519}}

	= Managed nodes =		== Managed nodes ==

	There are only minimal requirements for the clients. For every system you want to manage, you need to have the client's SSH key in the <code>authorized_keys</code> file of the management system and Python.		There are only minimal requirements for the clients. For every system you want to manage, you need to have the client's SSH key in the <code>authorized_keys</code> file of the management system and Python.
Line 28:		Line 28:
	{{Cmd\|# apk add python3}}		{{Cmd\|# apk add python3}}

	== Transfer the SSH key ==		=== Transfer the SSH key ===
	There are two ways to do it. From a default Alpine installation you can use ssh and cat to do it.		There are two ways to do it. From a default Alpine installation you can use ssh and cat to do it.

Line 37:		Line 37:
	{{Cmd\|ssh-copy-id -i ~/.ssh/id_ed25519.pub root@[IP of the management system]}}		{{Cmd\|ssh-copy-id -i ~/.ssh/id_ed25519.pub root@[IP of the management system]}}

	= Usage =		== Usage ==

	== Configuration ==		=== Configuration ===

	{{Todo\|https://docs.ansible.com/ansible/latest/reference_appendices/config.html}}		{{Todo\|https://docs.ansible.com/ansible/latest/reference_appendices/config.html}}

	== Inventory ==		=== Inventory ===

	The inventory is the list of managed nodes or "hosts". The default location is <code>/etc/ansible/hosts</code>. You can specify a different inventory file using <code>-i PATH</code> on the command line.		The inventory is the list of managed nodes or "hosts". The default location is <code>/etc/ansible/hosts</code>. You can specify a different inventory file using <code>-i PATH</code> on the command line.
Line 55:		Line 55:
	10.0.1.50}}		10.0.1.50}}

	== Ping ==		=== Ping ===

	Check that you can reach all nodes:		Check that you can reach all nodes:
Line 61:		Line 61:
	{{Cmd\|$ ansible all -m ping}}		{{Cmd\|$ ansible all -m ping}}

	== Playbooks ==		=== Playbooks ===
	When writing playbooks for Alpine Linux there are some things to keep in mind:		When writing playbooks for Alpine Linux there are some things to keep in mind:

Line 93:		Line 93:
	</ol>		</ol>

	== Vault ==		=== Vault ===

	{{Todo\|https://docs.ansible.com/ansible/latest/vault_guide/index.html}}		{{Todo\|https://docs.ansible.com/ansible/latest/vault_guide/index.html}}

	=See Also=		=== ansible-lint ===

			Check if using "[https://ansible-lint.readthedocs.io/ proven practices]":

			{{Cmd\|$ ansible-lint -s ./PATH}}

			== See Also ==

	* https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html - Official documentation for the apk module.		* https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html - Official documentation for the apk module.

Encode: Expand + update formatting/wording

2023-01-12T00:58:29Z

Expand + update formatting/wording

← Older revision		Revision as of 00:58, 12 January 2023
Line 1:		Line 1:
	[http://ansible.com/ ansible] is a simple configuration management, deployment, task-execution, and multinode orchestration framework. It uses SSH for the communication between the involved systems, no server or client daemons are needed, and no additional software beside Python on client boxes is required.		{{Expand}}
			{{TOC right}}

	~~= Installation of ansible =~~		[https://www.ansible.com/ Ansible] is a simple configuration management, deployment, task-execution, and multinode orchestration framework.
	ansible is ~~available in ''main''~~.

	{{Cmd\|apk add ansible}}		It uses SSH for the communication between the involved systems, no server or client daemons are needed, and no additional software beside Python on managed nodes is required.

			= Installation =

			On the control node (master host), you can install the {{Pkg\|ansible-core}} package and/or the {{Pkg\|ansible}} package, which is a "batteries included" package that brings in {{Pkg\|ansible-core}} along with a set of curated [https://docs.ansible.com/collections.html collections]. Both are available from the [[Repositories#Community\|community]] repository:

			{{Tip\|If you don't know you need {{Pkg\|ansible-core}}, I would recommend installing {{Pkg\|ansible}}.}}

			{{Cmd\|# apk add ansible}}

	== Create a SSH key ==		== Create a SSH key ==

	Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.		Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.

	{{Cmd\|ssh-keygen -t ed25519}}		{{Cmd\|$ ssh-keygen -t ed25519}}

	= Managed nodes =		= Managed nodes =

	There are only minimal requirements for the clients. For every system you want to manage, you need to have the client's SSH key in the <code>authorized_keys</code> file of the management system and Python.		There are only minimal requirements for the clients. For every system you want to manage, you need to have the client's SSH key in the <code>authorized_keys</code> file of the management system and Python.

	Install the Python package.		Install the Python package:

	{{Cmd\|apk add python3}}		{{Cmd\|# apk add python3}}

	== Transfer the SSH key ==		== Transfer the SSH key ==
Line 27:		Line 37:
	{{Cmd\|ssh-copy-id -i ~/.ssh/id_ed25519.pub root@[IP of the management system]}}		{{Cmd\|ssh-copy-id -i ~/.ssh/id_ed25519.pub root@[IP of the management system]}}

	= ~~Setup hosts~~ =		= Usage =
	Add all your remote systems to <code>/etc/ansible/hosts</code>. For details, please refer to [https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#hosts-and-groups Hosts and Groups] in the ansible documentation.

	~~{{Cat\|/etc/ansible/hosts\|~~		== Configuration ==
	~~192.168.1.50~~
	~~10.0.0.12~~
	~~webserver.example.org~~
	~~mail.example.org}}~~

	~~= First test =~~		{{Todo\|https://docs.ansible.com/ansible/latest/reference_appendices/config.html}}

	~~{{Cmd\|$ ansible all -m ping -u you}}~~		== Inventory ==

	~~Another test~~ is ~~check all variables~~.		The inventory is the list of managed nodes or "hosts". The default location is <code>/etc/ansible/hosts</code>. You can specify a different inventory file using <code>-i PATH</code> on the command line.
			See [https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html How to build your inventory] for more information.

	{{~~Cmd~~\|# ansible [~~IP of your Alpine Linux box~~] ~~-m setup}}~~		{{Cat\|/etc/ansible/hosts\|[control]
			10.0.0.5

	= Playbooks =		[managed]
	When writing playbooks for Alpine Linux there are ~~modules~~ to keep in mind:		10.0.1.5
			10.0.1.50}}

			== Ping ==

			Check that you can reach all nodes:

			{{Cmd\|$ ansible all -m ping}}

			== Playbooks ==
			When writing playbooks for Alpine Linux there are some things to keep in mind:

	<ol>		<ol>
	<li>There is support for OpenRC, the [[~~Alpine_Linux_Init_System~~\|Init System]], in the service module.		<li>There is support for OpenRC, the [[OpenRC\|Init System]], in the [https://docs.ansible.com/ansible/latest/collections/ansible/builtin/service_module.html service] module.
	<pre>		<pre>
	- service:		- name: Make "lighttpd" start on boot and start now, if not started.
	name: lighttpd		ansible-builtin.service:
	enabled: ~~yes~~		name: lighttpd
	state: started		enabled: true
			state: started
	</pre>		</pre>
	<li>There is support for [[~~Alpine_Linux_package_management~~\|APK]] as of Ansible 2.0.		<li>There is support for [[Alpine_Package_Keeper\|APK]] as of Ansible 2.0, in the [https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html apk] module.
	<pre>		<pre>
	- apk:		- name: Ensure lighttpd is installed, update cache and install if not.
	name: lighttpd		community.general.apk:
	state: present		name: lighttpd
	update_cache: yes		state: present
			update_cache: yes
	</pre>		</pre>
	<li>There is support for the [[Alpine_Wall\|Awall]] firewall as of Ansible 2.4.		<li>There is support for the [[Alpine_Wall\|Awall]] firewall as of Ansible 2.4, in the [https://docs.ansible.com/ansible/latest/collections/community/general/awall_module.html awall] module.
	<pre>		<pre>
	- awall:		- name: Enable "foobar" policy
	name: ~~policyfile~~		community.general.awall:
	state: enabled		name: foobar
	activate: ~~yes~~		state: enabled
			activate: true
	</pre>		</pre>
	<li>If you are going to re-use playbooks from other Linux ~~distribution~~, please keep in mind that Alpine Linux uses different paths for the binaries. <code>/bin/rm</code>		<li>
			If you are going to re-use playbooks from other Linux distributions, please keep in mind that Alpine Linux uses different paths for the binaries. For example <code>rm</code> is <code>/bin/rm</code>.
	</ol>		</ol>

	~~The [http~~://~~git~~.~~alpinelinux~~.~~org~~/~~user~~/~~fab~~/~~alpine-ansible~~/ ~~alpine-ansible git repository] contain some example playbooks~~.		== Vault ==

			{{Todo\|https://docs.ansible.com/ansible/latest/vault_guide/index.html}}

	=See Also=		=See Also=

	* https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html - Official documentation for the apk module.		* https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html - Official documentation for the apk module.
			* [https://wiki.archlinux.org/title/Ansible ArchWiki: Ansible]

	[[Category:Installation]]		[[Category:Installation]]
			[[Category:System_Administration]]

Encode: Link to the Official documentation for the apk module

2023-01-11T21:23:51Z

Link to the Official documentation for the apk module

← Older revision		Revision as of 21:23, 11 January 2023
Line 75:		Line 75:

	=See Also=		=See Also=
	*~~[[Ansible APK Module]]~~
			* https://docs.ansible.com/ansible/latest/collections/community/general/apk_module.html - Official documentation for the apk module.

	[[Category:Installation]]		[[Category:Installation]]

Spoon: /* Playbooks */

2020-04-29T07:49:48Z

Playbooks

← Older revision		Revision as of 07:49, 29 April 2020
Line 72:		Line 72:
	</ol>		</ol>

	The [http://git.alpinelinux.org/~~cgit~~/fab/alpine-ansible/ alpine-ansible git repository] contain some example playbooks.		The [http://git.alpinelinux.org/user/fab/alpine-ansible/ alpine-ansible git repository] contain some example playbooks.

	=See Also=		=See Also=

Yjftsjthsd-a: /* First test */

2020-01-26T02:05:06Z

First test

← Older revision		Revision as of 02:05, 26 January 2020
Line 38:		Line 38:
	= First test =		= First test =

	{{Cmd\|$ ansible all -m ping -u you ~~--sudo~~}}		{{Cmd\|$ ansible all -m ping -u you}}

	Another test is check all variables.		Another test is check all variables.

Yjftsjthsd-a: /* Managed nodes */

2020-01-26T02:04:04Z

Managed nodes

← Older revision		Revision as of 02:04, 26 January 2020
Line 16:		Line 16:
	Install the Python package.		Install the Python package.

	{{Cmd\|apk add ~~python~~}}		{{Cmd\|apk add python3}}

	== Transfer the SSH key ==		== Transfer the SSH key ==
	There are two ways to do it. From a default Alpine installation you can use ssh and cat to do it.		There are two ways to do it. From a default Alpine installation you can use ssh and cat to do it.

	{{Cmd\|<nowiki>ssh root@[IP of the management system] 'cat ~/.ssh/~~id_rsa~~.pub' \| cat - >> ~/.ssh/authorized_keys</nowiki>}}		{{Cmd\|<nowiki>ssh root@[IP of the management system] 'cat ~/.ssh/id_ed25519.pub' \| cat - >> ~/.ssh/authorized_keys</nowiki>}}

	If you are planning to use additional features of SSH. <code>ssh-copy-id</code>, which is provided by the <code>openssh-client</code> package, can help you with the key setup.		If you are planning to use additional features of SSH. <code>ssh-copy-id</code>, which is provided by the <code>openssh-client</code> package, can help you with the key setup.

	{{Cmd\|ssh-copy-id -i ~/.ssh/~~id_rsa~~.pub root@[IP of the management system]}}		{{Cmd\|ssh-copy-id -i ~/.ssh/id_ed25519.pub root@[IP of the management system]}}

	= Setup hosts =		= Setup hosts =

Yjftsjthsd-a: /* Installation of ansible */

2020-01-26T02:02:30Z

Installation of ansible

← Older revision		Revision as of 02:02, 26 January 2020
Line 2:		Line 2:

	= Installation of ansible =		= Installation of ansible =
	ansible is available in ''~~testing~~''~~. The latest package is broken, sorry~~.		ansible is available in ''main''.

	{{Cmd\|apk add ansible}}		{{Cmd\|apk add ansible}}
Line 9:		Line 9:
	Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.		Generate a SSH key for the managed node. It's recommended to use a key which is protected with a password.

	{{Cmd\|ssh-keygen -t ~~rsa~~}}		{{Cmd\|ssh-keygen -t ed25519}}

	= Managed nodes =		= Managed nodes =