Kenneth: /* Sample Ansible Setup */

2023-12-15T21:37:35Z

Sample Ansible Setup

Kenneth: /* Sample Ansible Setup */

2023-12-15T21:11:34Z

Sample Ansible Setup

Kenneth: /* Galaxy Framework */

2023-12-15T20:58:35Z

Galaxy Framework

Kenneth: /* AWX */

2023-12-15T20:51:52Z

AWX

Kenneth: /* Ansible */

2022-08-18T22:35:30Z

Ansible

New page

== Ansible ==

== Install ==

Sample 2.10.7 version:
sudo pip3 uninstall ansible ansible-base ansible-core
sudo pip3 install ansible==2.10.7

== OS Version ==

<pre>
{{ansible_distribution}} - Debian / Ubuntu
{{ansible_distribution_release}} - buster / focal
{{ansible_distribution_version}} - 10 / 18.04
{{ansible_distribution_major_version}} - 10 / 18
</pre>
== copy ==

copy - Copies files to remote locations — Ansible Documentation
https://docs.ansible.com/ansible/2.6/modules/copy_module.html

<pre>
- name: example copying file with owner and permissions
copy:
src: /srv/myfiles/foo.conf
dest: /etc/foo.conf
owner: foo
group: foo
mode: 0644
</pre>

<pre>
- name: example copying file with owner and permissions
copy: src=foo.conf dest=/etc/foo.conf
</pre>

== Ansible Misc ==

~/metricbeat/metricbeat.yml
<pre>
metricbeat.modules:
- module: system
metricsets:
- cpu
- filesystem
- memory
- network
- process
enabled: true
period: 10s
processes: ['.*']
cpu_ticks: false
- module: docker
metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
hosts: ["unix:///var/run/docker.sock"]
period: 100s
output.elasticsearch:
hosts: ["test.oeey.com:9200"]
setup.kibana:
host: "test.oeey.com:8081"
</pre>

---

Working With Playbooks — Ansible Documentation - https://docs.ansible.com/ansible/latest/user_guide/playbooks.html

Intro to Playbooks — Ansible Documentation - https://docs.ansible.com/ansible/2.5/user_guide/playbooks_intro.html

YAML Syntax — Ansible Documentation - https://docs.ansible.com/ansible/2.5/reference_appendices/YAMLSyntax.html#yaml-syntax

---

Here’s a playbook that contains just one play:
<pre>
---
- hosts: webservers
vars:
http_port: 80
max_clients: 200
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum:
name: httpd
state: latest
- name: write the apache config file
template:
src: /srv/httpd.j2
dest: /etc/httpd.conf
notify:
- restart apache
- name: ensure apache is running (and enable it at boot)
service:
name: httpd
state: started
enabled: yes
handlers:
- name: restart apache
service:
name: httpd
state: restarted
</pre>

== YAML ==

See [[YAML]]

YAML Syntax — Ansible Documentation - https://docs.ansible.com/ansible/2.5/reference_appendices/YAMLSyntax.html#yaml-syntax

== Raspberry Pi ==

How to Setup the Raspberry Pi 3 Using Ansible | Datahovel - https://datahovel.com/2016/03/20/how-to-setup-the-raspberry-pi-using-ansible/

ansible-playground/raspbian-bootstrap at master · Condla/ansible-playground · GitHub - https://github.com/Condla/ansible-playground/tree/master/raspbian-bootstrap

Automating Raspberry Pi setup with Ansible - http://www.hietala.org/automating-raspberry-pi-setup-with-ansible.html

--

Raspbian Bootstrap

This is simple ansible playbook to setup one or more of your Raspberry Pis running a fresh Raspbian installation on it. I used the imag
e from March 2016 available to download from the official website. This playbook bootstraps your Raspberry Pi 3 to be used over your WPA
Wifi network, if you provide a correct SSID and password as a playbook variable. It will additionally install software required to use
Amazon's AWS IoT NodeJS SDK. (http://docs.aws.amazon.com/iot/latest/developerguide/iot-device-sdk-node.html).

After the first time boot of your Raspberry Pi, follow these few steps in order to bootstrap your machine.
* Install Ansible and Git on your "Controller" machine.
* Clone this git repository.
* Configure hostname/IP address in the "hosts" file
* Unfortunately: Login to Raspi and expand SD card with "sudo raspi-config" -
This will be automated in the future!
* Exectute playbook

<pre>
# Install Ansible and Git on the machine.
sudo apt-get install python-pip git python-dev sshpass
sudo pip install ansible

# Clone this repo:
git clone https://github.com/Condla/ansible-playground.git
cd ansible-playground/raspbian-bootstrap/

