<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<!-- $Id: gfls.1.docbook 10309 2016-11-30 23:32:30Z n-soda $ -->

<refentry id="gfarmbb.1">

<refentryinfo><date>4 Oct 2019</date></refentryinfo>

<refmeta>
<refentrytitle>gfarmbb</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Gfarm</refmiscinfo>
</refmeta>

<refnamediv id="name">
<refname>gfarmbb</refname>
<refpurpose>Gfarm/BB（Gfarm burst buffer）を構築・撤去する</refpurpose>
</refnamediv>

<refsynopsisdiv id="synopsis">
<cmdsynopsis sepchar=" ">
  <command moreinfo="none">gfarmbb</command>
    <arg choice="opt" rep="norepeat"><replaceable>options</replaceable></arg>
    <arg choice="plain" rep="norepeat"><replaceable>mode</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<!-- body begins here -->

<refsect1 id="description"><title>DESCRIPTION</title>
<para>
Gfarm/BBは計算ノードのローカルストレージを用いる、一時的なオンデマンド
ユーザレベルファイルシステムです。
<command moreinfo="none">gfarmbb</command>はGfarm/BBの構築、撤去を行い
ます。<parameter moreinfo="none">mode</parameter>には、startかstopかstatusを指定します。modeがstartのとき、
Gfarm/BBを利用するための環境変数が表示されます。Gfarm/BBに対しGfarmコ
マンドを用いるためには、次のように環境変数を評価します。
</para>
<para>
% eval `gfarmbb start`
</para>
<para>
原則的に、start, stop, statusについて同じオプションを指定して下さい。
</para>
</refsect1>

<refsect1 id="options"><title>OPTIONS</title>

<variablelist>

<varlistentry>
<term><option>-mpi</option> <parameter moreinfo="none">mpirun_cmd</parameter></term>
<listitem>
<para>
Gfarm/BBをMPIを用いて構築します。
<parameter moreinfo="none">mpirun_cmd</parameter>はGfarm/BBの構築とgfsd
の起動に用いられるMPIのコマンドラインを指定します。本オプションは
-confオプションと共に用います。本オプションが指定された場合、-eオプ
ションと-hオプションは無視されます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>
gfmdを別ノードで実行します。gfmdはgfarmbbを実行したホストで実行さ
れますが、gfmdを起動したノードではgfsdを起動しません。本オプション
は、N+1ホストが割り当てられ、ホストファイルの最後のノードでgfarmbb
を起動することを想定しています。本オプションはstartの時だけ有効です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-h</option> <parameter moreinfo="none">hostfile</parameter></term>
<listitem>
<para>
計算ノードのホスト名のリストを含む
<parameter moreinfo="none">hostfile</parameter>を指定します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-scr</option> <parameter moreinfo="none">scratch_dir</parameter></term>
<listitem>
<para>
Gfarm/BBを構成するための各計算ノードのスクラッチディレクトリを指定
します。指定されたディレクトリが存在しない場合は作成されます。また
このディレクトリ以下のファイルはgfarmbb stopで削除されます。
デフォルトは/tmp/gfarmbb-scratchです。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-conf</option> <parameter moreinfo="none">conf_dir</parameter></term>
<listitem>
<para>
Gfarm/BBの設定ファイルを一時的に保持するためのディレクトリを指定し
ます。本ディレクトリは全計算ノードからアクセスできる必要があります。
指定されたディレクトリが存在しない場合は作成されます。またこのディ
レクトリ以下のファイルはgfarmbb stopで削除されます。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-l</option></term>
<listitem>
<para>
ログインノードからGfarm/BBのアクセスを可能とします。このオプション
をつけるとホームディレクトリにGfarm/BBの設定ファイルを作成します。
設定ファイルのパス名は$HOME/.gfarm2rc-$IDとなります。IDは計算ノー
ドのホスト名とプロセスIDで構成されます。Gfarm/BBをアクセスする場合
は、この設定ファイルをGFARM_CONFIG_FILE環境変数で指定します。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-L</option> <parameter moreinfo="none">log_dir</parameter></term>
<listitem>
<para>
ログディレクトリを指定します。指定されたディレクトリが存在しない場
合は作成されます。gfmd, gfsdのログファイル名はそれぞれgfmd-$ID.log,
gfsd-$ID.logです。デフォルトはスクラッチディレクトリ/logです。本オ
プションはstartの時だけ有効です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-m</option> <parameter moreinfo="none">mount_point</parameter></term>
<listitem>
<para>
このオプションが指定されたとき、構築したGfarm/BBは指定されたマウン
トポイントにマウントされます。mount.gfarm2fsが必要です。また、本オ
プションはstartの時だけ有効です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-p</option> <parameter moreinfo="none">period</parameter></term>
<listitem>
<para>
Gfarm/BBの共有鍵の有効期間を秒単位で指定します。有効時間はジョブ実
行時間より長くする必要があります。デフォルトは86400秒（1日）です。
本オプションはstartの時だけ有効です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-c</option></term>
<listitem>
<para>
Cシェルのコマンドを出力します。本オプションはstartの時だけ有効です。
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><option>-s</option></term>
<listitem>
<para>
Bourneシェルのコマンドを出力します。本オプションはstartの時だけ有
効です。デフォルト設定です。
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>
</refentry>
