Project

General

Profile

Ansible cheat sheet » History » Version 12

Jon Goldberg, 12/13/2022 08:50 PM

1 1 Jon Goldberg
{{last_updated_at}} by {{last_updated_by}}
2
3
# Ansible cheat sheet
4
5 3 Irene Meisel
This page will cover some helpful one-line commands we can execute with Ansible to accomplish various tasks. Always run **git pull** and **git submodule update** before executing these commands.
6 1 Jon Goldberg
7 6 Jon Goldberg
### Synchronize a non-canonical site with the live site's database
8 2 Jon Goldberg
```
9 1 Jon Goldberg
ansible-playbook main-playbook.yml --tags site-db-sync -l mysite.local 
10 2 Jon Goldberg
```
11 6 Jon Goldberg
* This works on test and dev sites.
12
* Depending on the sync strategy on the website inventory, it will pull from last night's backup, sync directly from the live site, or use the Pantheon API to make a backup/download.
13 1 Jon Goldberg
* Only sites that pull from backup can sync to a site that's not on your local machine at present (I'll fix this at some point).
14
15 6 Jon Goldberg
### Ad-hoc examples
16 1 Jon Goldberg
#### Revert a failed local update
17
```shell
18
ansible '*.local' -m shell -a "cd {{webroot}} && git checkout ." --become --become-user "{{ run_as_user }}" 
19
```
20 4 Jon Goldberg
21 6 Jon Goldberg
#### Roll back a site to the latest commit (e.g. after a failed merge):
22
```shell
23 8 Jon Goldberg
ansible --become --become-user="{{ run_as_user }}" -m shell -a 'cd {{civiroot}} && git clean -fdx {{civiroot}} && git reset --hard HEAD'  mysite1.local,mysite2.local
24 6 Jon Goldberg
```
25
26 7 Jon Goldberg
#### Send a drush command to multiple sites
27
This is trickier to handle places where we don't have root, but works.
28
```shell
29
ansible --become --become-user="{{ run_as_user }}" -m shell -a "PATH=\$HOME/bin:\$PATH; drush --root={{ webroot }} pm-disable -y print" 'maintenance_drupal'
30
```
31
32 9 Jon Goldberg
#### Update a Civi extension only on certain sites
33
```shell
34
ansible --become --become-user="{{ run_as_user }}" -m shell -a "PATH=\$HOME/bin:\$PATH; cv --cwd={{ webroot }} ext:download --force extendedreport" site1.local,site2.local
35
ansible --become --become-user="{{ run_as_user }}" -m shell -a "cd {{ webroot }}; git add .; git commit -m'ExtendedReport 5.16'; git push" site1.local,site2.local
36
```
37
38 1 Jon Goldberg
#### Send an arbitrary SQL statement to all Civi test instances with maintenance contracts
39
```shell
40 4 Jon Goldberg
ansible --become --become-user="{{ run_as_user }}" -m shell -a "PATH=\$HOME/bin:\$PATH; echo \"UPDATE civicrm_job SET is_active = 0 WHERE api_action = 'group_rebuild';\" | cv --cwd={{ webroot }} sql" 'maintenance_civi:&websites_test'
41
````
42 6 Jon Goldberg
43
#### Set CLI PHP version across all servers
44
This is an example of server-level changes (others are site-level).
45
```shell
46
ansible  --become -m command -a 'update-alternatives --set php /usr/bin/php7.4' vps
47
```
48 10 Jon Goldberg
49 12 Jon Goldberg
#### Copy a local file to all servers
50
```shell
51
ansible --become -m copy -a "src=/home/jon/Downloads/goodphp81.php.ini dest=/etc/php/8.1/fpm/php.ini mode=0644 owner=root group=root" lamp
52
```
53
54 10 Jon Goldberg
### Run a non-command module across all servers
55
```
56
ansible --become -m user -a"name=joseph state=absent remove=yes" vps
57
```
58 11 Jon Goldberg
59
### Clear templates_c and flush cache on all maintenance servers
60
```
61
ansible --become -m shell -a "cd {{ webroot }}/wp-content/uploads/civicrm; rm -rf templates_c; cv flush" 'maintenance_civi:&maintenance_wp:&websites_live'
62
ansible --become -m shell -a "cd {{ webroot }}/sites/default/files/civicrm; rm -rf templates_c; cv flush" 'maintenance_civi:&maintenance_drupal:&websites_live'
63
```