Cloud Exchangeのアップグレード/移行チェックスクリプト

アップグレード/移行チェックは、インストール、アップグレード、または移行を行う前に、ホストがターゲットCloud Exchangeバージョンの前提条件を満たしているかを確認します。このチェックは読み取り専用です。ホスト上には何も変更されません。

チェックは、ce_healthcheckスクリプトを使用してコマンドラインから実行します。各前提条件の結果を表示し、最後に全体的な判定を表示します。

Cloud Exchange v7.0.0以降はUIからチェックを実行することもできます。詳細については、全般設定を参照してください。7.0.0より前のバージョンの場合はコマンドラインを使うか、またはCloud Exchangeがまだインストールされていないホストで使ってください。

前提条件

ホストへのルートアクセス。チェックは sudo で実行する必要があります。
ホスト上の Python 3.6 以降。
スクリプトとチェック定義をダウンロードするために、ホストからraw.githubusercontent.com/netskopeoss/ta_cloud_exchangeへのアウトバウンドHTTPSアクセスが必要です。

アップグレード/移行チェックスクリプトをダウンロードする

スクリプトとチェック定義をCloud Exchangeインストールディレクトリにダウンロードします。

Cloud Exchangeのインストールディレクトリにアクセスしてください:
- Containerized Deployment: docker-compose.yml ファイルがある ta_cloud_exchange ディレクトリ。
- Cloud Exchange as a VM: /opt/cloudexchange/cloudexchangeディレクトリ。
次のコマンドを実行してスクリプトとチェック定義をダウンロードし、スクリプトを実行可能にしてください。
```
curl -fsSL -O https://raw.githubusercontent.com/netskopeoss/ta_cloud_exchange/main/ce_healthcheck
chmod +x ce_healthcheck
```

インストールディレクトリからアップグレード/移行チェックを実行してください。このチェックは、そのディレクトリ内のファイルからデプロイメントタイプとインストールされているバージョンを検出します。

アップグレード/移行チェックを実行する

このチェックでは、ホストから実行コンテキスト、デプロイの種類、インストール済みバージョンを検出し、チェックの実行前にそれらを表示します。入力を求められる項目はありません。検出された値は、「オプション」に記載されているオプションで上書きできます。

スタンドアロン展開

インストールディレクトリで、次のコマンドを実行します。
```
sudo python3 ./ce_healthcheck
```
画面上で各チェックの結果を確認します。このチェックでは、詳細レポートが現在のフォルダに ce_healthcheck_report.json として保存されます。
出力の最後にある要約と全体的な結論をお読みください。詳細は、「結果の理解」を参照してください。

バージョンを指定しない場合、チェックは、チェック定義がカバーする最新の Cloud Exchange バージョンに対してホストを検証します。特定のバージョンに対して検証するには、--target-version オプションを追加します。例えば、

sudo python3 ./ce_healthcheck --target-version 7.0.0

HA展開

クラスター内のすべてのノードでチェックを実行します。各ノードは、そのノードがHAポート経由で他のノードに到達できるかどうかを含め、自身の結果をレポートします。

最初のノードでインストールディレクトリに移動し、ノードの状態に一致するコマンドを実行します。
- Existing HA cluster: sudo python3 ./ce_healthcheckを実行します。このチェックは HA デプロイメントを検出します。
- Nodes you have not set up yet: sudo python3 ./ce_healthcheck --deployment HA を実行します。HA設定がないノードはHAとして検出できないため、展開タイプを自分で設定します。
画面上の結果を確認し、失敗した項目を修正してください。
クラスター内の他のすべてのノードで、これらの手順を繰り返します。

まだHA構成がないノードでは、このチェックは他のノードへの接続をテストできないため、HAピアノード接続チェックは「該当なし」と表示されます。クラスターをセットアップしたあと、すべてのノードで再度チェックを実行してください。

オプション

チェックでは、次のオプションを受け付けます。

Option	デスクリプション
`--deployment SA\|HA`	デプロイメントタイプを検出する代わりに設定します。
`--target-version <version>`	検証対象のCloud Exchangeバージョンを設定します。
`--mode install\|upgrade\|migrate`	検出するのではなく、実行コンテキストを設定します。マイグレーションコンテキストはインストールと同じチェックを実行します。
`--list-versions`	選択可能な Cloud Exchange バージョンを一覧表示します。
`--html <path>`	共有可能なHTMLレポートを保存する。
`--report <path>`	詳細なJSONレポートを特定の場所に保存します。
`--manifest-path <path>`	チェック定義をダウンロードするのではなく、ローカルファイルを使用します。
`--json`	結果の代わりにJSON形式で画面に完全なレポートを印刷します。
`--quiet`	検出された値のメモを抑制します。

サンプルコマンド

これらのコマンドは、Cloud Exchangeのインストールディレクトリで実行してください。検証対象とするCloud Exchangeのバージョンに7.0.0を置き換えてください。

