支持


Red Hat build of MicroShift 4.19

使用 MicroShift 的支持工具

Red Hat OpenShift Documentation Team

摘要

本文档提供有关如何将支持工具用于 MicroShift 的信息。

第 1 章 etcd 服务

etcd 服务作为 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.17.1
    Base etcd Version: 3.5.13

  • 要显示完整的数据库版本信息,请运行以下命令:

    $ microshift-etcd version -o json

    输出示例

    {
      "major": "4",
      "minor": "16",
      "gitVersion": "4.17.1~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 进行故障排除并提高性能,请配置服务的内存允许。

默认情况下,etcd 根据需要使用尽可能多的内存来处理系统上的负载。在内存有限制的系统中,您可能需要限制 etcd 使用的内存量。

流程

  • 编辑 /etc/microshift/config.yaml 文件,以设置 memoryLimitMB 值。

    etcd:
      memoryLimitMB: 128
    注意

    MicroShift 上 memoryLimitMB 所需的最小值为 128 MB。接近最小值的值可能会影响 etcd 性能。较小的限制,etcd 会对查询做出响应所需的时间。如果限制太小,或者 etcd 的使用量很高,查询会超时。

验证

  1. 修改 /etc/microshift/config.yaml 中的 memoryLimitMB 值后,运行以下命令重启 MicroShift:

    $ sudo systemctl restart microshift
  2. 运行以下命令验证新的 memoryLimitMB 值是否在使用中:

    $ systemctl show --property=MemoryHigh microshift-etcd.scope

第 2 章 使用 sos 报告

您可以使用 sos 工具收集有关主机的故障排除信息。sos report 命令生成一个详细报告,显示系统中不同组件和应用程序的所有启用插件和数据。

2.1. 关于 sos 报告

sos 工具由不同的插件组成,可帮助您从不同的应用程序收集信息。在 sos 版本 4.5.1 中添加了特定于 MicroShift 的插件,它可以收集以下数据:

  • MicroShift 配置和版本
  • 集群范围和系统命名空间资源的 YAML 输出
  • OVN-Kubernetes 信息

2.2. 从 sos 报告收集数据

先决条件

  • 已安装 sos 软件包。

流程

  1. 以 root 用户身份登录到失败的主机。
  2. 运行以下命令执行 debug 报告创建过程:

    $ 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.

第 3 章 获取集群 ID

在向红帽支持提供信息时,提供集群的唯一标识符会很有帮助。对于 MicroShift,您可以使用 OpenShift CLI (oc)手动获取集群 ID,或者从文件检索 ID。

注意

只有在 MicroShift 服务在安装后第一次运行后,才会创建集群 ID。

3.1. 获取正在运行的集群的集群 ID

使用以下步骤获取正在运行的集群的 ID。

流程

  • 输入以下命令,使用 oc get 获取正在运行的集群的 ID:

    $ oc get namespaces kube-system -o jsonpath={.metadata.uid}

    输出示例

    7cf13853-68f4-454e-8f5c-1af748cbfb1a

  • 输入以下命令从 cluster-id 文件中检索正在运行的集群的 ID:

    $ sudo cat /var/lib/microshift/cluster-id

    输出示例

    7cf13853-68f4-454e-8f5c-1af748cbfb1a

3.2. 获取已停止集群的集群 ID

对于之前运行但现在没有运行的集群,您可以从 /var/lib/microshift 目录中的 cluster-id 文件获取集群 ID。

流程

  • 输入以下命令从 cluster-id 文件中检索已停止集群的 ID:

    $ sudo cat /var/lib/microshift/cluster-id

    输出示例

    7cf13853-68f4-454e-8f5c-1af748cbfb1a

第 4 章 获取支持

使用以下信息获取有关 Red Hat Device Edge 的更多帮助,包括红帽构建的 MicroShift 或 Red Hat Enterprise Linux for Edge (RHEL for Edge)。

4.1. 获取支持

如果您在执行本文档所述的某个流程或红帽构建的 MicroShift 时遇到问题,请访问红帽客户门户

通过红帽客户门户网站:

  • 搜索或者浏览红帽知识库,了解与红帽产品相关的文章和解决方案。
  • 提交问题单给红帽支持。
  • 访问其他产品文档。

4.3. 关于红帽知识库

红帽知识库提供丰富的内容以帮助您最大程度地利用红帽的产品和技术。红帽知识库包括文章、产品文档和视频,概述了安装、配置和使用红帽产品的最佳实践。另外,您还可以搜索已知问题的解决方案,其提供简洁的根原因描述和补救措施。

4.4. 搜索红帽知识库

如果红帽构建的 MicroShift 问题构建,您可以先进行搜索,以确定红帽知识库中是否已存在相关的解决方案。

先决条件

  • 您有红帽客户门户网站帐户。

流程

  1. 登录到 红帽客户门户网站
  2. Search
  3. 在搜索字段中,输入与问题相关的关键字和字符串,包括:

    • 红帽构建的 MicroShift 组件(如 etcd
    • 相关步骤(比如 安装
    • 警告、错误消息和其他与输出与特定的问题相关
  4. Enter 键。
  5. 可选:选择 MicroShift 产品过滤器的红帽构建
  6. 可选: 选择 Documentation 内容类型过滤器。

4.5. 提交支持问题单

先决条件

  • MicroShift 服务正在运行。
  • 已安装 OpenShift CLI(oc)。
  • 您有红帽客户门户网站帐户。
  • 您有红帽标准订阅或高级订阅。

流程

  1. 登录到红帽客户门户网站的客户支持 页面
  2. Get support
  3. 客户支持 页面的 Cases 选项卡中:

    1. 可选:根据需要更改预先填充的帐户和所有者详情。
    2. 为您的问题选择适当的类别,如 Bug 或 Defect,然后点 Continue
  4. 输入以下信息:

    1. Summary 字段中,输入简要但描述性问题概述,以及有关所经历的症状的详细信息,以及您的预期。
    2. Product 下拉菜单中选择 Red Hat Device Edge
    3. Version 下拉菜单中选择 4
  5. 查看推荐的红帽知识库解决方案列表,它们可能会与您要报告的问题相关。如果建议的文章没有解决这个问题,请点 Continue
  6. 查看更新的推荐红帽知识库解决方案列表,它们可能会与您要报告的问题相关。这个列表的范围会缩小,因为您在创建问题单的过程中提供了更多信息。如果建议的文章没有解决这个问题,请点 Continue
  7. 请确保提供的帐户信息是正确的,如果需要,请相应调整。
  8. 在出现提示时完成以下问题。包括您使用的安装类型,可以是 RPM 或 embedded-image。点 Continue:

    • 您遇到什么情况?您期望发生什么情况?
    • 对业务的影响价值。
    • 您在哪里遇到此行为?什么环境?
    • 此行为何时发生?发生频率?重复发生?是否只在特定时间发生?
  9. 上传相关的诊断数据文件并点击 Continue。包含使用 sos 工具或 etcd 收集的数据作为起点,以及没有在这些日志中收集的特定于问题的数据。
  10. 添加相关问题单管理详情,然后点 Continue
  11. 预览问题单详情,点 Submit

第 5 章 使用连接的集群的远程健康监控

可以收集并报告您的集群的 Telemetry 和配置数据。

5.1. 关于使用 MicroShift 的远程健康监控

远程健康监控通过与 Telemeter API 报告的集群相关的遥测和配置数据集合在 MicroShift 中进行。向红帽报告 Telemetry 的集群被视为 连接的集群

Telemetry 是红帽用来描述 MicroShift Telemeter API 向红帽发送的信息的术语。轻量级属性从连接的集群发送到红帽,以监控集群的健康状态。

Telemetry 的优点

Telemetry 提供以下优点:

  • 增强了识别和解决问题的能力。从更广泛的角度来看,红帽可能会观察到最终用户看似正常的事件。因此,一些问题可以被更快地识别并解决,而不需要用户创建一个支持问题单或 Jira issue
  • 有针对性地对新功能的开发进行优先级排序。收集的数据提供有关系统功能和使用特征的信息。通过这些信息,红帽可以专注于开发对客户有严重影响的新功能。

Telemetry 会向红帽发送一个精心选择的的集群监控指标子集。Telemeter API 每小时获取指标值,并将数据上传到红帽。红帽使用此数据流来监控集群。

红帽支持和工程团队提供了此调试信息,其访问限制与访问通过支持问题单报告的数据相同。红帽利用所有连接 集群信息来帮助改进 MicroShift。

注意

MicroShift 不支持 Prometheus。要查看集群收集的 Telemetry,您必须联系红帽支持。

5.2. MicroShift Telemetry API 收集的信息

所有指标组合通常低于 2KB,因此不会消耗集群资源。

Telemetry 收集以下信息:

5.2.1. 系统信息

系统信息描述了 MicroShift 集群的基本配置及其运行位置,例如:

  • 版本信息,包括 MicroShift 集群版本。
  • Red Hat Enterprise Linux (RHEL)版本。
  • RHEL 部署类型。

5.2.2. 大小信息

大小信息详细介绍了集群容量,例如:

  • MicroShift 可以使用的 CPU 内核。
  • 架构信息。
  • 可用的内存字节。

5.2.3. 使用信息

使用量信息概述了集群中发生的情况,例如:

  • CPU 用量百分比。
  • 内存用量百分比。
  • 根据资源类型(CRD)的 Kubernetes 对象数量。
  • 运行容器、命名空间和运行的 pod 的数量。
  • 路由、入口、服务数量。
注意

Telemetry 不会收集任何身份识别的信息,如用户名或密码。红帽公司不会收集个人信息。如果红帽发现个人信息被意外地收到,红帽会删除这些信息。任何遥测构成个人数据的程度,请参阅 红帽隐私声明 以获取有关红帽隐私实践的更多信息。

红帽收集有关您使用红帽产品的数据,如提供支持和故障排除、改进产品和用户体验、响应问题以及(如果适用)目的。

集合保护

红帽采用技术和组织措施来保护遥测数据。

共享

红帽可能会在红帽内部通过 Telemetry API 收集的数据,以改进您的用户体验。红帽可能会以汇总的形式与业务合作伙伴共享遥测数据,该表单不能辨别客户更好地了解其市场及其客户对红帽产品的使用,或者确保成功集成这些合作伙伴支持的产品。

第三方

红帽可能会与某些第三方合作,协助收集、分析和存储遥测数据。

用户控制:禁用 Telemetry 数据收集

您可以按照 "Opting out of remote health reporting for MicroShift" 部分的说明禁用 MicroShift Telemetry。

5.3. 为 MicroShift 选择 Telemetry

如果您的集群没有连接到网络,或者您不想收集 Telemetry,您可以通过在 MicroShift 配置文件中禁用参数来轻松选择 Telemetry。

先决条件

  • 已安装 OpenShift CLI (oc)。
  • 有对集群的 root 访问权限。

流程

  1. 如果您还没有这样做,请在 /etc/microshift/ 目录中生成提供的 config.yaml.default 文件的副本,将它重命名为 config.yaml
  2. 将新的 MicroShift config.yaml 保留在 /etc/microshift/ 目录中。MicroShift 服务每次启动时都会读取 config.yaml 文件。

    注意

    创建后,config.yaml 文件优先于内置设置。

  3. 可选:如果使用现有的 MicroShift YAML,请使用配置片断。如需更多信息,请参阅附加资源部分中的 "使用配置片断"。
  4. 使用 Disabled 值设置 MicroShift YAML 的 telemetry.status 部分。

    禁用的 Telemetry 配置示例

    apiServer:
    # ...
    telemetry:
        endpoint: https://infogw.api.openshift.com
        status: Disabled
    # ...

5.4. 其他资源

法律通告

Copyright © 2025 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

关于红帽文档

Legal Notice

Theme

© 2026 Red Hat
返回顶部