サポート
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
$ sudo journalctl -u microshift-etcd.scopeCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注記MicroShift ログは、
journalctl -u microshiftコマンドを使用して etcd ログとは別にアクセスできます。
1.2. etcd のバージョンの確認 リンクのコピーリンクがクリップボードにコピーされました!
必要な情報のレベルに応じて、次のいずれかまたは両方の方法を使用して、MicroShift に含まれている etcd データベースのバージョン情報を取得できます。
手順
ベースデータベースのバージョン情報を表示するには、次のコマンドを実行します。
microshift-etcd version
$ microshift-etcd versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
microshift-etcd Version: 4.17.1 Base etcd Version: 3.5.13
microshift-etcd Version: 4.17.1 Base etcd Version: 3.5.13Copy to Clipboard Copied! Toggle word wrap Toggle overflow データベースの完全なバージョン情報を表示するには、次のコマンドを実行します。
microshift-etcd version -o json
$ microshift-etcd version -o jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3. etcd のトラブルシューティング リンクのコピーリンクがクリップボードにコピーされました!
etcd のトラブルシューティングを行い、パフォーマンスを向上させるには、サービスのメモリー許容量を設定します。
1.4. etcd サーバーのパラメーターを設定するための memoryLimitMB 値の設定 リンクのコピーリンクがクリップボードにコピーされました!
デフォルトでは、etcd はシステムの負荷を処理するために必要な量のメモリーを使用します。メモリーに制約のあるシステムでは、etcd が使用するメモリーの量を制限する必要がある場合があります。
手順
/etc/microshift/config.yamlファイルを編集して、memoryLimitMB値を設定します。etcd: memoryLimitMB: 128
etcd: memoryLimitMB: 128Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記MicroShift の
memoryLimitMBに必要な最小値は 128 MB です。最小値に近い値は、etcd のパフォーマンスに影響を与える可能性が高くなります。制限が低いほど、etcd がクエリーに応答するまでにかかる時間が長くなります。制限が低すぎる場合、または etcd の使用量が多い場合、クエリーはタイムアウトになります。
検証
/etc/microshift/config.yamlのmemoryLimitMB値を変更した後、次のコマンドを実行して MicroShift を再起動します。sudo systemctl restart microshift
$ sudo systemctl restart microshiftCopy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを実行して、新しい
memoryLimitMB値が使用されていることを確認します。systemctl show --property=MemoryHigh microshift-etcd.scope
$ systemctl show --property=MemoryHigh microshift-etcd.scopeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
第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
$ microshift-sos-reportCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
第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}$ oc get namespaces kube-system -o jsonpath={.metadata.uid}Copy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
7cf13853-68f4-454e-8f5c-1af748cbfb1aCopy to Clipboard Copied! Toggle word wrap Toggle overflow 次のコマンドを入力して、
cluster-idファイルからクラスター ID を取得して、稼働中のクラスターの ID を取得します。sudo cat /var/lib/microshift/cluster-id
$ sudo cat /var/lib/microshift/cluster-idCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
7cf13853-68f4-454e-8f5c-1af748cbfb1aCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.2. 停止したクラスターのクラスター ID 取得 リンクのコピーリンクがクリップボードにコピーされました!
以前は実行されていたが現在は実行されていないクラスターの場合は、/var/lib/microshift ディレクトリーの cluster-id ファイルからクラスター ID を取得できます。
手順
次のコマンドを入力して、停止したクラスターの ID を
cluster-idファイルから取得します。sudo cat /var/lib/microshift/cluster-id
$ sudo cat /var/lib/microshift/cluster-idCopy to Clipboard Copied! Toggle word wrap Toggle overflow 出力例
7cf13853-68f4-454e-8f5c-1af748cbfb1a
7cf13853-68f4-454e-8f5c-1af748cbfb1aCopy to Clipboard Copied! Toggle word wrap Toggle overflow
第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 の Standard または Premium サブスクリプションがある。
手順
- 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 をクリックします。
第5章 接続されたクラスターによるリモートヘルスモニタリング リンクのコピーリンクがクリップボードにコピーされました!
クラスターに関する Telemetry および設定データを収集し、Red Hat に報告できます。
5.1. MicroShift によるリモートヘルスモニタリングについて リンクのコピーリンクがクリップボードにコピーされました!
MicroShift では、Telemeter API を使用して Red Hat に報告されるクラスターに関するテレメトリーと設定データを収集することで、リモートヘルスモニタリングが実行されます。Red Hat に Telemetry を報告するクラスターは、接続されたクラスター とみなされます。
Telemetry とは、MicroShift Telemeter API によって Red Hat に送信される情報を説明するために Red Hat が使用する用語です。軽量属性は、接続されたクラスターから Red Hat に送信され、クラスターの健全性を監視します。
Telemetry の利点
Telemetry には次のような利点があります。
- 問題の特定および解決の強化。エンドユーザーにとっては正常と思われるイベントも、Red Hat ではより広い視点から観察できます。この視点により、一部の問題はより迅速に特定され、エンドユーザーがサポートケースを作成したり、Jira 問題 を作成しなくても解決することが可能です。
- 新機能の明確な優先順位付け。収集されたデータは、システムの機能と使用特性に関する情報を提供します。この情報により、Red Hat はお客様に最も大きな影響を与える新機能の開発に重点的に取り組むことができます。
Telemetry は厳選されたクラスターモニタリングメトリクスのサブセットを Red Hat に送信します。Telemeter API は、1 時間ごとにメトリクス値を取得し、そのデータを Red Hat にアップロードします。このデータストリームは、Red Hat によって長期にわたってクラスターを監視するために使用されます。
Red Hat Support および Engineering チームは、サポートケースでレポートされるデータにアクセスする場合と同じ制限が適用された状態で、このデバッグ情報を使用できます。すべての 接続されたクラスター 情報は、MicroShift を改善するために Red Hat によって使用されます。
MicroShift は Prometheus をサポートしていません。クラスターから収集された Telemetry を表示するには、Red Hat Support チームに連絡する必要があります。
5.2. MicroShift Telemetry API によって収集される情報 リンクのコピーリンクがクリップボードにコピーされました!
すべてのメトリクスを合計すると通常は 2 KB 未満となり、クラスターリソースを消費することは予想されません。
以下の情報は、Telemetry によって収集されます。
5.2.1. システム情報 リンクのコピーリンクがクリップボードにコピーされました!
システム情報には、MicroShift クラスターの基本設定とそれが実行されている場所が記述されます。次に例を示します。
- MicroShift クラスターのバージョンを含むバージョン情報。
- Red Hat Enterprise Linux (RHEL) バージョン。
- RHEL のデプロイメントタイプ。
5.2.2. サイジング情報 リンクのコピーリンクがクリップボードにコピーされました!
サイジング情報には、クラスターの容量の詳細が示されます。次に例を示します。
- MicroShift が使用できる CPU コア。
- アーキテクチャー情報。
- 使用可能なメモリーのバイト数。
5.2.3. 使用情報 リンクのコピーリンクがクリップボードにコピーされました!
使用状況情報には、クラスター内で何が起こっているかの概要が示されます。たとえば、次のようになります。
- CPU 使用率 (パーセンテージ)。
- メモリー使用率 (パーセンテージ)。
- リソースタイプ (CRD) ごとの Kubernetes オブジェクトの数。
- 実行中のコンテナー、namespace、および実行中の Pod の数。
- ルート、Ingress、サービスの数。
Telemetry は、ユーザー名やパスワードなどの識別情報を収集しません。Red Hat は、意図的な個人情報の収集は行いません。Red Hat は、個人情報が誤って受け取られたことを発見した場合、そのような情報を削除します。Telemetry データが個人データに該当する場合は、Red Hat プライバシーステートメント で Red Hat のプライバシー方針を確認してください。
5.2.4. リモートヘルスモニタリングデータの使用方法に関する追加情報 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat は、サポートとトラブルシューティングの提供、サービスとユーザーエクスペリエンスの向上、問題への対応、該当する場合は請求などの目的で、Red Hat 製品の使用に関するデータを収集します。
収集における対策
Red Hat は、Telemetry データを保護するために設計された技術的および組織的な対策を採用しています。
共有
Red Hat は、ユーザーエクスペリエンスを向上させるために、Telemetry API を通じて収集したデータを Red Hat 内で共有する場合があります。Red Hat は、以下の目的で Red Hat のビジネスパートナーと、お客様を特定しない集約された形式で Telemetry およびデータを共有する場合があります。つまり、パートナーが市場およびお客様の Red Hat のオファリングの使用をより良く理解できるように支援することを目的とするか、それらのパートナーと共同でサポートしている製品の統合を効果的に行うことを目的としています。
サードパーティー
Red Hat は、Telemetry データの収集、分析、および保存を支援するために、特定のサードパーティーと連携する場合があります。
ユーザーコントロール: Telemetry データ収集の無効化
「MicroShift のリモートヘルスレポートのオプトアウト」セクションの手順に従って、MicroShift Telemetry を無効化できます。
5.3. MicroShift の Telemetry のオプトアウト リンクのコピーリンクがクリップボードにコピーされました!
クラスターがネットワークに接続されていない場合、または Telemetry を収集したくない場合は、MicroShift 設定ファイルでパラメーターを無効にすることで、簡単に Telemetry をオプトアウトできます。
前提条件
-
OpenShift CLI (
oc) がインストールされている。 - クラスターへの root アクセス権限がある。
手順
-
/etc/microshift/ディレクトリーにある指定されたconfig.yaml.defaultファイルのコピーを作成し (まだ作成していない場合)、config.yamlという名前を付けます。 新しい MicroShift の
config.yamlを/etc/microshift/ディレクトリーに保持します。config.yamlファイルは、MicroShift サービスが起動するたびに読み取られます。注記これを作成すると、
config.yamlファイルは組み込み設定よりも優先されます。- オプション: 既存の MicroShift YAML を使用している場合は、設定スニペットを使用します。詳細は、関連情報 セクションの「設定スニペット」の使用を参照してください。
MicroShift YAML の
telemetry.statusセクションをDisabled値に設定します。無効にした Telemetry 設定の例
Copy to Clipboard Copied! Toggle word wrap Toggle overflow