omd によるサイト管理

場合によっては、作成する新しいユーザーのユーザー ID/グループ ID を指定することも望ましいでしょう。 これは、-u および-g オプションを使用して行います。

その他のオプションの概要は、omd create --help で表示できます。 最も重要なオプションは次のとおりです。

デフォルトでは、新しいサイトのホームディレクトリは/omd/sites/ に作成され、デフォルトのファイルが格納されます。 ただし、この場所に外部ボリュームをマウントする場合など、空のホームディレクトリを作成することもできます。 これは、--no-init オプションを使用して行います。

このオプションは、システム Apache との統合も省略し、/omd/apache/mysite.conf を空のままにします。 その後、任意のディレクトリまたはボリュームをマウントして、セットアップを続行できます。

omd init は、省略された 2 つのステップを実行し、デフォルトファイルを追加して Apache 設定を作成します。

サイトユーザーは、次のように入力するだけで対話モードを呼び出すことができます。

サイトの実行中に設定を変更すると、OMD は、まずサイトを停止する必要があることを通知し、必要に応じてその操作を行います。

作業が完了したら、サイトを再起動することを忘れないでください。omd config は、この操作を自動的に実行しません。

対話モードが嫌いだ、あるいはスクリプトを使って作業したい場合は、コマンドラインから個々の設定を変数として設定することができます。 このためには、omd config set コマンドがあります。 次の例では、AUTOSTART 変数をoff に設定しています。

サイトの名前を引数として追加すると、root として実行することもできます。

すべての変数の現在の割り当ては、コマンドomd config mysite show ではroot 、サイトユーザーではomd config show と表示されます。

上記のコマンド出力は、わかりやすくするために省略されており、最初のエントリのみが表示されています。

omd config には数多くの設定があります。 最も重要なものは次のとおりです:

注：これらの変数は、インタラクティブモードでも同じ名前で確認できます。

テストや更新の準備のために、サイトのコピーを作成すると便利な場合があります。 もちろん、/omd/sites/mysite_old ディレクトリを/omd/sites/mysite_new にコピーするだけで済みます。 しかし、これは期待どおりに機能しません。その理由は次のとおりです。

サイトのコピーを簡略化するために、これらすべてを考慮したomd cp コマンドがあります。 このコマンドをroot として実行し、既存のサイトの名前と新しいサイトの名前を入力してください。 例：

コピーが機能するには、次の条件が満たされている必要があります：

この 2 つの条件により、コピー時にサイトが一致した状態であり、操作中に変更されないことが保証されます。

OMD は、もともと、omd createを使用してサイトの作成時に実際に作成され、サイトの ID ($OMD_SITE) を含むファイルのみをハンドルすることができました。 これらのファイルは、次のコマンドを使用して、サイトディレクトリ~/etc で確認できます。

以前は、OMD は、Checkmk サイトでの作業によって後で作成された設定ファイル（後で追加されたホストの設定など）については何もできませんでした。 純粋に技術的な観点からは、この動作は OMD の範囲に完全に一致しています。 しかし、ほとんどのユーザーは、omd cp によって、独自の監視設定を含め、引き続き生産的に使用できるまったく新しいサイトが作成されることを期待しています。

Checkmk バージョン2.1.0 以降、OMD は Checkmk 構成の最も重要なエレメントもカスタマイズできるようになりました。 なお、何も操作を行う必要はありません。以下で説明する移行はすべて自動的に行われます。

典型的な例： ホストのプロパティで、Monitored on site 属性を使用して、このホストを監視するサイトを、たとえばmysite_old のように手動で指定することができます。omd cp mysite_old mysite_new を実行すると、値はmysite_new にそれに応じて変更されます。 (以前は、この手順を実行すると、Unknown site (mysite_old) というエントリが作成されていました)。

