mkfs.mse4

Massive Storage Engine 4 mkfs.mse4

Manual section:1

SYNOPSIS

mkfs.mse4 [options] command [<book-or-store-id>…]

DESCRIPTION

This utility is used in order to configure and resize MSE4 file devices. The utility requires the files to not be in use when it executes. This means that the Varnish daemon must be stopped first.

OPTIONS

-c <config-file>

Path to MSE4 configuration file.

This option is required.

-f

Use force.

This option allows some commands to execute potentially destructive steps in order to proceed.

-h

Print quick help text and exit.

-n <instance>

Set the Varnish instance name.

This option is needed when there are multiple Varnish instances running on the server. It allows the mkfs.mse4 utility to locate the correct statelog file to use.

-q

Quiet mode

XXX: To be implemented

COMMANDS

All of the commands take an optional list of book or store IDs. When given, the command will be limited to execute only on the devices listed. If none are specified, all of the file devices will be covered.

check-config

Validate configuration.

This command validates the configuration. The exit status will be 0 only if the supplied configuration file is valid.

configure

Create and configure file devices.

This command will iterate over the configuration, and ensure that each of the file devices listed are present and initialized. Any missing file devices will be created.

This command may fail with an error message asking for the force flag to be applied. When the force flag is given, it will be permitted to execute clean up operations necessary to apply the configuration. This clean up depends on the set of stores configured on the book to all be available in their configured path at the time the command is executed. If a store is not available, its objects may be removed.

delete

Delete file devices.

This command will delete all of the file devices listed in the configuration.

resize

Resize file devices.

This command will resize the file devices so that their size and layout matches what the configuration states. It will both increase and decrease file sizes.

When resizing stores, the resize is done by increasing or decreasing the file size. When the store size is decreased, any objects that happen to be located at the very end of the store will be removed from the cache.

When resizing books, a new temporary book is created for the resize operation. The content of the previous book is then written into the new book, and finally the old book is replaced with the new. The slot tables making up the cached content will be truncated when necessary, and any objects affected removed from the cache.

If there isn’t enough free disk space to create the temporary new book, an error will be given and the operation aborted unless the -f (force) flag is given. If the -f flag is given, the old book will deleted first, and then the new one created. Note that this will cause the book to have been lost on subsequent errors. Make a backup of the book first when using the -f option if this is reason for concern.

headers

Print configuration information gathered from the headers in each of the file devices.

SEE ALSO