mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 22:58:20 +00:00
2347be3092
Added some text to clarify the procedure (it now reads more like a step-by-step guide to upgrading).
62 lines
2.7 KiB
ReStructuredText
62 lines
2.7 KiB
ReStructuredText
|
|
.. _upgrade-guidelines:
|
|
|
|
==============
|
|
How to Upgrade
|
|
==============
|
|
|
|
If you're doing an upgrade install (rather than a fresh install),
|
|
there's two suggested approaches: either install Bro using the same
|
|
installation prefix directory as before, or pick a new prefix and copy
|
|
local customizations over.
|
|
|
|
In the following we summarize general guidelines for upgrading, see
|
|
the :ref:`release-notes` for version-specific information.
|
|
|
|
|
|
Reusing Previous Install Prefix
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If you choose to configure and install Bro with the same prefix
|
|
directory as before, first stop all running Bro instances in your
|
|
cluster (if using BroControl, issue the "broctl stop" command on the
|
|
manager host). Next, make a backup of the Bro install prefix directory.
|
|
|
|
During the upgrade, any file in the install prefix may be
|
|
overwritten or removed, except for local customization of
|
|
files in the ``$prefix/share/bro/site`` and ``$prefix/etc``
|
|
directories (``$prefix`` indicating the root
|
|
of where Bro was installed). Also, logs generated at run-time
|
|
won't be touched by the upgrade.
|
|
|
|
After upgrading, remember to check the ``$prefix/share/bro/site`` and
|
|
``$prefix/etc`` directories for files with a file extension of ``.example``,
|
|
which indicate that the distribution's version of the file differs from the
|
|
local one, and therefore, may include local changes. Review the
|
|
differences and make adjustments as necessary. Use the new version
|
|
for differences that aren't a result of a local change.
|
|
|
|
Finally, if using BroControl, then issue the "broctl deploy" command. This
|
|
command will check for any policy script errors, install the new version
|
|
of Bro to all machines in your cluster, and then it will start Bro.
|
|
|
|
Using a New Install Prefix
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To install the newer version in a different prefix directory than before,
|
|
first stop all running Bro instances in your cluster (if using BroControl,
|
|
then issue a "broctl stop" command on the manager host). Next,
|
|
install the new version of Bro in a new directory.
|
|
|
|
Next, copy local customization and configuration files
|
|
from the ``$prefix/share/bro/site`` and ``$prefix/etc`` directories to the
|
|
new location (``$prefix`` indicating the root of where Bro was originally
|
|
installed). Review the files for differences
|
|
before copying and make adjustments as necessary (use the new version for
|
|
differences that aren't a result of a local change). Of particular note,
|
|
the copied version of ``$prefix/etc/broctl.cfg`` is likely to need changes
|
|
to any settings that specify a pathname.
|
|
|
|
Finally, if using BroControl, then issue the "broctl deploy" command. This
|
|
command will check for any policy script errors, install the new version
|
|
of Bro to all machines in your cluster, and then it will start Bro.
|