# Configure IP address in "hosts" file. If you have more than one
# Raspberry Pi, add more lines and enter details

# Execute playbook
./playbook.yml
</pre>

Small sample:

files:
ansible.cfg files/ hosts playbook.yml README.md templates/
</pre>

ansible.cfg:
<pre>
[defaults]
hostfile = ./hosts
inventory = ./hosts
</pre>

hosts:
<pre>
[local]
localhost
</pre>

playbook.yml:
<pre>
#!/usr/bin/env ansible-playbook
---
- hosts: local
gather_facts: yes
connection: local
vars:

packages_to_install: [
build-essential, tree,
]

pip_packages_to_install: [ pip, pySerial ]

tasks:

- name: install ubuntu packages
apt: pkg={{ item }} state=present
with_items: '{{packages_to_install}}'
become: yes

- name: install python modules
pip: name={{ item }}
with_items: '{{pip_packages_to_install}}'
become: yes
</pre>

---

helloworld-playbook.yml
<pre>
#!/usr/bin/env ansible-playbook

---
- name: This is a hello-world example
hosts: local
tasks:
- name: Create a file called '/tmp/testfile.txt' with the content 'hello world'.
copy: content="hello world\n" dest=/tmp/testfile.txt
</pre>

Ansible – A “hello world” Playbook – Codingbee - https://codingbee.net/tutorials/ansible/ansible-a-hello-world-playbook

To avoid the "no host matching" use:
hosts: localhost

== Hello World ==

Ansible – A “hello world” Playbook – Codingbee - https://codingbee.net/tutorials/ansible/ansible-a-hello-world-playbook

tower-example/helloworld.yml at master · ansible/tower-example · GitHub - https://github.com/ansible/tower-example/blob/master/helloworld.yml

== Logging ==

ansible.cfg:
[defaults]
log_path = /var/log/ansible.log

Via ENV:
export ANSIBLE_LOG_PATH=~/ansible.log

Enable debug:
export ANSIBLE_DEBUG=True

== Apt ==

apt - Manages apt-packages — Ansible Documentatio -
https://docs.ansible.com/ansible/latest/modules/apt_module.html

<pre>
- name: Remove "foo" package
apt:
name: foo
state: absent
</pre>

<pre>
- name: Install a list of packages
apt:
name: "{{ packages }}"
vars:
packages:
- foo
- foo-tools
</pre>

== Pip ==

Ansible Pip Module - Managing Python Packages - Ansible Tutorials -
http://www.mydailytutorials.com/ansible-pip-module/

pip - Manages Python library dependencies — Ansible Documentation -
https://docs.ansible.com/ansible/2.6/modules/pip_module.html

<pre>
tasks:
- name: Installing NumPy python library using Ansible pip module
pip:
name: NumPy
</pre>

<pre>
tasks:
- name: Update Pip
pip:
name: pip
state: latest
- name: Specific fabric
pip:
name: fabric<2.0
- name: More Pip packages
pip:
name: python-jenkins jira slackclient
</pre>

-

pip - Ansible: install multiple Python packages on a single session - Stack Overflow
https://stackoverflow.com/questions/31396130/ansible-install-multiple-python-packages-on-a-single-session

<pre>
- name: "Install Python Packages: {{ python_packages_to_install }}"
pip: name={{ item }}
with_items: "{{ python_packages_to_install }}"
vars:
python_packages_to_install:
- fabric<2.0
- python-jenkins
- jira
- slackclient
- xmodem
- pySerial
- numpy
</pre>

== NFS ==

mount - Control active and configured mount points — Ansible Documentation -
https://docs.ansible.com/ansible/2.5/modules/mount_module.html

<pre>
tasks:
- name: nfs-store5 NFS
mount:
name: /nfs-store5
src: nfs-store5:/wbt
fstype: nfs
state: mounted
</pre>

== Dry Run ==

Dry Run: [https://docs.ansible.com/ansible/2.5/user_guide/playbooks_checkmode.html]
ansible-playbook --check playbook.yml

== Include Playbook ==

<pre>
- include: other.yml
</pre>

And Include at different levels
<pre>
Tasks:
- include tasks.yml
</pre>

== Create Empty File ==

<pre>
- name: ensure file exists
copy:
content: ""
dest: /etc/nologin
force: no
group: sys
owner: root
mode: 0555
</pre>

This will touch a file each time (yellow update each time) [https://stackoverflow.com/questions/28347717/how-to-create-an-empty-file-with-ansible]
<pre>
- name: create fake 'nologin' shell
file: path=/etc/nologin state=touch owner=root group=sys mode=0555
</pre>

With command module:
<pre>
- name: Create file
command: touch /path/to/file
args:
creates: /path/to/file
</pre>

== Remove File ==

<pre>
- name: Clear Pi Warnings
hosts: localhost
tasks:

- name: Remove pi password warning
file:
state: absent
path: /etc/profile.d/sshpwd.sh

- name: Remove Wifi warning
file:
state: absent
path: /etc/profile.d/wifi-country.sh
</pre>

== Execute Script ==

script - Runs a local script on a remote node after transferring it — Ansible Documentation -
https://docs.ansible.com/ansible/2.6/modules/script_module.html

<pre>
# Example from Ansible Playbooks
- script: /some/local/script.sh --some-arguments 1234

# Run a script that creates a file, but only if the file is not yet created
- script: /some/local/create_file.sh --some-arguments 1234
args:
creates: /the/created/file.txt

# Run a script that removes a file, but only if the file is not yet removed
- script: /some/local/remove_file.sh --some-arguments 1234
args:
removes: /the/removed/file.txt

# Run a script using a executable in a non-system path
- script: /some/local/script
args:
executable: /some/remote/executable

# Run a script using a executable in a system path
- script: /some/local/script.py
args:
executable: python3
</pre>

== Execute Shell ==

shell - Execute commands in nodes. — Ansible Documentation -
https://docs.ansible.com/ansible/2.5/modules/shell_module.html

<pre>
- name: Execute the command in remote shell; stdout goes to the specified file on the remote.
shell: somescript.sh >> somelog.txt

- name: Change the working directory to somedir/ before executing the command.
shell: somescript.sh >> somelog.txt
args:
chdir: somedir/

# You can also use the 'args' form to provide the options.
- name: This command will change the working directory to somedir/ and will only run when somedir/somelog.txt doesn't exist.
shell: somescript.sh >> somelog.txt
args:
chdir: somedir/
creates: somelog.txt

- name: Run a command that uses non-posix shell-isms (in this example /bin/sh doesn't handle redirection and wildcards together but bash does)
shell: cat < /tmp/*txt
args:
executable: /bin/bash

- name: Run a command using a templated variable (always use quote filter to avoid injection)
shell: cat {{ myfile|quote }}

# You can use shell to run other executables to perform actions inline
- name: Run expect to wait for a successful PXE boot via out-of-band CIMC
shell: |
set timeout 300
spawn ssh admin@{{ cimc_host }}

expect "password:"
send "{{ cimc_password }}\n"

expect "\n{{ cimc_name }}"
send "connect host\n"

expect "pxeboot.n12"
send "\n"

exit 0
args:
executable: /usr/bin/expect
delegate_to: localhost
</pre>

== Download File ==

get_url - Downloads files from HTTP, HTTPS, or FTP to node — Ansible Documentation -
https://docs.ansible.com/ansible/2.5/modules/get_url_module.html

<pre>
- name: Download foo.conf
get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
mode: 0440

- name: Download file and force basic auth
get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
force_basic_auth: yes

- name: Download file with custom HTTP headers
get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
headers: 'key:value,key:value'

- name: Download file with check (sha256)
get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
checksum: sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c

- name: Download file with check (md5)
get_url:
url: http://example.com/path/file.conf
dest: /etc/foo.conf
checksum: md5:66dffb5228a211e61d6d7ef4a86f5758

- name: Download file from a file path
get_url:
url: file:///tmp/afile.txt
dest: /tmp/afilecopy.txt
</pre>

== Build Program from Source ==

Using Ansible to Compile NGINX from Sources with Custom Modules -
https://medium.com/bigpanda-engineering/using-ansible-to-compile-nginx-from-sources-with-custom-modules-f6e6c6a42493

compile_nginx_from_sources.yml:
<pre>
---

- name: Compile NGINX from sources
hosts: webserver
vars:
nginx_version: nginx-1.13.4
nginx_tarball_url: "http://nginx.org/download/{{ nginx_version }}.tar.gz"
nginx_install_dir: "/tmp/{{ nginx_version }}"
nginx_sbin_path: "/usr/sbin/nginx"
nginx_conf_path: "/etc/nginx/nginx.conf"
nginx_custom_modules: "--with-http_auth_request_module"

tasks:
- name: Installing NGINX Dependencies
become: yes
apt:
name: "{{ item }}"
update_cache: yes
with_items:
- libssl-dev
- zlib1g-dev
- libpcre3
- libpcre3-dev
- unzip

- name: Downloading NGINX sources
get_url:
url: "{{ nginx_tarball_url }}"
dest: "/tmp/{{ nginx_version }}.tar.gz"
register: nginx_source

- name: Unpacking NGINX
unarchive:
copy: no
dest: /tmp/
src: "{{ nginx_source.dest }}"
when: nginx_source.changed
register: nginx_source_unpack

- name: Create required Nginx dirs
become: yes
file:
path: /etc/nginx
state: directory
owner: root
mode: 0755

- name: Configuring NGINX source with custom modules
command: "./configure --sbin-path={{ nginx_sbin_path }} --conf-path={{ nginx_conf_path }} {{ nginx_custom_modules }}"
args:
chdir: "{{ nginx_install_dir }}"
when: nginx_source_unpack|changed
register: nginx_configure

- name: Installing NGINX
become: yes
shell: make && make install
args:
chdir: "{{ nginx_install_dir }}"
when: nginx_configure|changed

- name: Creating NGINX conf file
become: yes
template:
src: nginx.conf
dest: "{{ nginx_conf_path }}"
owner: "{{ ansible_user }}"
group: "{{ ansible_user }}"
mode: 0644

- name: Installing NGINX init script (service)
become: yes
template:
src: nginx.init
dest: /etc/init.d/nginx
owner: root
group: root
mode: 0755

- name: Starting NGINX
become: yes
service:
name: nginx
state: started
</pre>

== Build tio ==

tio.yml:
<pre>
- name: Compile tio from sources
hosts: localhost
vars:
tio_version: v1.30
tio_install_dir: "/root/.src/tio"
tio_sbin_path: "/usr/local/bin/tio"

tasks:
- name: Git fun
git:
name: 'https://github.com/tio/tio.git'
dest: "{{tio_install_dir}}"
version: "{{tio_version}}"
register: tio_git

- name: Make tio configure
command: "sh autogen.sh"
args:
chdir: "{{ tio_install_dir }}"
creates: "{{tio_sbin_path}}"
register: tio_make_configure

- name: Configuring tio source
command: "./configure"
args:
chdir: "{{ tio_install_dir }}"
when: tio_make_configure|changed
register: tio_configure

- name: Installing tio
become: yes
shell: make && make install
args:
chdir: "{{ tio_install_dir }}"
when: tio_configure|changed
</pre>

== Encrypt Files ==

Create new file:
ansible-vault create --vault-id test@multi_password_file foo.yml

Encrypt existing:
ansible-vault encrypt foo.yml bar.yml baz.yml
ansible-vault encrypt --vault-id project@prompt foo.yml bar.yml baz.yml

View encrypted file:
ansible-vault view foo.yml bar.yml baz.yml

Decrypt file:
ansible-vault decrypt foo.yml bar.yml baz.yml

Always use a password file:
alias ansible='ansible-playbook --vault-id /etc/ansible/password'
alias ansible-playbook='ansible-playbook --vault-id /etc/ansible/password'

ref: [https://docs.ansible.com/ansible/latest/user_guide/vault.html]

== AWX ==

AWX provides a web-based user interface, REST API, and task engine built on top of Ansible. It is the upstream project for Tower, a commercial derivative of AWX.

https://github.com/ansible/awx

AWX stands for "Ansible WorX" a play on AnsibleWorks.

Ref: [https://groups.google.com/forum/#!topic/awx-project/DncUXeoZUUg] [https://github.com/ansible/awx/commit/5c6895e6065a81f4483dfb6bc7650706f8866e1e]

--

<blockquote>
AWX in Ansible AWX stands for Ansible WorX

It is found inside this commit https://github.com/ansible/awx/commit/5c6895e6065a81f4483dfb6bc7650706f8866e1e

They used an X instead of ks
</blockquote>

ref: https://stackoverflow.com/questions/63509580/ansible-awx-what-awx-stands-for

== keywords ==

Test

@@ Line 757: / Line 757: @@
      - linux-common
 </pre>
 See https://docs.ansible.com/ansible/latest/tips_tricks/sample_setup.html

@@ Line 718: / Line 718: @@
 ansible.cfg
-inventory
+inventory/
 group_vars/
@@ Line 738: / Line 739: @@
 </pre>
 See https://docs.ansible.com/ansible/latest/tips_tricks/sample_setup.html

@@ Line 684: / Line 684: @@
 == Galaxy Framework ==
-=== Galaxy Framework Initalize ===
+=== Galaxy Framework Role Initalize ===
   ansible-galaxy init [role]
@@ Line 712: / Line 712: @@
 See https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html#collection-init
 == keywords ==
 Test

@@ Line 681: / Line 681: @@
 ref: https://stackoverflow.com/questions/63509580/ansible-awx-what-awx-stands-for
 == keywords ==
 Test

Ansible - Revision history

Kenneth: /* Sample Ansible Setup */

Kenneth: /* Sample Ansible Setup */

Kenneth: /* Galaxy Framework */

Kenneth: /* AWX */

Kenneth: /* Ansible */