Shine command list

Introduction

Once installed, Shine provides the shine command (as of v1.5).

Usage: shine [options] COMMAND [options]

Commands:
  config         Display filesystem component information
  execute        Execute a custom command
  format         Format file system targets.
  fsck           Fsck on targets backend file system.
  install        Install a new file system.
  list           List installed filename names.
  mount          Mount file system clients.
  remove         Remove a previously installed file system
  show           Show configuration parameters.
  start          Start file system servers.
  status         Check for file system target status.
  stop           Stop file system servers.
  tune           Tune file system servers.
  tunefs         Tune file system targets.
  umount         Unmount file system clients.
  update         Update an installed filesystem with a new model

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -L                    Run only for local components
  --fanout=FANOUT       fanout for parallel commands
  --dry-run             perform a trial run with no changes made
  -o OPTIONS            additional options for final command
  -f NAME               apply command to this file system
  -m MODEL              path of the Lustre Model File
  -y                    assume a "yes" response to all prompts
  --mountdata=WHEN      analyze target mountdata (never, always or auto)

  Display options:
    -v                  be verbose (could be used multiple times)
    -q                  quiet output
    -d                  enable debugging
    -V VIEW             change displayed filesystem information
    -O FORMAT           custom format for component summary table
    -H                  do not display table header
    --color=WHEN        whether to use ANSI colors (never, always or auto)

  Component selection:
    -i INDEXES          specify target index ranges, eg. 0-6/2
    -l LABELS           specify component by label (ie: foo-OST0000)
    -t TARGETS          specify components (mgt, mdt, ost, router)

  Node restriction:
    -n NODES, -w NODES  only use this nodes or nodeset, eg. red[2-10/2]
    -x NODES            exclude nodes or nodeset, eg. red[2-10/2]
    -F NODES            Nodes to use to fail over

Available commands

File system creation

install

Install a filesystem from a model file. The model file may describes the entire Lustre filesystem or only target patterns that will match Shine's backend entries.

Typical usage is:

# shine install -m /etc/shine/models/testfs.lmf

By installing, we mean that shine will generate a filesystem configuration and will spread it to the concerned nodes (MGS, MDS, OSS and clients).

update

Update an installed file system. This command applies the changes you made to an installed filesystem model and copy the filesystem and tuning configuration files. This is useful to change default striping, ost options, add/remove clients and more, or simply update the configuration files.

Typical usage is:

# shine update -m /etc/shine/models/testfs.lmf

remove

Delete shine filesystem configuration. Also remove configuration in backend if defined. Lustre devices are not touched and so data is preserved. This only remove the Shine part.

# shine remove -f testfs

config

Query and display fileystem configuration in an efficient way. Shine can query and display a filesystem configuration using locally stored configuration. This does not execute any remote command. Display could be highly tuned through command line option to achieve specific output.

# shine config -f testfs

File system actions

format

Format an installed filesystem.

Typical usage is:

# shine format -f testfs

start

Start filesystem servers.

Typical usage is:

# shine start -f testfs

stop

Stop filesystem servers.

Typical usage is:

# shine stop -f testfs

fsck

Perform a "check and repair" fsck on specified targets backend file system in parallel.

Typical usage is:

# shine fsck -f testfs

tunefs

Run tunefs.lustre in parallel on filesystem targets. This could be used to regenerate MGS configuration and repair it.

Typical usage is:

# shine tunefs -f testfs

mount

Mount filesystem clients.

Typical usage is:

# shine mount -f testfs

umount

Un-mount filesystem clients.

Typical usage is:

# shine umount -f testfs

status

Get filesystem current status.

Typical usages are:

# shine status -f testfs
# shine status -f testfs -V targets
# shine status -f testfs -V fs