14022528a5e9a32e0134accd0030547783cc1fc0
[ganeti-github.git] / UPGRADE
1 Upgrade notes
2 =============
3
4 .. highlight:: shell-example
5
6 This document details the steps needed to upgrade a cluster to newer versions
7 of Ganeti.
8
9 As a general rule the node daemons need to be restarted after each software
10 upgrade; if using the provided example init.d script, this means running the
11 following command on all nodes::
12
13     $ /etc/init.d/ganeti restart
14
15
16 2.1 and above
17 -------------
18
19 Starting with Ganeti 2.0, upgrades between revisions (e.g. 2.1.0 to 2.1.1)
20 should not need manual intervention. As a safety measure, minor releases (e.g.
21 2.1.3 to 2.2.0) require the ``cfgupgrade`` command for changing the
22 configuration version. Below you find the steps necessary to upgrade between
23 minor releases.
24
25 To run commands on all nodes, the `distributed shell (dsh)
26 <http://www.netfort.gr.jp/~dancer/software/dsh.html.en>`_ can be used, e.g.
27 ``dsh -M -F 8 -f /var/lib/ganeti/ssconf_online_nodes gnt-cluster --version``.
28
29 #. Ensure no jobs are running (master node only)::
30
31     $ gnt-job list
32
33 #. Stop all daemons on all nodes::
34
35     $ /etc/init.d/ganeti stop
36
37 #. Backup old configuration (master node only)::
38
39     $ tar czf /var/lib/ganeti-$(date +\%FT\%T).tar.gz -C /var/lib ganeti
40
41 #. Install new Ganeti version on all nodes
42 #. Run cfgupgrade on the master node::
43
44     $ /usr/lib/ganeti/tools/cfgupgrade --verbose --dry-run
45     $ /usr/lib/ganeti/tools/cfgupgrade --verbose
46
47    (``cfgupgrade`` supports a number of parameters, run it with
48    ``--help`` for more information)
49
50 #. Upgrade the directory permissions on all nodes::
51
52     $ /usr/lib/ganeti/ensure-dirs --full-run
53
54 #. Restart daemons on all nodes::
55
56     $ /etc/init.d/ganeti restart
57
58 #. Re-distribute configuration (master node only)::
59
60     $ gnt-cluster redist-conf
61
62 #. Restart daemons again on all nodes::
63
64     $ /etc/init.d/ganeti restart
65
66 #. Verify cluster (master node only)::
67
68     $ gnt-cluster verify
69
70
71 2.0 releases
72 ------------
73
74 2.0.3 to 2.0.4
75 ~~~~~~~~~~~~~~
76
77 No changes needed except restarting the daemon; but rollback to 2.0.3 might
78 require configuration editing.
79
80 If you're using Xen-HVM instances, please double-check the network
81 configuration (``nic_type`` parameter) as the defaults might have changed:
82 2.0.4 adds any missing configuration items and depending on the version of the
83 software the cluster has been installed with, some new keys might have been
84 added.
85
86 2.0.1 to 2.0.2/2.0.3
87 ~~~~~~~~~~~~~~~~~~~~
88
89 Between 2.0.1 and 2.0.2 there have been some changes in the handling of block
90 devices, which can cause some issues. 2.0.3 was then released which adds two
91 new options/commands to fix this issue.
92
93 If you use DRBD-type instances and see problems in instance start or
94 activate-disks with messages from DRBD about "lower device too small" or
95 similar, it is recoomended to:
96
97 #. Run ``gnt-instance activate-disks --ignore-size $instance`` for each
98    of the affected instances
99 #. Then run ``gnt-cluster repair-disk-sizes`` which will check that
100    instances have the correct disk sizes
101
102 1.2 to 2.0
103 ----------
104
105 Prerequisites:
106
107 - Ganeti 1.2.7 is currently installed
108 - All instances have been migrated from DRBD 0.7 to DRBD 8.x (i.e. no
109   ``remote_raid1`` disk template)
110 - Upgrade to Ganeti 2.0.0~rc2 or later (~rc1 and earlier don't have the needed
111   upgrade tool)
112
113 In the below steps, replace :file:`/var/lib` with ``$libdir`` if Ganeti was not
114 installed with this prefix (e.g. :file:`/usr/local/var`). Same for
115 :file:`/usr/lib`.
116
117 Execution (all steps are required in the order given):
118
119 #. Make a backup of the current configuration, for safety::
120
121     $ cp -a /var/lib/ganeti /var/lib/ganeti-1.2.backup
122
123 #. Stop all instances::
124
125     $ gnt-instance stop --all
126
127 #. Make sure no DRBD device are in use, the following command should show no
128    active minors::
129
130     $ gnt-cluster command grep cs: /proc/drbd | grep -v cs:Unconf
131
132 #. Stop the node daemons and rapi daemon on all nodes (note: should be logged
133    in not via the cluster name, but the master node name, as the command below
134    will remove the cluster ip from the master node)::
135
136     $ gnt-cluster command /etc/init.d/ganeti stop
137
138 #. Install the new software on all nodes, either from packaging (if available)
139    or from sources; the master daemon will not start but give error messages
140    about wrong configuration file, which is normal
141 #. Upgrade the configuration file::
142
143     $ /usr/lib/ganeti/tools/cfgupgrade12 -v --dry-run
144     $ /usr/lib/ganeti/tools/cfgupgrade12 -v
145
146 #. Make sure ``ganeti-noded`` is running on all nodes (and start it if
147    not)
148 #. Start the master daemon::
149
150     $ ganeti-masterd
151
152 #. Check that a simple node-list works::
153
154     $ gnt-node list
155
156 #. Redistribute updated configuration to all nodes::
157
158     $ gnt-cluster redist-conf
159     $ gnt-cluster copyfile /var/lib/ganeti/known_hosts
160
161 #. Optional: if needed, install RAPI-specific certificates under
162    :file:`/var/lib/ganeti/rapi.pem` and run::
163
164     $ gnt-cluster copyfile /var/lib/ganeti/rapi.pem
165
166 #. Run a cluster verify, this should show no problems::
167
168     $ gnt-cluster verify
169
170 #. Remove some obsolete files::
171
172     $ gnt-cluster command rm /var/lib/ganeti/ssconf_node_pass
173     $ gnt-cluster command rm /var/lib/ganeti/ssconf_hypervisor
174
175 #. Update the xen pvm (if this was a pvm cluster) setting for 1.2
176    compatibility::
177
178     $ gnt-cluster modify -H xen-pvm:root_path=/dev/sda
179
180 #. Depending on your setup, you might also want to reset the initrd parameter::
181
182     $ gnt-cluster modify -H xen-pvm:initrd_path=/boot/initrd-2.6-xenU
183
184 #. Reset the instance autobalance setting to default::
185
186     $ for i in $(gnt-instance list -o name --no-headers); do \
187        gnt-instance modify -B auto_balance=default $i; \
188       done
189
190 #. Optional: start the RAPI demon::
191
192     $ ganeti-rapi
193
194 #. Restart instances::
195
196     $ gnt-instance start --force-multiple --all
197
198 At this point, ``gnt-cluster verify`` should show no errors and the migration
199 is complete.
200
201 1.2 releases
202 ------------
203
204 1.2.4 to any other higher 1.2 version
205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
206
207 No changes needed. Rollback will usually require manual edit of the
208 configuration file.
209
210 1.2.3 to 1.2.4
211 ~~~~~~~~~~~~~~
212
213 No changes needed. Note that going back from 1.2.4 to 1.2.3 will require manual
214 edit of the configuration file (since we added some HVM-related new
215 attributes).
216
217 1.2.2 to 1.2.3
218 ~~~~~~~~~~~~~~
219
220 No changes needed. Note that the drbd7-to-8 upgrade tool does a disk format
221 change for the DRBD metadata, so in theory this might be **risky**. It is
222 advised to have (good) backups before doing the upgrade.
223
224 1.2.1 to 1.2.2
225 ~~~~~~~~~~~~~~
226
227 No changes needed.
228
229 1.2.0 to 1.2.1
230 ~~~~~~~~~~~~~~
231
232 No changes needed. Only some bugfixes and new additions that don't affect
233 existing clusters.
234
235 1.2.0 beta 3 to 1.2.0
236 ~~~~~~~~~~~~~~~~~~~~~
237
238 No changes needed.
239
240 1.2.0 beta 2 to beta 3
241 ~~~~~~~~~~~~~~~~~~~~~~
242
243 No changes needed. A new version of the debian-etch-instance OS (0.3) has been
244 released, but upgrading it is not required.
245
246 1.2.0 beta 1 to beta 2
247 ~~~~~~~~~~~~~~~~~~~~~~
248
249 Beta 2 switched the config file format to JSON. Steps to upgrade:
250
251 #. Stop the daemons (``/etc/init.d/ganeti stop``) on all nodes
252 #. Disable the cron job (default is :file:`/etc/cron.d/ganeti`)
253 #. Install the new version
254 #. Make a backup copy of the config file
255 #. Upgrade the config file using the following command::
256
257     $ /usr/share/ganeti/cfgupgrade --verbose /var/lib/ganeti/config.data
258
259 #. Start the daemons and run ``gnt-cluster info``, ``gnt-node list`` and
260    ``gnt-instance list`` to check if the upgrade process finished successfully
261
262 The OS definition also need to be upgraded. There is a new version of the
263 debian-etch-instance OS (0.2) that goes along with beta 2.
264
265 .. vim: set textwidth=72 :
266 .. Local Variables:
267 .. mode: rst
268 .. fill-column: 72
269 .. End: