zopectl8

Usage

Overview

zopectl is an utility capable of managing multiple zope instances. It can apply a sequence of actions to multiple instances. All the instances are described files either in /etc/zopectl/*.conf or in /etc/zopectl/*.ini (see zopectlrc(5)).

Options

Each option need an argument. Each argument must be a comma separated list of instance_name. The special '*' instance_name will trigger the option for all known instances.

For each instance_name resulting from option parsing:

-s, --start

Apply action 'start'

-S, --stop

Apply action 'stop'

-r, --restart

Apply action 'restart'

-f, --force-reload

Apply action 'force-reload'

-a, --access

Apply action 'access'

-p, --pcgi

Apply action 'pcgi'

-i, --init

Apply action 'init'

-d, --delete

Apply action 'delete'

-l, --logrotate

Apply action 'logrotate'

-D, --dump

Apply action 'dump'

If action is provided as argument, zopectl will apply action to any instance_name specified as argument. If no instance_name is specified, zopectl will apply action to all known instance_name.

Unknown instance_name are ignored.

Actions

action may be one of the following:

start

Starts the instance using /usr/lib/zope/z2.py

stop

Sends SIGTERM to instance

restart

If instance is running, sends SIGHUP to instance; else falls back to start action

force-reload

Stops the instance, reload the configuration end then start it anew

logrotate

Sends SIGUSR2 to instance which make instance to reopen log files (see Zope's SIGNALS.txt)

access

Regenerate/create the emergency user file

pcgi

Regenerate/create the PCGI resource file

delete

Stops instance and remove all files and directory used by instance (logs are not removed)

init

Initialize instance_name files and directories setting up permissions and ownership, but does not create access file or PCGI resource file.

dump

Dump a tagged list 'name: value' of the instance configuration.

Examples

Just a test:

      # zopectl --start --restart --force-reload stop

This command will apply each action in sequence, so, at the end, it won't do anything of real use.

      # zopectl --init new_instance --pcgy new_instance --access new_instance

This command will completly set up the instance named 'new_instance'. create action is deprecated, so you should now use these three.

Your Zope logrotate.conf may include the following lines:

      postrotate
        zopectl logrotate
      endscript

Note

create action is DEPRECATED. Use init instead.

Files

/etc/zopectl/zopectlrc

The zopectl runtime configuration file

/etc/zopectl/*.{conf,ini}

The instances configuration files