Kompira Enterprise 上で Wiki ページを作成する

運用チームで Kompira Enterprise を共有して利用する場合、作業手順などの情報を共有して閲覧できるようにするために、Kompira Enterprise 内に Wiki を作成することが出来ます。例えばオペレータ向けに確認事項やジョブフローへのリンクをまとめておくと重宝するでしょう。
またジョブフローを実行して得られた情報などを Wiki に自動的に記録しておくこともできます。


動作確認環境

ソフトウェア バージョン
Kompira Enterprise 1.4.10.post10
OS CentOS 6.10

または

ソフトウェア バージョン
Kompira Enterprise 1.5.5.post7
OS CentOS 7.8.2003

または

ソフトウェア バージョン
Kompira Enterprise 1.6.2.post4
OS CentOS 8.2.2004

または

ソフトウェア バージョン
Kompira Enterprise 1.6.8
OS CentOS Stream 8

Wiki の作成

新規のジョブフローを作成する場合と同様に、Wiki ページ型のオブジェクトを作成します。ここでは 「作業手順」という名前で作成してみましょう。

次のような編集画面が表示されます。

Wiki でメモを書いていく場合、「スタイル」と呼ばれる一定の記法に従って Wiki テキスト欄に書くことで、太字、イタリックなどの表示、表の作成、外部リンクの作成などが出来るようになります。
スタイルは、スタイル欄から (1) Creole (デフォルト) 、(2) Markdown 、(3) Textile の3種類の Wiki 記法を選択することが出来ます。各記法の詳細については、スタイル欄の下にそれぞれリンクがありますので参照してください。ここでは Markdown 記法を使っていきます。

簡単な例として、Wiki テキスト欄に次の様に記載してみます。

## プロセスの状態確認の手順 
- サーバーのプロセスの状態を確認してください。[/root/プロセス状態確認](状態確認ジョブフローへのリンク)
- もし NG が表示されたら、プロセスを再起動してください。[/root/プロセス再起動](再起動ジョブフローへのリンク) 
- もし OK が表示されたら、作業は完了です。

保存ボタンをクリックすると、次の様に表示されます。

上記は、行の先頭に “-” を記載すると箇条書きリストになり、[] で囲んだ文字が () で示したリンクにつながる Markdown 記法の例です。
このようにして手順の解説とジョブフローへのリンクをまとめておくと便利でしょう。

ジョブフローから Wiki に保存する方法

Wiki オブジェクトのフィールドについて Kompira Enterprise のヘルプを調べてみると、「wikitext」 フィールドに Wiki ページのテキストが格納されていることがわかります。

そのため、既存の Wiki オブジェクト「Wikiページ」が存在しているとして、この「Wikiページ」の内容をジョブフローから変更する場合、以下のようにします。

[message = '変更後メッセージ'] ->
[message >> ./Wikiページ['wikitext']]

「Wikiページ」 にメッセージを追記していく場合は次のように、いったん内容を変数に保存して、追記文字列を結合した後に改めて wikitext フィールドに書き戻します。下記の例で ‘<br>’ は Markdown 記法における改行を表します。

[message = '追記メッセージ'] ->
[src = ./Wikiページ['wikitext']] ->
[src + '<br>' + message >> ./Wikiページ['wikitext']]

上記のように、ジョブフローから既存の Wiki ページの内容を書き換える事が出来ます。取得したシステムの情報や作業記録を追記していく用途などでご利用ください。

TOP