Document Actions

Installing keepalive 0.1

Install the keepalive Product

  1. Unpack the tarball in a temporary location. E.g.:

    $ cd /tmp
    $ tar xzf ~/keepalive-0.1.tar.gz
  2. Move or copy the 'keepalive' subdirectory in the unpacked directory to the 'Products' directory of the $INSTANCE_HOME of the Zope application server instance. E.g.:

    $ cp -r keepalive-0.1/keepalive /home/zope/prod/instance/Products/
  3. Restart Zope:

    $ /home/zope/prod/instance/bin/zopectl restart
  4. Verify that the new product installed correctly by visiting the /Control_Panel/Products tab.

Set up the Tool

  1. In the ZMI for the application server, add a 'ZEO Keepalive Too' from the add menu, leaving the ID of the tool the default.
  2. In the root user folder, add a new user, 'keepalive'. Note: you may use an existing user, but need to be able to put the password for this user in the zope.conf file (see #4 below, under "Configure the Clients").
  3. On the "Security" tab of the new tool, click the checkboxk for 'Manage properties' under the 'Owner' column, and then click the "Save Changes" button.
  4. From the "Security" tab, click the "local roles" link, and grant the new 'keepalive' user the 'Owner' role.
  5. On the "Properties" tab of the new tool, set the warning and error intervals, in seconds, used to change the color of the display when a client falls out of date. Set the refre interval, in seconds, if you want the "Status" page to auto refresh.

Configure the Clients

For each client in your cluster:

  1. Edit the zope.conf for the client, adding a stanza similar to the following:

    %import Products.keepalive
        method /keepalive_tool/updateClient?key=foo
        period 60
        user admin
        password qqq123
        host localhost
  2. Replace the 'foo' in each case with a unique name for the client.

  3. Replace the '60' with an interval, in seconds, at which you want the clients to write their updates to the tool.

  4. Replace the 'admin' and 'qqq123' with the login and password of the user who has the 'Owner' role on the tool (see #2 above, under "Set up the Tool").

  5. Restart the client.