h1. リファレンス

h2. 必要な環境

h3. 対応ホストOS

# CentOS 5.3以降 32bit/64bit

# RHEL 5.3以降 32bit/64bit

<br>

h3. 対応ゲストOS

# Xenの準仮想化に対応しているOSすべて（仮想化ハイパーバイザーがXenの場合）

# Linux、FreeBSD、OpenSolaris、Windows（仮想化ハイパーバイザーがKVMの場合）

<br>

h3. 推奨スペック

# CPU : Intel Core 2 Duo以上

# メモリ : 2GB以上

# HDD : 100GB以上

<br>

h3. データベース

# SQLite3(※マルチホスト非対応)

# MySQL

# PostgreSQL

# その他

http://www.sqlalchemy.org/docs/05/dbengine.html?highlight=db2#supported-databases

<br>

h3. ブラウザ

# Firefox 3以降

# Safari 3(Mac)以降

# Opera 9以降

# Google Chrome

<br>

h2. 機能一覧

※Karesansuiでは仮想マシンを立ち上げるサーバーのことを「ホスト」、ホスト上で動作する仮想マシンのことを「ゲスト」と呼びます。

|分類|機能|説明|対応|

|共通|ログイン|Basic認証でログインします。|○|

|共通|ログアウト|ログアウトします。|○|

|共通|プロキシ|ネットワーク関連で利用するProxyを設定することができます。|○|

|共通|マイアカウント設定|現在ログインしているアカウント情報を更新することができます。|○|

|共通|タグ|ゲストのグルーピングができます。今後さまざまなリソースをタグによってグルーピングすることができるようになります。|○|

|セキュリティ|SSL接続設定|SSLの有効・無効を設定できます。|○|

|セキュリティ|アクセスポリシー|Karesansuiへのアクセスポリシーを設定できます。|○|

|セキュリティ|VNCへのパスワード設定|ゲストへVNC接続する際に利用する、パスワードを設定することができます。|○|

|セキュリティ|ホワイトリスト|実行可能なジョブコマンドをホワイトリスト形式で制限することができます。（画面からの設定はできません。）|○|

|その他|Karesansui|Karesansuiのバージョン情報を表示します。|○|

|全体|一覧ページ|ホストの一覧を表示します。|○|

|全体|Karesansui設定(ウェブサーバー)|Karesansuiの設定ができます。プロキシの設定は Version 1.0 では現在使用されていません。|○|

|全体|Karesansui設定(メールサーバー)|Karesansuiの設定ができます。設定は Version 1.0 では現在利用されていません。|○|

|全体|ホスト、ゲストのツリーナビゲーション|Karesansuiで管理しているホスト、ゲストをツリー形式で表示します。|○|

|全体|複数のホストを管理|Karesansuiで管理されているホストを複数管理することができます。|○|

|ホスト|ゲストの一覧ページ|ゲストの一覧を表示します。|○|

|ホスト|情報ページ|ホストの情報を表示します。|○|

|ホスト|ゲストの作成|ゲストの作成ができます。|○|

|ホスト|ゲストのコピー|現在管理されているゲストのコピーができます。|○|

|ホスト|ゲストの削除|現在管理されているゲストの削除ができます。|○|

|ホスト|編集|ホストの情報を編集します。|○|

|ホスト|ジョブ一覧|ホストで実行されたジョブ情報を検索、表示できます。|○|

|ホスト|ネットワークの追加・編集・削除|仮想ネットワークを管理できます。|○|

|ホスト|ファイアーウォールの追加・編集・削除|ファイアーウォールの管理ができます。|○|

|ホスト|ファイアーウォールの起動・停止|ファイアーウォールの起動、停止ができます。|○|

|管理|ユーザ作成・編集・削除|ユーザの管理ができます。|○|

|管理|タグ作成・編集・削除|タグの管理ができます。|○|

|ゲスト|情報ページ|ゲストの情報を表示します。|○|

|ゲスト|起動|ゲストの起動ができます。|○|

|ゲスト|一時停止・復帰|ゲストの一時停止、復帰ができます。|○|

|ゲスト|強制シャットダウン|強制的にゲストを停止できます。|○|

|ゲスト|シャットダウン|通常の手順でゲストを停止できます。|○|

|ゲスト|スナップショットの作成・編集・削除|スナップショットの管理ができます。|○|

|ゲスト|スナップショットの適応|指定したスナップショットを管理しているゲストに適応できます。|○|

|ゲスト|ストレージ(HDD)の追加・編集・削除|ストレージ(HDD)の管理ができます。|○|

|ゲスト|ネットワーク(NIC)の追加・編集・削除|ネットワーク(NIC)の管理ができます。|○|

