サポート
MicroShift のサポートツールの使用
概要
第1章 etcd サービス
etcd サービスは、Red Hat build of MicroShift の RPM の一部として提供されます。etcd サービスは別のプロセスとして実行され、etcd ライフサイクルは MicroShift によって自動的に管理されます。
1.1. MicroShift etcd サーバーを観察してデバッグする
journalctl
ログを収集して、etcd サーバーログを観察およびデバッグできます。
前提条件
- MicroShift サービスが実行されている。
手順
etcd のログを取得するには、次のコマンドを実行します。
$ sudo journalctl -u microshift-etcd.scope
注記MicroShift ログは、
journalctl -u microshift
コマンドを使用して etcd ログとは別にアクセスできます。
1.2. etcd のバージョンの確認
必要な情報のレベルに応じて、次のいずれかまたは両方の方法を使用して、MicroShift に含まれている etcd データベースのバージョン情報を取得できます。
手順
ベースデータベースのバージョン情報を表示するには、次のコマンドを実行します。
$ microshift-etcd version
出力例
microshift-etcd Version: 4.16.0 Base etcd Version: 3.5.13
データベースの完全なバージョン情報を表示するには、次のコマンドを実行します。
$ microshift-etcd version -o json
出力例
{ "major": "4", "minor": "16", "gitVersion": "4.16.0~rc.1", "gitCommit": "140777711962eb4e0b765c39dfd325fb0abb3622", "gitTreeState": "clean", "buildDate": "2024-05-10T16:37:53Z", "goVersion": "go1.21.9" "compiler": "gc", "platform": "linux/amd64", "patch": "", "etcdVersion": "3.5.13" }
1.3. etcd のトラブルシューティング
etcd のトラブルシューティングを行い、パフォーマンスを向上させるには、サービスのメモリー許容量を設定します。
1.4. etcd サーバーのパラメーターを設定するための memoryLimitMB 値の設定
デフォルトでは、etcd はシステムの負荷を処理するために必要な量のメモリーを使用します。メモリーに制約のあるシステムでは、etcd が使用するメモリーの量を制限する必要がある場合があります。
手順
/etc/microshift/config.yaml
ファイルを編集して、memoryLimitMB
値を設定します。etcd: memoryLimitMB: 128
注記MicroShift の
memoryLimitMB
に必要な最小値は 128 MB です。最小値に近い値は、etcd のパフォーマンスに影響を与える可能性が高くなります。制限が低いほど、etcd がクエリーに応答するまでにかかる時間が長くなります。制限が低すぎる場合、または etcd の使用量が多い場合、クエリーはタイムアウトになります。
検証
/etc/microshift/config.yaml
のmemoryLimitMB
値を変更した後、次のコマンドを実行して MicroShift を再起動します。$ sudo systemctl restart microshift
次のコマンドを実行して、新しい
memoryLimitMB
値が使用されていることを確認します。$ systemctl show --property=MemoryHigh microshift-etcd.scope
第2章 sos レポートの使用
sos
ツールを使用して、ホストに関するトラブルシューティング情報を収集できます。sos report
コマンドは、システム内のさまざまなコンポーネントやアプリケーションから有効なプラグインとデータをすべて表示する詳細なレポートを生成します。
2.1. sos レポートについて
sos
ツールは、さまざまなアプリケーションから情報を収集するのに役立つさまざまなプラグインで構成されています。MicroShift 固有のプラグインが sos バージョン 4.5.1 から追加されました。このプラグインは次のデータを収集できます。
- MicroShift の設定およびバージョン
- クラスター全体およびシステム namespace リソースの YAML 出力
- OVN-Kubernetes 情報
2.2. sos レポートからのデータの収集
前提条件
-
sos
パッケージがインストールされている。
手順
- 障害が発生したホストに root ユーザーとしてログインします。
次のコマンドを実行して、デバッグレポートの作成手順を実行します。
$ microshift-sos-report
出力例
sosreport (version 4.5.1) This command will collect diagnostic and configuration information from this Red Hat Enterprise Linux system and installed applications. An archive containing the collected information will be generated in /var/tmp/sos.o0sznf_8 and may be provided to a Red Hat support representative. Any information provided to Red Hat will be treated in accordance with the published support policies at: Distribution Website : https://www.redhat.com/ Commercial Support : https://www.access.redhat.com/ The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party. No changes will be made to system configuration. Setting up archive ... Setting up plugins ... Running plugins. Please wait ... Starting 1/2 microshift [Running: microshift] Starting 2/2 microshift_ovn [Running: microshift microshift_ovn] Finishing plugins [Running: microshift] Finished running plugins Found 1 total reports to obfuscate, processing up to 4 concurrently sosreport-microshift-rhel9-2023-03-31-axjbyxw : Beginning obfuscation... sosreport-microshift-rhel9-2023-03-31-axjbyxw : Obfuscation completed Successfully obfuscated 1 report(s) Creating compressed archive... A mapping of obfuscated elements is available at /var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-private_map Your sosreport has been generated and saved in: /var/tmp/sosreport-microshift-rhel9-2023-03-31-axjbyxw-obfuscated.tar.xz Size 444.14KiB Owner root sha256 922e5ff2db25014585b7c6c749d2c44c8492756d619df5e9838ce863f83d4269 Please send this file to your support representative.
2.3. 関連情報
第3章 クラスター ID の取得
Red Hat サポートに情報を提供する際には、クラスターに固有の識別子を提供していただくと役に立ちます。MicroShift の場合は、OpenShift CLI (oc
) を使用するか、ファイルから ID を取得して、クラスター ID を手動で取得できます。
クラスター ID は、インストール後に MicroShift サービスが初めて実行された後にのみ作成されます。
3.1. 実行中のクラスターのクラスター ID 取得
実行中のクラスターの ID を取得するには、以下のいずれかの手順を使用します。
手順
次のコマンドを入力して、
oc get
を使用して実行中のクラスターの ID を取得します。$ oc get namespaces kube-system -o jsonpath={.metadata.uid}
出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
次のコマンドを入力して、
cluster-id
ファイルからクラスター ID を取得して、稼働中のクラスターの ID を取得します。$ sudo cat /var/lib/microshift/cluster-id
出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
3.2. 停止したクラスターのクラスター ID 取得
以前は実行されていたが現在は実行されていないクラスターの場合は、/var/lib/microshift
ディレクトリーの cluster-id
ファイルからクラスター ID を取得できます。
手順
次のコマンドを入力して、停止したクラスターの ID を
cluster-id
ファイルから取得します。$ sudo cat /var/lib/microshift/cluster-id
出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
第4章 サポート
Red Hat build of MicroShift や Red Hat Enterprise Linux for Edge (RHEL for Edge) など、Red Hat Device Edge に関する詳細な内容については、以下の情報を参照してください。
4.1. サポート
このドキュメントで説明されている手順、または Red Hat build of MicroShift 全般に問題がある場合は、Red Hat カスタマーポータル にアクセスしてください。
カスタマーポータルでは、以下を行うことができます。
- Red Hat 製品に関するアーティクルおよびソリューションを対象とした Red Hat ナレッジベースの検索またはブラウズ。
- Red Hat サポートに対するサポートケースの送信。
- その他の製品ドキュメントへのアクセス。
4.2. ドキュメントに関するフィードバックの提供
エラーを報告したり、ドキュメントを改善したりするには、Red Hat Jira アカウント にログインし、Jira issue を送信してください。
4.3. Red Hat ナレッジベースについて
Red Hat ナレッジベース は、お客様が Red Hat の製品やテクノロジーを最大限に活用できるようにするための豊富なコンテンツを提供します。Red Hat ナレッジベースは、Red Hat 製品のインストール、設定、および使用に関する記事、製品ドキュメント、および動画で構成されています。さらに、既知の問題に対する解決策を検索でき、それぞれに根本原因の簡潔な説明と修復手順が記載されています。
4.4. Red Hat ナレッジベースの検索
Red Hat build of MicroShift の問題が発生した場合には、初期検索を実行して、Red Hat ナレッジベースにソリューションがすでに存在しているかどうかを確認できます。
前提条件
- Red Hat カスタマーポータルのアカウントがある。
手順
- Red Hat カスタマーポータル にログインします。
- Search をクリックします。
検索フィールドに、問題に関連する次のようなキーワードと文字列を入力します。
- Red Hat build of MicroShift のコンポーネント (etcd など)
- 関連する手順 (installation など)
- 明示的な失敗に関連する警告、エラーメッセージ、およびその他の出力
- Enter キーをクリックします。
- オプション: 製品フィルターの Red Hat build of MicroShift を選択します。
- オプション: Documentation コンテンツタイプフィルターを選択します。
4.5. サポートケースの送信
前提条件
- MicroShift サービスが実行されている。
-
OpenShift CLI (
oc
) がインストールされている。 - Red Hat カスタマーポータルのアカウントがある。
- Red Hat の標準またはプレミアムサブスクリプションがある。
手順
- Red Hat カスタマーポータルの Customer Support ページ にログインします。
- Get support をクリックします。
Customer Support ページの Cases タブで、以下を行います。
- オプション: 必要に応じて、事前に入力されたアカウントと所有者の詳細を変更します。
- 問題に該当するカテゴリー (Bug、Defect など) を選択し、Continue をクリックします。
以下の情報を入力します。
- Summary フィールドには、問題の簡潔で説明的な概要と、確認されている現象および予想される動作の詳細情報を入力します。
- Product ドロップダウンメニューから Red Hat Device Edge を選択します。
- Version ドロップダウンから 4 を選択します。
- Red Hat ナレッジベースで推奨されるソリューション一覧を確認してください。この一覧に上げられているソリューションは、報告しようとしている問題に適用される可能性があります。提案されている記事が問題に対応していない場合は、Continue をクリックします。
- 報告している問題に対する一致に基づいて推奨される Red Hat ナレッジベースソリューションの一覧が更新されることを確認してください。ケース作成プロセスでより多くの情報を提供すると、このリストの絞り込みが行われます。提案されている記事が問題に対応していない場合は、Continue をクリックします。
- アカウント情報が予想通りに表示されていることを確認し、そうでない場合は適宜修正します。
プロンプトが表示されたら、次の質問に回答します。使用しているインストールタイプ (RPM または埋め込みイメージ) も記載してください。Continue をクリックします。
- What are you experiencing? What are you expecting to happen?
- Define the value or impact to you or the business.
- Where are you experiencing this behavior? What environment?
- When does this behavior occur? Frequency? 繰り返し発生するか。At certain times?
-
関連する診断データファイルをアップロードし、Continue をクリックします。
sos
ツールや etcd を使用して解決の手がかりとして収集したデータに加えて、それらのログに収集されなかった問題固有のデータも含めてください。 - 関連するケース管理の詳細情報を追加し、Continue をクリックします。
- ケースの詳細を確認し、Submit をクリックします。