この移行の実際の技術的な実装は、次のとおりです。 OMD はサイト ID の変更を検出し、post-rename-site -v -o mysite_new コマンドを実行します。 その後、個々の移行ステップは、いわゆるリネームアクションプラグインによって完全に自動的に処理されます。 このプラグインは、Git リポジトリの cmk/post_rename_site/plugins/actions にあります。

移行には、自動的に移行できない項目に関する通知も含まれます。

具体的な例を挙げます。 分散監視を使用しており、セントラルサイトとリモートサイトの両方の名前を変更します。

セントラルサイト： sites.py プラグインは、これがセントラルサイトであることを検出し、Setup > General > Distributed Monitoring のローカルサイトの接続設定にあるURL prefix 値などを更新します。

リモートサイト： warn_remote_site.py プラグインは、これがリモートサイトであることを認識し、それに応じて、セントラルサイトをチェックし、必要に応じて手動でカスタマイズする必要があることを示します。 これは、セントラルサイトの分散監視設定で、リモートサイトの新しい名前を、名前を変更したリモートサイトへの接続設定に入力する必要があることを意味します。もちろん、OMD はリモートコンピュータからこの操作を行うことはできません。

OMD 自体が、ターミナルに手順全体の詳細を表示します。 ここでは、セントラルサイトの名前を変更したときの、omd cp 出力からの移行メッセージの例を、成功メッセージと警告メッセージに分けて表示しています。 処理されたrename action plugins には、個別に番号が付けられています。 まず、自動的に実行された移行タスクの出力（ここでは短縮）が表示されます。

出力の2番目の部分には、手動で設定する必要がある可能性のある設定に関するヒントが含まれています（ここでは大幅に省略されています）：

Warn about configurations to review…​ 項目には、ビューのハードコードされたフィルタなど、移行中に通常手動で確認する必要がある個々の側面に関する一般的な注意事項が含まれています。

現在アクティブな 6 つのプラグインの概要は次のとおりです。順は上記の出力の番号に対応しています。

サイトを使用して多数のホストを監視している場合、コピーするデータ量は非常に多くなる可能性があります。 その大部分は、ラウンドロビンデータベース（RRD）に保存されている測定値によって生成されます。 しかし、履歴イベントを含むログファイルも、データ量を増加させる要因となります。

ヒストリーが必要ない場合 (たとえば、何かをすばやくテストしたい場合など)、コピーから省略することができます。 このような場合、omd cp に以下のオプションを追加することができます。

オプションの順序は重要です：

サイトの名前変更は、omd mv コマンドで実行します。 これは、サイトのコピーと同様に行われ、同じ前提条件があり、設定の移行も含まれます。 データは別のディレクトリに移動されるだけで複製はされないため、データ量を制限するオプションは使用できません。

例:

omd mv を使用してサイト名を変更すると、サイト名は変更されますが、サイトIDを含む一部のサイト属性は変更されません。 したがって、このコマンドは、分散監視において、バックアップによって複製されたサイトと、その元のバージョンを同時に運用するには適していません。omd mv を実行した後、関連するサイトの名前が変更された場合でも同様です。

サイトの作成と同様に、コピーおよび名前変更を行うと、新しい Linux ユーザーが作成されます。 したがって、omd cp およびomd mv には、omd create と同じオプションの一部 (ユーザー ID およびグループ ID を指定するオプションなど) があります。 詳細については、omd cp --help およびomd mv --help コマンドを使用してください。

Checkmk のサイト管理には、Checkmk サイトをバックアップおよび復元するためのビルトインメカニズムがあります。omd backup およびomd restore コマンドは、サイトのすべてのデータを tar アーカイブに圧縮し、復元のためにそのデータを抽出するための基本コマンドです。

注：Checkmk では、コマンドラインを使用せずに、Setup > Maintenance > Backups の GUI からバックアップおよび復元を実行することもできます。 ここでは、暗号化されたバックアップやスケジュールされたバックアップジョブも作成できます。 その方法については、「バックアップ」の記事をご覧ください。

