summaryrefslogtreecommitdiffstats
path: root/docs/UPGRADE.txt
blob: 0b1d5422100f7794fc7bc5162694fa70912cc541 (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
###
### Important Notes - Read This First!
###

 => If you haven't run full barracuda+octopus upgrade to latest BOA Stable
    Edition yet, don't use any partial upgrade modes explained further below.
    Once new BOA Stable is released, you must run *full* upgrades with commands:

    $ barracuda up-stable
    $ octopus up-stable all both

    For silent, logged mode with e-mail message sent once the upgrade is
    complete, but no progress is displayed in the terminal window, you can run
    alternatively, starting with screen session to avoid incomplete upgrade
    if your SSH session will be closed for any reason before the upgrade
    will complete:

    $ screen
    $ barracuda up-stable log
    $ octopus up-stable all both log

    Note that the silent, non-interactive mode will automatically say Y/Yes
    to all prompts and is thus useful to run auto-upgrades scheduled in cron.

 => Don't run any installer via sudo.
    You must be logged in as root or `sudo -i` first.

 => Please never use HEAD version on any production server. Always use Stable.
    The HEAD can be occasionally broken and should be used *only* for testing!

 => All commands will honor settings in their respective config files:

    /root/.barracuda.cnf
    /root/.o1.octopus.cnf

    However, arguments specified on command line will take precedence - see
    upgrade modes explained below.


###
### Available Standard Upgrade Modes
###

    Download and run (as root) BOA Meta Installer first:

    $ cd;wget -q -U iCab http://files.aegir.cc/BOA.sh.txt;bash BOA.sh.txt

 => To upgrade system and Aegir Master Instance to Stable use:

    $ barracuda up-stable

 => To upgrade selected Aegir Satellite Instance to Stable use:

    $ octopus up-stable o1

 => To upgrade *all* Aegir Satellite Instances to Stable use:

    $ octopus up-stable all


###
### Available Custom Upgrade Modes
###

 => You can append "log" as the last argument to every command, and it will
    write the output to the file instead of to the console, respectively:

    /var/backups/reports/up/barracuda/*
    /var/backups/reports/up/octopus/*

    Examples:

    $ barracuda up-stable log
    $ octopus up-stable all log

    Detailed backend log on barracuda upgrade is always stored in /var/backups/

 => You can append "system" as a last argument to the barracuda command, and
    it will upgrade only the system, without running Aegir Master Instance
    upgrade, plus it will write the output to the file instead of console:

    /var/backups/reports/up/barracuda/*

    Example:

    $ barracuda up-stable system

    Note that while both "log" and "system" modes are "silent", because they
    don't display anything in your console, they will send the log via e-mail
    to your address specified in the config file: /root/.barracuda.cnf

    It is recommended that you start `screen` before running commands using
    the "silent" mode - to avoid confusion or incomplete tasks when your
    SSH connection drops for any reason.

 => It is possible to set/force the upgrade mode on the fly using optional
    arguments: {aegir|platforms|both}

    Note that none is similar to "both", however "both" will force aegir plus
    platforms upgrade, while none will honor also settings from the octopus
    instance cnf file, where currently only "aegir" mode is defined with
    _HM_ONLY=YES option.

    Examples:

    $ octopus up-stable o1 aegir
    $ octopus up-stable o1 platforms log
    $ octopus up-stable all aegir log
    $ octopus up-stable all platforms

 => To keep Legacy version instead of Stable, use the same commands, but
    replace "up-stable" with "up-legacy".

    The Legacy version is currently the last Edition in the 2.1.x series, and
    will move gradually to 2.2.x series when 2.3.x will be released. It still
    supports Drupal 5 and uses Drush 4 along with older Aegir version.

    Note that once you will upgrade to current Stable or HEAD, you can't
    downgrade back to Legacy version!

 => To use HEAD instead of Stable, use the same commands, but replace
    "up-stable" with "up-head". Please never use HEAD version on any production
    server. Always use Stable. The HEAD can be occasionally broken and should
    be used *only* for testing!