使うケース	Command
スタンドアロン展開として Cloud Exchange をインストールする前に、ホストを確認します。	`sudo python3 ./ce_healthcheck --mode install --deployment SA --target-version 7.0.0`
HA クラスタのノードとしてインストールする前にホストを確認します。	`sudo python3 ./ce_healthcheck --mode install --deployment HA --target-version 7.0.0`
アップグレードの前に、既存のデプロイメントを確認してください。	`sudo python3 ./ce_healthcheck --mode upgrade --target-version 7.0.0`
新しいマシンに移行する前に、そのマシンを確認してください。	`sudo python3 ./ce_healthcheck --mode migrate --target-version 7.0.0`
インストールされているバージョンに対して既存のホストを確認します。	`sudo python3 ./ce_healthcheck --target-version <installed_version>`
チェックの対象となるCloud Exchangeのバージョンを確認してください。	`./ce_healthcheck --list-versions`
共有可能なHTMLレポートとJSONレポートを任意の場所に保存します。	`sudo python3 ./ce_healthcheck --html ./ce_healthcheck_report.html --report ./ce_healthcheck_report.json`
スクリプトからチェックを実行し、JSON 形式の完全なレポートを読み取ります。	`sudo python3 ./ce_healthcheck --json --quiet`
プロキシ経由でインターネットに接続するホストでチェックを実行します。	`sudo HTTPS_PROXY=http://<proxy_host>:<proxy_port> python3 ./ce_healthcheck`

アップグレード/移行チェックを実行する時期

展開のインストール、アップグレード、またはマイグレーションの前、および報告された項目に対処した後に再度確認します。
ホストの変更後（マシンのサイズ変更、ディスクの追加、ファイアウォールやプロキシのルールの変更など）。
インストールやアップグレードが失敗してNetskopeサポートへサポートケースをオープンする前に、Netskopeサポートがホストの状態を確認できるようにします。

結果を理解する

すべてのチェックで、5つの結果のいずれかがレポートされます。

Result	Meaning	行うべきこと
Pass	ホストはこの要件を満たしています。	何もする必要はありません。
警告	要件は満たされていますが、注意が必要です。たとえば、値が必須最小値を下回っているのではなく、推奨レベルを下回っている場合や、必要なポートがそのポートを所有することになっている Cloud Exchange サービスによって既に使われている場合などが該当します。	項目とそれに示されている修正措置を確認します。警告ではアップグレードはブロックされません。
Failed	ホストが必須要件を満たしていません。インストールまたはアップグレードが失敗するか、デプロイメントが不安定な状態になる可能性があります。	表示される修正措置を使って項目を修正してから、もう一度チェックを実行してください。
適用できない	このチェックは、スタンドアロン展開でのHAクラスターチェックや、Dockerを実行するホストでのPodmanチェックなど、このホストには適用されません。	何もする必要はありません。
未確認	このホストではチェックを完了できなかったため、要件を満たしているとも満たしていないとも確認できません。たとえば、バージョンを読み取れなかった場合や、コマンドを実行できなかった場合です。	項目に記載されている理由を確認してください。合格ではなく、未確認として扱ってください。

チェックの最後には各結果のカウントが表示され、その後に全体的な判定が表示されます。

Verdict	Meaning
このホストは、Cloud Exchange バージョンの前提条件を満たしています。	すべての該当するチェックに合格しました。続行できます。
このホストは Cloud Exchange version の必須前提条件を満たしています。続行する前に、上記の警告を確認してください。	必須項目で失敗したものはありませんが、対応が必要な項目があります。
Verified n of total checks for Cloud Exchange version; n could not be verified. No mandatory prerequisite failed. Review the items above before proceeding.	必須項目で失敗したものはありませんが、ホストの一部が評価されませんでした。続行する前に、未確認の項目を確認してください。
1つ以上の前提条件チェックに失敗しました。続行するには、最小システム要件が満たされていることを確認してください。	続行しないでください。失敗したすべての項目に対処し、チェックを再実行してください。
このホストでは、Cloud Exchange バージョンの前提条件チェックを一つも検証できませんでした。これは合格ではありません。	実際には何も評価されていません。チェックを実行するために必要な条件が整った後、もう一度チェックを実行してください。

チェックに失敗しなかった場合はコード0で終了し、少なくとも1つのチェックが失敗した場合はコード1で終了します。実行できなかった場合は、コード2で終了します。

HA展開のUIからチェックを実行すると、到達できなかったノードは個別に呼び出され、合計には含まれません。

レポート

JSON report: ホストから収集された測定値を含む、実行の詳細な記録。チェックは、実行されるたびに現在のフォルダーにce_healthcheck_report.jsonとして保存されます。別の場所に保存するには、--reportオプションを使用します。このレポートをサポートケースに添付してください。
HTML report: 任意のブラウザで開くことができる実行結果の読みやすい概要。すべてのチェック、結果、修正措置が一覧表示されます。チェックは --html オプションを使う場合のみ保存されます。このレポートを使って、結果をチームと共有します。

両方のレポートにはホストに関する詳細が含まれており、ルートユーザーのみがそれらを読むことができます。レポートを開くかコピーするには、sudo を使う。レポートは、他のシステムレコードと同様に慎重に保管・共有してください。

チェックを実行できない場合

メッセージ	行うべきこと
このチェックは、セットアップと同じようにルートとして実行する必要があります。	`sudo` を使用してチェックを再実行する。
url からアップグレード/移行チェック定義をダウンロードできませんでした。	ホストにアウトバウンドのインターネットアクセス権がないか、プロキシまたはファイアウォールによってブロックされています。`raw.githubusercontent.com/netskopeoss/ta_cloud_exchange` へのアクセスを許可してから、チェックを再度実行してください。
Cloud Exchangeのバージョンversionはこれらのチェック定義には存在しないため、このホストは検証されませんでした。	Select 対象となるバージョン。利用可能なバージョンを確認するには、`./ce_healthcheck --list-versions`を実行してください。
pathからアップグレード/移行チェック定義を読み込めませんでした。	`--manifest-path`に指定したパスが存在し、そのファイルを読み取れることを確認してください。