summaryrefslogtreecommitdiffstats
path: root/README
blob: f848622faf7a32064423828ff9d99cbe4ac40273 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
eoptasks - run commands on servers
==================================

This script provides parallel remote execution of commands, while having
some special knownledge of servers that should *not* be handled in parallel.

It defers terminal-handling to tmux(1).

It has some targeting capacities using keywords. Commas for 'OR' and slashes
for 'AND', ex: ext/test,saas/test/passerelle will select all external test
servers + all passerelle servers on the SaaS.

It takes any shell command and has some builtin shortcuts such as apt.update
and apt.upgrade.

Requirements: libtmux and pyyaml.


Configuration
-------------

In ~/.config/eoptasks.ini::

 [config]
 servers = /path/to/servers.yaml
 ignore = server1, server2
 stripsuffix = .entrouvert.org

It is possible to add extra command shortcuts with additional sections, ex::

 [command:memcached.restart]
 cmd = sudo service memcached restart; /bin/true


It is also possible to declare additional servers, in a [servers] section, ex::

 [servers]
 host.domain = keyword1, keyword2


And custom keywords mapping can be defined, for shortcuts or alternative names,
ex::

 [keywords]
 monitoring = munin,scrutiny,prometheus

or to prevent common errors or misconceptions::

 [keywords]
 saas/test = saas/test,-hds,-re,-docbow


Examples
--------

 eoptasks -k test apt.upgrade
  Run (sudo) apt upgrade on all test servers.

 eoptasks -k test,-database sudo apt install python-gadjo
  Run sudo apt install python-gadjo on all test servers except database servers.

 eoptasks -k saas/test/passerelle,ext/test --list-servers
  List servers that have saas AND test AND passerelle keywords, OR the
  ext AND test keywords.

 eoptasks -k saas/prod -x ^node,^database.node,.*docbow sudo apt install publik-base-theme
  Install/upgrade publik-base-theme on all production server of the SaaS excepted
  the hypervisor, database, and docbow nodes.


Code Style
----------

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)


License
-------

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with this program.  If not, see <https://www.gnu.org/licenses/>.