 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. 概要
Checkmk 拡張パッケージ（MKP）は、機能拡張だけでなく、グラフィカルユーザーインターフェース（GUI）用の拡張（ダッシュボード、ビュー、レポートなど）もパッケージ化できます。 この機能の利点は、商業版では、外部ファイルやツールを使用せずに、web インターフェイスから直接 MKP を作成できることです。 もちろん、この目的のためにコマンドラインも使用できますが、これも商業版のみです。
MKPs は、社内の他のユーザーや Checkmk インストール、そしてもちろんCheckmk Exchange を通じて共有することができます。 しかし、コミュニティや他のサイトの参加がなくても、複雑な作成物をパッケージ化できることは有用です。
たとえば、Make this dashboard available for other users オプションを使用してダッシュボードを作成した場合、そのダッシュボードは、すべてのユーザーまたは選択したユーザーも使用できます。 ユーザーがダッシュボードを削除した場合、他のユーザーは当然そのダッシュボードを使用できなくなります。ただし、他のユーザーがすでに個人用コピーを作成している場合はこの限りではありません。 そのため、適切な権限を持つユーザーが、ダッシュボードを拡張機能として公開することは理にかなっています。
これにより、ダッシュボードのバージョン管理も可能になり、問題のない更新に役立ちます。
MKP を作成する手順は、すべてのタイプの GUI 拡張機能で同じであるため、以下ではダッシュボードの例に限定して説明します。
前提条件：ユーザーは、Manage Extension Packages (MKPs) の許可が必要です。
2. webインターフェイス
2.1. GUI-MKP の作成
Customize > Visualization > Dashboards のダッシュボードリストから始めましょう。 すでに独自のダッシュボードを作成している場合は、そのダッシュボードを使用できます。 そうでない場合は、ビルトインのダッシュボードのプライベートコピーを作成してください。 どちらの場合も、Customized セクションのダッシュボードが起点となります。
Clone this dashboard for packaging as extension package を使用して、ダッシュボードから拡張機能を作成します。この拡張機能は、その後、Extensions セクションにリストされます。
ここから、Go to extension packages に移動すると、拡張機能パッケージの管理画面が表示されます。 で、パッケージ化されていない拡張機能、つまりファイルを確認できます。Packages > List unpackaged files.
Create Package 経由で、パッケージを作成できます。
パッケージのプロパティの下部にあるPackaged files に、先ほど作成した GUI 拡張機能を追加します。
もちろん、複数のダッシュボードやその他のエレメントも追加できます。
それ以外で注意すべき点は、バージョン情報が正しいかどうかです。
まず、パッケージ自体にバージョン番号が必要です。
これは、1.0.0 などで説明されているセマンティックバージョニングのガイドラインに従う必要があります。
次に、サポートする Checkmk の最小バージョンと最大バージョンを指定できます。
バージョン管理は、Checkmk のアップデートや、異なる Checkmk バージョンを使用するサイトを含む分散監視に便利です（詳細については、MKP の記事をご覧ください）。
パッケージングが完了すると、新しいパッケージは拡張パッケージのホームページにリストされます。この例では、2 つの異なるバージョン（1 つは有効、もう 1 つは無効）がリストされています。
All packages (enabled or disabled) では、パッケージを MKP ファイルとしてダウンロードするオプションが利用可能です。
2.2. GUI-MKP のインストール
パッケージのインストールは、ほとんど説明不要です。 まず、Upload package のSetup > Maintenance > Extension packages から、目的のパッケージをアップロードします。
パッケージは再びAll packages (enabled or disabled) テーブルに保存され、そこから を使用して有効化できます。
3. コマンドライン
3.1. GUI-MKP の作成
あるいは、コマンドラインからパッケージングを行うこともできます。 手順は、MKP の記事で詳しく説明している機能拡張のパッケージングとまったく同じですので、ここでは簡略版をご紹介します。
ダッシュボードを作成します。
サイトユーザーとしてコマンドラインに切り替えます。
パッケージ化されていないファイルをリストします。
mkp findパッケージ構成を作成します:
mkp template mydashboard設定を編集します。
~/tmp/check_mk/mydashboard.manifest.tempパッケージを作成します:
mkp package tmp/check_mk/mydashboard.manifest.tempパッケージは次の名前で保存されます:
/var/check_mk/packages_local/mydashboard-1.0.0.mkp
3.2. GUI-MKPs のインストール
このような MKP をインストールして有効にしたい場合は、次のように入力してください。
インストール:
mkp add /tmp/mydashboard-1.0.0.mkp有効化:
mkp enable mydashboard-1.0.0.mkp
コマンドのリファレンス、MKP フォーマットの説明、その他の注意事項については、MKP の記事をご覧ください。
Checkmk Rawユーザーへの注意:
繰り返しになりますが、GUI 拡張機能は他の MKP と同様にインストールできます。
ただし、商業版には独自のビジュアルエレメント (ダッシュレットなど) が含まれているため、次のようなメッセージが表示される場合があります。
Dashlet type 'state_host' could not be found. Please remove it from your dashboard configuration.
この場合、1 つのダッシュレットが欠落していますが、ダッシュボードの他の部分は引き続き使用できます。
4. ファイルおよびディレクトリ
| ファイルパス | 説明 |
|---|---|
|
拡張機能として複製されたビューの保存場所。 |
|
拡張機能として複製されたレポートの保存場所です。 |
|
拡張機能として複製されたダッシュボードの保存場所です。 |
|
パッケージを構築するための設定ファイル。 |
|
インストールされた MKP の場所です。 |
|
アクティベートされたMKPsの保存場所。 |