omd backup を使用してサイトをバックアップするには、root の許可は必要ありません。 サイトユーザーでも実行できます。 作成するバックアップファイルの名前を引数として入力するだけです。

注意：

バックアップのターゲットディレクトリがサイトユーザーに対して書き込み可能でない場合は、root としてバックアップを行うこともできます。 この場合、いつものように、バックアップするサイト名を指定する追加の引数が必要です。

バックアップには、~/tmp/ にある揮発性データを除く、サイトのすべてのデータが含まれます。tar tzf コマンドを使用すると、ファイルの内容を簡単に確認できます。

サイトバックアップ中に移動されるデータの大部分は、測定値と履歴イベントを含むログファイルです。 これは、サイトのコピー時と同様に、バックアップ時にも当てはまります。 これらのデータが絶対に必要でない場合は、省略することでバックアップの速度を大幅に高速化し、出力ファイルのサイズを大幅に縮小することができます。

omd backup には、コピー時にomd cp と同じ、このデータを省略するオプションがあります。 次の例では、測定データとログファイルに保存されている履歴を省略してバックアップを作成しています。

実行中のサイトからバックアップを作成することもできます。 測定データの記録に使用されるラウンドロビンデータベース（RRD）の状態の一貫性を確保するため、omd backup コマンドは、ラウンドロビンキャッシュを、実行中の更新はジャーナルにのみ書き込まれ、RRD には書き込まれないモードに自動的に変更します。 ジャーナルファイルは最後にバックアップされます。これにより、バックアップ中に生成された測定データが、バックアップにできるだけ多く含まれるようになります。

バックアップの復元は、バックアップの作成と同じくらい簡単です。omd restore コマンドは、バックアップからサイトを復元します。 したがって、復元を機能させるには、同じバージョンがサーバーにインストールされている必要があります。

サイトは完全に空になり、再構築されます。omd restore を実行する前に、サイトを停止し、その後再起動する必要があります。

復元は、root ユーザーによっても実行できます。 サイトユーザーによって呼び出された場合とは異なり、サイトはバックアップから再作成されます。

したがって、同じ名前のサイトが残っている場合は、復元する前にそのサイトを削除する必要があります。 これは、omd rm を使用するか、omd restore に--reuse オプションを指定して実行できます。--kill を指定すると、復元を実行する前に、既存のサイトが確実に停止されます。 サイト名はバックアップに含まれているため、コマンドで指定する必要はありません。

root と指定すると、バックアップとは異なる名前でサイトを復元することもできます。 これを行うには、restore の後に、希望する名前を引数として指定します。

ここで実行される一連の変換は、前述のサイトのコピーおよび名前の変更と同じ機能を持っています。 サイト名は多数の構成ファイルに含まれているため、この手順を実行すると、そのようなサイト名はすべて自動的に新しい名前に置き換えられます。

omd backup およびomd restore コマンドは、昔ながらの Unix の伝統に従って、ファイルではなく標準入力/出力でも動作します。 tar ファイルのパスの代わりに、ハイフン (-）を入力します。

こうすることで、パイプを構築し、中間ファイルを使用せずにデータを別のコンピュータに直接「ストリーミング」することができます。 バックアップのサイズが大きいほど、バックアップ先のサーバーのファイルシステムに一時的なスペースを必要としないため、この方法の利点が高まります。

次のコマンドは、SSH を使用してサイトを別のコンピュータにバックアップします。

SSH アクセスを逆にして、バックアップサーバーから Checkmk サイトに接続したい場合は、次の例のようにすることもできます。 そのためには、まずサイトユーザーとして SSH ログインを許可する必要があります。

上記の操作と、標準入力からデータを読み込むomd restore を巧みに組み合わせると、1 つのサーバーから別のサーバーに、実行中のサイト全体をコピーすることができます。 バックアップファイル用の追加のスペースは必要ありません。

次に、SSHアクセスを逆にして、ソースシステムからターゲットシステムへ同じ操作を行います：