|ゲスト|ディスプレイ(VNC)の追加・編集・削除|ディスプレイ(VNC)の管理ができます。|○|

|ゲスト|CPU数の変更|CPU数の変更できます。|○|

|ゲスト|メモリの変更|メモリサイズの変更ができます。|○|

|ゲスト|ジョブ一覧|対象のゲストで実行されたジョブ情報を検索、表示できます。|○|

|ゲスト|コンソール|ブラウザからグラフィカル(GUI)な画面でゲストを操作することができます。|○|

<br>

h2. ソースのダウンロード方法

Karesansuiのソースコードを取得するには、いくつかの方法があります。

<br/>

h4. sourceforge.jpからダウンロード

ソースコードは、Karesansuiのインストールパック(tarball)の中に、RPMパッケージとしても提供されています。

Karesansuiのインストールパックは、"ダウンロードページ":http://sourceforge.jp/projects/karesansui/releases/ から最新のKaresansui-1.x.tar.gz を選択してダウンロードできます。

<br/>

h4. gitリポジトリからダウンロード

最新のソースコードは、sourceforge.jpのgitリポジトリから取り寄せることもできます。

gitがインストールされていない場合は、あらかじめgitをインストールした後、以下のコマンドでダウンロードすることができます。

<pre>

$ git clone git://git.sourceforge.jp/gitroot/karesansui/karesansui.git

</pre>

h2. 設定ファイル(log.conf)の説明

[[Ja_faq#ログ関連|FAQを参照]]

<br>

h2. application.confの説明

h3. application.search.path

bq. Pythonの追加サーチパスを設定します。

※複数指定する場合はカンマ(,)で区切ります

<pre>

例) application.search.path=/opt/hde/lib/python,/opt/pysilhouette/lib/python,/opt/karesansui/lib/python

</pre>

h3. application.log.config

bq. ログ出力設定ファイルパスを設定します。

ログ出力設定ファイルついては[[Ja_faq#ログ関連|こちら]]を参照してください。

<pre>

例) application.log.config=/etc/opt/karesansui/log.conf

</pre>

h3. application.url.prefix

bq. URIのプレフィックスを設定します。

以下の{}内を設定します。

http://example.com{/karesansui/v1}/

※v1はKaresansuiのメジャーバージョンを指定しておくことを推奨します。

<pre>

例) application.url.prefix=/karesansui/v1

</pre>

h3. application.default.locale

bq. Karesansuiが使用するデフォルトのロケールを設定します。

※現在、ja_JPとen_USに対応しています。

※ログインしている場合は、ログインユーザのロケールが優先されます。

<pre>

例) application.default.locale=ja_JP

</pre>

h3. application.template.theme

bq. Karesansuiのテーマを設定します。

※初期インストール時はdefaultに設定されています。

<pre>

例) application.template.theme=default

</pre>

h3. application.tmp.dir

bq. Karesansuiが一時的に作成するファイル等々をおくディレクトリパスを設定します。

<pre>

例) application.tmp.dir=/tmp

</pre>

h3. application.bin.dir

bq. Karesansuiが使用するジョブコマンドのディレクトリパスを設定します。

※Karesansuiの実行ユーザ権限で書き込みができる必要があります。

<pre>

例) application.bin.dir=/opt/karesansui/bin

</pre>

h3. application.generate.dir

bq. 各種設定ファイルのテンプレートディレクトリを設定します。

<pre>

例) application.generate.dir=/opt/karesansui/karesansui/templates/default/_generate

</pre>

h3. application.mail.email

bq. Karesansuiで利用するメールアドレスを設定します。

<pre>

例) application.mail.email=karesansui@example.com

</pre>

h3. application.mail.port

bq. Karesansuiで利用するメールサーバのポート番号を設定します。

<pre>

例) application.mail.port=25

</pre>

h3. application.mail.server

bq. Karesansuiで利用するメールサーバ名を設定します。

<pre>

例) application.mail.server=localhost

</pre>

h3. application.proxy.status

bq. Karesansuiでプロキシサーバを利用するかを設定します。

1=有効

0=無効

<pre>

例)application.proxy.status=0

</pre>

h3. application.proxy.server

bq. Karesansuiで利用するプロキシサーバ名を設定します。

<pre>

例) application.proxy.server=localhost

</pre>

h3. application.proxy.port

bq. Karesansuiで利用するプロキシサーバのポート番号を設定します。

<pre>

例) application.proxy.port=9080

</pre>

h3. application.proxy.user

bq. Karesansuiで利用するプロキシサーバにログインするユーザ名を設定します。

<pre>

例) application.proxy.user=bar

</pre>

h3. application.proxy.password

bq. Karesansuiで利用するプロキシサーバにログインするパスワードを設定します。

