PHP: Use 30s for pm.process_idle_timeout - it is more than enough and prevents too...
[project/octopus.git] / docs / UPGRADE.txt
1
2 ###
3 ### Important Notes - Read This First!
4 ###
5
6  => If you haven't run full barracuda+octopus upgrade to latest BOA Stable
7     Edition yet, don't use any partial upgrade modes explained further below.
8     Once new BOA Stable is released, you must run *full* upgrades with commands:
9
10     $ barracuda up-stable
11     $ octopus up-stable all both
12
13     For silent, logged mode with e-mail message sent once the upgrade is
14     complete, but no progress is displayed in the terminal window, you can run
15     alternatively, starting with screen session to avoid incomplete upgrade
16     if your SSH session will be closed for any reason before the upgrade
17     will complete:
18
19     $ screen
20     $ barracuda up-stable log
21     $ octopus up-stable all both log
22
23     Note that the silent, non-interactive mode will automatically say Y/Yes
24     to all prompts and is thus useful to run auto-upgrades scheduled in cron.
25
26  => Don't run any installer via sudo.
27     You must be logged in as root or `sudo -i` first.
28
29  => Please never use HEAD version on any production server. Always use Stable.
30     The HEAD can be occasionally broken and should be used *only* for testing!
31
32  => All commands will honor settings in their respective config files:
33
34     /root/.barracuda.cnf
35     /root/.o1.octopus.cnf
36
37     However, arguments specified on command line will take precedence - see
38     upgrade modes explained below.
39
40
41 ###
42 ### Available Standard Upgrade Modes
43 ###
44
45     Download and run (as root) BOA Meta Installer first:
46
47     $ cd;wget -q -U iCab http://files.aegir.cc/BOA.sh.txt;bash BOA.sh.txt
48
49  => To upgrade system and Aegir Master Instance to Stable use:
50
51     $ barracuda up-stable
52
53  => To upgrade selected Aegir Satellite Instance to Stable use:
54
55     $ octopus up-stable o1
56
57  => To upgrade *all* Aegir Satellite Instances to Stable use:
58
59     $ octopus up-stable all
60
61
62 ###
63 ### Available Custom Upgrade Modes
64 ###
65
66  => You can append "log" as the last argument to every command, and it will
67     write the output to the file instead of to the console, respectively:
68
69     /var/backups/reports/up/barracuda/*
70     /var/backups/reports/up/octopus/*
71
72     Examples:
73
74     $ barracuda up-stable log
75     $ octopus up-stable all log
76
77     Detailed backend log on barracuda upgrade is always stored in /var/backups/
78
79  => You can append "system" as a last argument to the barracuda command, and
80     it will upgrade only the system, without running Aegir Master Instance
81     upgrade, plus it will write the output to the file instead of console:
82
83     /var/backups/reports/up/barracuda/*
84
85     Example:
86
87     $ barracuda up-stable system
88
89     Note that while both "log" and "system" modes are "silent", because they
90     don't display anything in your console, they will send the log via e-mail
91     to your address specified in the config file: /root/.barracuda.cnf
92
93     It is recommended that you start `screen` before running commands using
94     the "silent" mode - to avoid confusion or incomplete tasks when your
95     SSH connection drops for any reason.
96
97  => It is possible to set/force the upgrade mode on the fly using optional
98     arguments: {aegir|platforms|both}
99
100     Note that none is similar to "both", however "both" will force aegir plus
101     platforms upgrade, while none will honor also settings from the octopus
102     instance cnf file, where currently only "aegir" mode is defined with
103     _HM_ONLY=YES option.
104
105     Examples:
106
107     $ octopus up-stable o1 aegir
108     $ octopus up-stable o1 platforms log
109     $ octopus up-stable all aegir log
110     $ octopus up-stable all platforms
111
112  => To keep Legacy version instead of Stable, use the same commands, but
113     replace "up-stable" with "up-legacy".
114
115     The Legacy version is currently the last Edition in the 2.1.x series, and
116     will move gradually to 2.2.x series when 2.3.x will be released. It still
117     supports Drupal 5 and uses Drush 4 along with older Aegir version.
118
119     Note that once you will upgrade to current Stable or HEAD, you can't
120     downgrade back to Legacy version!
121
122  => To use HEAD instead of Stable, use the same commands, but replace
123     "up-stable" with "up-head". Please never use HEAD version on any production
124     server. Always use Stable. The HEAD can be occasionally broken and should
125     be used *only* for testing!
126