Issue #2236475 by EdNet - Clarify what the Legacy mode really means and which version...
[aegir:barracuda-octopus.git] / docs / UPGRADE.txt
1
2 ### IMPORTANT!
3
4 * Don't run any installer via sudo.
5   You must be logged in as root or `sudo -i` first.
6
7 * Don't run any system updates before running Barracuda installer.
8   You should use vanilla system.
9
10 * Please never use HEAD version on any production server. Always use Stable.
11   The HEAD can be occasionally broken and should be used **only** for testing!
12
13
14 # Download and run BOA Meta Installer.
15 $ wget -q -U iCab http://files.aegir.cc/BOA.sh.txt
16 $ bash BOA.sh.txt
17
18 # To upgrade system and Aegir Master Instance to Stable
19 $ barracuda up-stable
20
21 # To upgrade system and Aegir Master Instance to HEAD
22 $ barracuda up-head
23
24 # To upgrade selected Aegir Satellite Instance to Stable
25 $ octopus up-stable o1
26
27 # To upgrade *all* Aegir Satellite Instances to Stable
28 $ octopus up-stable all
29
30 # To upgrade selected Aegir Satellite Instance to HEAD
31 $ octopus up-head o1
32
33 # To upgrade *all* Aegir Satellite Instances to HEAD
34 $ octopus up-head all
35
36
37    To keep Legacy version instead of Stable, use the same commands, but
38    replace "up-stable" with "up-legacy".
39
40    The Legacy version is currently the last Edition in the 2.1.x series, and
41    will move gradually to 2.2.x series when 2.3.x will be released. It still
42    supports Drupal 5 and uses Drush 4 along with older Aegir version.
43
44    Note that once you will upgrade to current Stable or HEAD, you can't
45    downgrade back to Legacy version!
46
47
48 ### NOTE: Both commands will honor configuration settings
49           stored in their config files, respectively:
50             /root/.barracuda.cnf
51             /root/.o1.octopus.cnf
52             /root/.o2.octopus.cnf
53           However, arguments specified on command line
54           will take precedence - see upgrade mode below.
55
56 ### NOTE: You can append "log" as a last argument to every
57           command, and it will write the output to the file
58           instead of to the console, respectively:
59           /var/backups/reports/up/barracuda/*
60           /var/backups/reports/up/octopus/*
61
62           Examples:
63
64           $ barracuda up-stable log
65           $ octopus up-stable all log
66
67           Detailed backend log on barracuda upgrade is always stored in
68           /var/backups/*
69
70 ### NOTE: You can append "system" as a last argument to the barracuda
71           command, and it will upgrade only the system, without running
72           Aegir Master Instance upgrade, plus it will write the output
73           to the file instead of to the console:
74           /var/backups/reports/up/barracuda/*
75
76           Example:
77
78           $ barracuda up-stable system
79
80 ### NOTE: While both "log" and "system" modes are "silent", because
81           they don't display anything in your console, they will send
82           the log via e-mail to your address specified in the file:
83           /root/.barracuda.cnf
84
85           It is recommended that you start `screen` before running
86           commands using the "silent" mode - to avoid confusion
87           or incomplete tasks when your SSH connection drops.
88
89 ### NOTE: It is possible to set/force the upgrade mode on the fly
90           using optional arguments: {aegir|platforms|both}
91           Note that none is similar to "both", however "both"
92           will force aegir+platforms upgrade, while none will
93           honor also settings from the octopus instance cnf file,
94           where currently only "aegir" mode is defined
95           with _HM_ONLY=YES option.
96
97           Examples:
98
99           $ octopus up-stable o1 aegir
100           $ octopus up-stable o1 platforms log
101           $ octopus up-stable all aegir log
102           $ octopus up-stable all platforms
103