<pre>

例)application.proxy.password=foo

</pre>

h3. lighttpd.etc.dir

bq. KaresansuiをLighttpdで動作させる場合に利用する設定ファイルを置くディレクトリを設定します。

<pre>

例) lighttpd.etc.dir=/etc/opt/hde/lighttpd/conf.d/karesansui

</pre>

h3. database.bind

bq. Karesansuiで利用するデータベースのバインドを設定します。

RFC-1738で定義されているスタイルで設定してください。

さらに詳しい設定については"SQLAlchemyのサポートデータベース":http://www.sqlalchemy.org/docs/05/dbengine.html#supported-databases を参照してください。

<pre>

MySQL

mysql://localhost/<データベース名>

mysql://<ユーザ名>:<パスワード>@<ホスト名>/<データベース名>

mysql://<ユーザ名>:<パスワード>@<ホスト名>:<ポート番号>/<データベース名>

PostgreSQL

postgres://<ユーザ名>:<パスワード>@<ホスト名>:<ポート番号>/<データベース名>

SQLite※Karesansuiの実行権限で読み取り・書き込み可能である必要があります。

sqlite:////<絶対パス>/<ファイル名>-絶対パスで定義

sqlite:///<相対パス>/<ファイル名>-相対パスで定義

例) database.bind=sqlite:////var/opt/karesansui/karesansui.db

</pre>

h3. database.pool.status

bq. コネクションプールの利用可否を設定します。

0=利用しない

1=利用する

<pre>

例)database.pool.status=0

</pre>

h3. database.pool.size

bq. 通常時のコネクションプール数を設定します。

※SQLiteでは利用できません。設定は無視されます。

<pre>

例)database.pool.size=1

</pre>

h3. database.pool.max.overflow

bq. コネクションプールの最大数を設定します。

<pre>

例)database.pool.max.overflow=10

</pre>

h3. pysilhouette.conf.path

bq. Karesansuiで使用するPysilhouetteソフトウェアの設定ファイルパスを設定します。

※Karesansuiの実行ユーザ権限で読み取り可能である必要があります。(書き込み・実行権限は必要ありません。)

<pre>

例)pysilhouette.conf.path=/etc/opt/pysilhouette/silhouette.conf

</pre>

h3. application.updater.yum.cachedir

bq. Karesansuiが利用するyumのキャッシュディレクトリを設定します。

注)wwwhde(hde-lighttpdサービス)ユーザの書き込み権限が必要です。

<pre>

例)application.updater.yum.cachedir=/var/opt/karesansui/cache/yum

</pre>

h3. application.updater.yum.log.file

bq. Karesansui経由で実行されたyumのログファイルを設定します。

<pre>

例)application.updater.yum.log.file=/var/log/karesansui/yum.log

</pre>

h3. application.updater.yum.target.repos

bq. Karesansui用のyumリポジトリ名を設定します。

<pre>

例)application.updater.yum.target.repos=karesansui-base

</pre>

<br>

h2. 起動停止方法、自動起動設定方法

Karesansuiには主に5つのサービスを利用しています。

注）インストーラーでインストールしている場合はインストール時に自動起動設定が行われていますので再度行う必要はありません。

* hde-libvirtd

bq. 仮想化制御を抽象化したライブラリ(libvirtd) デーモンです。

注）ディストリビューションのlibvirtdが起動していると正常に起動することができません。

必ずlibvirtdは停止させた上でhde-libvirtdを起動してください。

<pre>

起動、停止方法の例

起動 : /etc/init.d/hde-libvirtd start

停止 : /etc/init.d/hde-libvirtd stop

自動起動設定の例

設定 : chkconfig hde-libvirtd on

設定確認 : chkconfig --list hde-libvirtd

</pre>

* hde-lighttpd

bq. Webインターフェース用のWebサーバー（Lighttpd)

<pre>

起動、停止方法の例

起動 : /etc/init.d/hde-lighttpd start

停止 : /etc/init.d/hde-lighttpd stop

自動起動設定の例

設定 : chkconfig hde-lighttpd on

設定確認 : chkconfig --list hde-lighttpd

</pre>

* silhouetted

bq. ジョブ管理サービス

<pre>

起動、停止方法の例

起動 : /etc/init.d/silhouetted start

停止 : /etc/init.d/silhouetted stop

自動起動設定の例

設定 : chkconfig silhouetted on

設定確認 : chkconfig --list silhouetted

</pre>

h2. 依存関係での問題

以下のソフトウェアが不足する可能性がありますので事前にインストールしておく必要があります。

パッケージ名

<pre>

iscsi-initiator-utils

cyrus-sasl-md5

gnutls-utils

PyXML

</pre>

yumからのインストール

