Environments/Settings TOP

ツール

このページでは、各種ツールについて説明しています。

K2HR3提供のツール

この章では、K2HR3システムで提供しているツールを説明しています。

Watcher

ここでは、Watcher の用途と使い方を説明しています。

Watcherは、K2HR3 OpenStack Notification Listenerが利用できない環境において、仮想コンピューティング（Virtual Machine）削除の監視、およびロール（ROLE）へのメンバーから対象のホスト（HOST）の自動削除を行うためのシステム（プログラム）です。

Watcher とK2HR3システム全体と Watcher の構成イメージを以下に示します。
K2HR3 Watcher overview

Watcherの使い方は次の通りです。

$ git clone https://github.com/yahoojapan/k2hr3_api.git && cd k2hr3_api
$ ./bin/run.sh -h
Usage:   run.sh [--production(default) | --development]
            [--stop]
            [--background(-bg) | --foreground(-fg)]
            [--debug(-d) | --debug-nobrk(-dnobrk)]
            [--debuglevel DBG/MSG/WARN/ERR/(custom debug level)]
            [--watcher [--oneshot]]

Option:  --production           : Set 'production' to NODE_ENV environment
                                  (This option is default and exclusive with
                                  the '--development' option)
         --development          : Set 'development' to NODE_ENV environment
                                  (exclusive with the '--production' option)
         --stop                 : Stop www or watcher nodejs process
         --debug(-d)            : Run with nodejs inspector option
         --debug-nobrk(-dnobrk) : Run with nodejs inspector option
                                  (no break at start)
         --debuglevel           : Specify the level of debug output.
                                  (DBG/MSG/WARN/ERR/custom debug level)
         --watcher              : Run IP watcher process as daemon
         --oneshot              : Run watcher process only once

devcluster

ここでは、devcluster の用途と使い方を説明します。

devclusterは、K2HR3の全サブシステムをlocalhostに構築します。主に開発＆テストのためのツールです。

$ git clone https://github.com/yahoojapan/k2hr3_utils.git && cd k2hr3_utils/devcluster
$ sh cluster.sh -h
usage : cluster.sh [-d] [-f file] [-o file] [-p file] [-h] [-t url] [-v]
    -d        print debug messages
    -i file   k2hr3-api package file path(or URL)
    -o file   k2hr3-osnl package file path(or URL)
    -p file   k2hr3-app package file path(or URL)
    -h        display this message and exit
    -s url    OpenStack Identity Service Endpoint(Default: 'http://127.0.0.1/identity')
    -t url    TransportURL(Default: 'rabbit://guest:guest@127.0.0.1:5672/')
    -v        display version and exit

K2HR3 Get Resource

ここでは、K2HR3 Get Resource の用途と使い方を説明しています。

K2HR3 Get Resourceは、仮想コンピューティング（Virtual Machine）がOpenStackのUser Data Scriptを使って起動され、ロール（ROLE）に自動登録された環境で利用できます。
K2HR3 Get Resourceは、仮想コンピューティング（Virtual Machine）が登録されているロール（ROLE）に対応したリソース（RESOURCE）を定期的に取得する Systemdサービス です。
これを使うことで、定期的にリソース（RESOURCE）データを取得し、ファイルなどに出力することができます。

例えば、リソース（RESOURCE）は、K2HR3テンプレートエンジンを使った動的なデータを設定できます。
この動的なデータが変化する環境において、K2HR3 Get Resourceを使うことで、リソース（RESOURCE）データを更新できます。

インストール

K2HR3 Get Resourceは、ロール（ROLE）に登録されている仮想コンピューティング（Virtual Machine）で利用できます。

K2HR3 Get Resourceは、packagecloud.io で k2hr3-get-resourceパッケージで提供されています。
ホスト（HOST）のOSに応じたパッケージをインストールしてください。
パッケージが提供されていないOSの場合は、開発者で説明している方法でパッケージを作成できます。

起動・停止

K2HR3 Get Resourceは、Systemdサービスとしてインストールされますので、以下の手順で起動できます。
なお、このパッケージは、インストール直後はDisableのSystemd timerサービスとなっています。

$ sudo systemctl enable k2hr3-get-resource.timer
$ sudo systemctl start k2hr3-get-resource.timer

停止する場合は、以下の手順で停止できます。

$ sudo systemctl stop k2hr3-get-resource.timer

リソース（RESOURCE）

K2HR3 Get Resourceが取得するリソース（RESOURCE）は、ロール（ROLE）に対応したYRNパスのリソース（RESOURCE）です。
例えば、ロール（ROLE）が以下のYRNパスだとします。

yrn:yahoo:::mytenant:role:myhosts

この場合、以下のYRNパスのリソース（RESOURCE）を取得します。

yrn:yahoo:::mytenant:resoruce:myhosts

カスタマイズ

K2HR3 Get Resourceは、以下に説明するファイルをインストール・参照します。

/etc/antpickax/k2hr3-get-resource-helper.conf

このファイルは、K2HR3 Get Resourceの設定ファイルであり、パッケージでインストールされます。
以下のキーワードの値を設定して、K2HR3 Get Resourceの動作を変更することができます。

/etc/antpickax/override.conf

このファイルは、K2HR3 Get Resourceが参照する設定ファイルの一つであり、k2hr3-get-resource-helper.confと同じキーワードを設定できます。
ただし、同じキーワードがk2hr3-get-resource-helper.confと競合する場合は、override.confの値が優先されます。

キーワードの指定が、k2hr3-get-resource-helper.confとは異なり、以下のいずれかの方法で値を指定します。

書式1

[customize configuration file path]:[keyword] = value

カスタマイズコンフィグレーションファイルのパスとキーワードを指定して、値を直接設定する書式です。
例えば、以下のように指定します。

/etc/antpickax/k2hr3-get-resource-helper.conf:OUTPUT_DIR = /tmp

書式2

[customize configuration file path]:[keyword] = [customize configuration file path]:[keyword]

カスタマイズコンフィグレーションファイルのパスとキーワードを指定して、値を他のコンフィグレーションファイルで設定する書式です。
例えば、以下のように指定します。

/etc/antpickax/k2hr3-get-resource-helper.conf:LOGDIR = /etc/antpickax/other.conf:LOGDIR

その他のツール

この章では、K2HR3のサブシステムに付属する管理ツールを紹介します。

k2hdkclinetool

k2hdkclinetoolは、データーサーバー（K2HDKC）に格納されているデータへの参照、更新、削除など全ての操作を対話形式で実行するツールです。

詳しい使い方は、K2HDKCのツール をご覧ください。

chmpxlinetool

chmpxlinetoolは、chmpxプロセスを制御する対話形式で実行できます。

詳しい使い方は、CHMPXのツール をご覧ください。

chmpxstatus

chmpxstatusは、CHMPXクラスタ内のホストの状態を表示するツールです。

詳しい使い方は、CHMPXのツール をご覧ください。

k2hlinetool

k2hlinetoolは、K2HASHデータベースへの参照、更新、削除など全ての操作を対話形式で実行できます。

詳しい使い方は、K2HASHのツール をご覧ください。

Environments/Settings TOP