<pre>

# yum install iscsi-initiator-utils

# yum install cyrus-sasl-md5

# yum install qemu

# yum install gnutls-utils

# yum install PyXML

</pre>

rpmからのインストール

<pre>

# rpm -ivh iscsi-initiator-utils

# rpm -ivh cyrus-sasl-md5

# rpm -ivh qemu

# rpm -ivh gnutls-utils

# rpm -ivh PyXML

</pre>

h2. インストール後の問題

正常にインストールしたにも関わらず、正常に動作しない場合は、インストールしたディレクトリ内にある karesansui-checkenv を実行してください。現在のシステム環境情報が表示され問題を解決に導きます。

実行結果例

<pre>

# ./karesansui-checkenv

@==========================================@

@   Karesansui Environment Check Program   @

@==========================================@

KaresansuiのRPMパッケージが正常にインストールされているかをチェック...  OK

Karesansuiの設定パラメータをチェック...  OK

Karesansuiのpythonモジュールをインポートできるかチェック...  OK

Karesansuiのグループが存在するかをチェック...  OK

Karesansuiの設定ファイルがロードできるかをチェック...  OK

sqlalchemyモジュールをインポートできるかチェック...  OK

pysilhouetteモジュールをインポートできるかチェック...  OK

pysilhouetteの設定パラメータをチェック...  OK

pysilhouetteの設定ファイルがロードできるかをチェック...  OK

KaresansuiのデータベースAPIモジュールをインポートできるかチェック...  sqlite

データベース Karesansui に接続できるかをチェック...  sqlite:////var/opt/karesansui/karesansui.db

KaresansuiのSQLiteデータベースのパーミッションをチェック...  OK

pysilhouetteのデータベースAPIモジュールをインポートできるかチェック...  sqlite

データベース pysilhouette に接続できるかをチェック...  sqlite:////var/opt/pysilhouette/pysilhouette.db

pysilhouetteのSQLiteデータベースのパーミッションをチェック...  OK

Karesansuiのファイル/ディレクトリのパーミッションをチェック...  OK

Karesansuiのpythonモジュールをインポートできるかチェック...  OK

全てのチェックをクリアしました。

下記サイトにアクセスしログインしてください。

 https://karesansui-project.info/karesansui/v1/

 http://karesansui-project.info/karesansui/v1/

</pre>

h3. 画面構成

Karesansuiの画面は4つのパーツで構成されています。

!display-parts.png!

A： ヘッダー

B：メイン

C：ドメインツリー

D：ログメッセージ

h3. ヘッダー

!diaplay-parts-A.png!

A：ロゴ

クリックするとトップページへ移動します。

B：パンくず

KaresansuiはTOP, ホスト、ゲストの3つの画面を遷移して操作します。

この部分には現在どの画面にいるか表示されます。

また、リンクをクリックすることでその画面へ遷移します。

C：ログインユーザ名表示

ログインしているサーバーのホスト名や、ログインしているユーザーのメールアドレスが表示されます。

D：メニュー

ログインしているユーザーの情報を編集したり、Karesansuiからログアウトすることができます。

E：通知アイコン

実行中のジョブがあることや、サーバーとAJAX通信中であることを点滅して示すアイコンです。

h3. メイン

!display-parts-B.png!

A：タブ

クリックすると、その内容にメイン画面が遷移します。

B：ボタン

クリックすると、追加や変更などを行うことができます。

暗い色になっているボタンは押しても実行することができません。

C：タグ

ホスト一覧やゲスト一覧の画面に表示されます。ホストやゲストに登録されたタグを使って

アイコンの表示を絞り込むことができます。

D：ホスト（ゲスト）アイコン

一度目のクリックで下の詳細表示画面に詳細が表示されます。

その際、背景に緑色の枠が表示されます。

二度目のクリックで選択したホスト（ゲスト）の画面に遷移します。

ホスト（ゲスト）の編集で、表示するアイコンを変更することができます。

E：詳細表示

ジョブの登録者や登録時間、ホストのメモリ総量やディスク使用量など、細かい情報を表示します。

F：更新アイコン

クリックすると、メイン画面の内容を更新します。

h3. ドメインツリー

!diaplay-parts-C.png!

A：ツリー

ホストと、その上に作られているゲストをツリー状に表示します。

各リンクをクリックすることでそのホストやゲストの画面に遷移します。

また、ホストの横にある▼のアイコンを押すことで開閉することができます。

B：更新アイコン

クリックするとツリーの内容を更新します。

h3. ログメッセージ

!diaplay-parts-D.png!

A：ログメッセージ

直近5件のジョブの進捗や結果などの情報を表示します。

B：更新アイコン

クリックするとログメッセージの内容を更新します。