长期支持版本

    社区创新版本

      虚拟机配置

      总体介绍

      概述

      Libvirt工具采用XML格式的文件描述一个虚拟机特征,包括虚拟机名称、CPU、内存、磁盘、网卡、鼠标、键盘等信息。用户可以通过修改配置文件,对虚拟机进行管理。本章介绍XML配置文件各个元素的含义,指导用户完成虚拟机配置。

      基本格式

      虚拟机XML配置文件以domain为根元素,domain根元素中包含多个其他元素。XML配置文件中的部分元素可以包含对应属性和属性值,用以详细地描述虚拟机信息,同一元素的不同属性使用空格分开。

      XML配置文件的基本格式如下,其中label代表具体标签名,attribute代表属性,value代表属性值,需要根据实际情况修改。

      <domain type='kvm'>
          <name>VMName</name>
          <memory attribute='value'>8</memory>
          <vcpu>4</vcpu>
          <os>
             <label attribute='value' attribute='value'>
               ...
             </label>
          </os>
          <label attribute='value' attribute='value'>
            ...
          </label>  
      </domain>
      

      配置流程

      1. 创建一个根元素为domain的XML配置文件。

      2. 使用标签name,根据命名规则指定唯一的虚拟机名称。

      3. 配置虚拟CPU和虚拟内存等系统资源。

      4. 配置虚拟设备。

        1. 配置存储设备。
        2. 配置网络设备。
        3. 配置外部总线结构。
        4. 配置鼠标等外部设备。
      5. 保存XML配置文件。

      虚拟机描述

      概述

      本节介绍虚拟机domain根元素和虚拟机名称的配置。

      元素介绍

      • domain:虚拟机XML配置文件的根元素,用于配置运行此虚拟机的hypervisor的类型。

        属性type:虚拟化中domain的类型。openEuler虚拟化中属性值为kvm。

      • name:虚拟机名称。

        虚拟机名称为一个字符串,同一个主机上的虚拟机名称不能重复,虚拟机名称必须由数字、字母、“_”、“-”、“:”、“!”、“@”、“#”、“$”、“%”、“^”、“.”组成,但不支持全数字的字符串,且虚拟机名称不超过64个字符。

      配置示例

      例如,虚拟机名称为openEuler的配置如下:

      <domain type='kvm'>
          <name>openEuler</name>
          ...
      </domain>
      

      虚拟CPU和虚拟内存

      概述

      本节介绍虚拟CPU和虚拟内存的常用配置。

      元素介绍

      • vcpu:虚拟处理器的个数。

      • memory:虚拟内存的大小。

        属性unit:指定内存单位,属性值支持KiB(210 字节),MiB(220 字节),GiB(230 字节),TiB(240 字节)等。

      • cpu:虚拟处理器模式。

        属性mode:表示虚拟CPU的模式,属性值host-passthrough表示虚拟CPU的架构和特性与主机保持一致。

        子元素topology:元素cpu的子元素,用于描述虚拟CPU模式的拓扑结构。

        • 子元素topology的属性socket、cores、threads分别描述了虚拟机具有多少个cpu socket,每个cpu socket中包含多少个处理核心(core),每个处理器核心具有多少个超线程(thread),属性值为正整数且三者的乘积等于虚拟CPU的个数。

      配置示例

      例如,虚拟CPU个数为4,处理模式为host-passthrough,虚拟内存为8GiB,4个CPU分布在两个CPU socket中,且不支持超线程的配置如下:

      <domain type='kvm'>
          ...
          <vcpu>4</vcpu>
          <memory unit='GiB'>8</memory>
          <cpu mode='host-passthrough'>
              <topology sockets='2' cores='2' threads='1'/>
          </cpu>
      ...
      </domain>
      

      配置虚拟设备

      虚拟机XML配置文件使用devices元素配置虚拟设备,包括存储设备、网络设备、总线、鼠标等,本节介绍常用的虚拟设备如何配置。

      存储设备

      概述

      XML配置文件可以配置虚拟存储设备信息,包括软盘、磁盘、光盘等存储介质及其存储类型等信息,本节介绍存储设备的配置方法。

      元素介绍

      XML配置文件使用disk元素配置存储设备,disk常见的属性如表1所示,常见子元素及子元素属性如表2所示。

      表 1 元素disk的常用属性

      元素

      属性

      含义

      属性值及其含义

      disk

      type

      指定后端存储介质类型

      block:块设备

      file:文件设备

      dir: 目录路径

      device

      指定呈现给虚拟机的存储介质

      disk:磁盘(默认)

      floppy:软盘

      cdrom:光盘

      表 2 元素disk的常用子元素及属性说明

      子元素

      子元素含义

      属性说明

      source

      指定后端存储介质,与disk元素的属性“type”指定类型相对应

      file:对应file类型,值为对应文件的完全限定路径。

      dev:对应block类型,值为对应主机设备的完全限定路径。

      dir:对应dir类型,值为用作磁盘目录的完全限定路径。

      driver

      指定后端驱动的详细信息

      type:磁盘格式的类型,常用的有“raw”和“qcow2”,需要与source的格式一致。

      io:磁盘IO模式,支持“native”和“threads”选项。

      cache:磁盘的cache模式,可选项有“none”、“writethrough”、“writeback”、“directsync”等。

      iothread:指定为磁盘分配的IO线程。

      target

      指磁盘呈现给虚拟机的总线和设备

      dev:指定磁盘的逻辑设备名称,如SCSI、SATA、USB类型总线常用命令习惯为sd[a-p],IDE类型设备磁盘常用命名习惯为hd[a-d]。

      bus:指定磁盘设备的类型,常见的有“scsi”、“usb”、“sata”、“virtio”等类型。

      boot

      表示此磁盘可以作为启动盘使用

      order:指定磁盘的启动顺序。

      readonly

      表示磁盘具有只读属性,磁盘内容不可以被虚拟机修改,通常与光驱结合使用

      -

      配置示例

      按照“准备虚拟机镜像”操作完成虚拟机镜像准备后,可以使用如下XML配置文件示例,为虚拟机配置虚拟磁盘。

      例如,该示例为虚拟机配置了两个IO线程,一个块磁盘设备和一个光盘设备,第一个IO线程分配给块磁盘设备使用。该块磁盘设备的后端介质为qcow2格式,且被作为优先启动盘。

      <domain type='kvm'>
          ...
          <iothreads>2</iothreads>
          <devices>
              <disk type='file' device='disk'>
      	    <driver name='qemu' type='qcow2' cache='none' io='native' iothread="1"/>
      	    <source file='/mnt/openEuler-image.qcow2'/>
      	    <target dev='vda' bus='virtio'/>
      	    <boot order='1'/>
      	</disk>
      	<disk type='file' device='cdrom'>
      	    <driver name='qemu' type='raw' cache='none' io='native'/>
      	    <source file='/mnt/openEuler-20.03-LTS-aarch64-dvd.iso'/>
      	    <target dev='sdb' bus='scsi'/>
      	    <readonly/>
      	    <boot order='2'/>
      	</disk>
               ...
          </devices>
      </domain>
      

      网络设备

      概述

      XML配置文件可以配置虚拟网络设备,包括ethernet模式、bridge模式、vhostuser模式等,本节介绍虚拟网卡设备的配置方法。

      元素介绍

      XML配置文件中使用元素“interface”,其属性“type”表示虚拟网卡的模式,可选的值有“ethernet”、“bridge”、“vhostuser”等,下面以“bridge”模式虚拟网卡为例介绍其子元素以及对应的属性。

      表 3 bridge模式虚拟网卡常用子元素

      子元素

      子元素含义

      属性及含义

      mac

      虚拟网卡的mac地址

      address:指定mac地址,若不配置,会自动生成。

      target

      后端虚拟网卡名

      dev:创建的后端tap设备的名称。

      source

      指定虚拟网卡后端

      bridge:与bridge模式联合使用,值为网桥名称。

      boot

      表示此网卡可以作为远程启动

      order:指定网卡的启动顺序。

      model

      表示虚拟网卡的类型

      type:bridge模式网卡通常使用virtio。

      virtualport

      端口类型

      type:若使用OVS网桥,需要配置为openvswitch。

      driver

      后端驱动类型

      name:驱动名称,通常取值为vhost。

      queues:网卡设备队列数。

      配置示例

      • 按照“准备虚拟机网络”创建了Linux网桥br0后,配置一个桥接在br0网桥上的virtio类型的虚拟网卡设备,对应的XML配置如下:

        <domain type='kvm'>
            ...
            <devices>
                <interface type='bridge'>
                    <source bridge='br0'/>
                    <model type='virtio'/>
                </interface>
                ...
            </devices>
        </domain>
        
      • 如果按照“准备虚拟机网络”创建了OVS网桥,配置一个后端使用vhost驱动,且具有四个队列的virtio虚拟网卡设备。

        <domain type='kvm'>
            ...
            <devices>
                <interface type='bridge'>
                    <source bridge='br0'/>
                    <virtualport type='openvswitch'/> 
                    <model type='virtio'/>
                    <driver name='vhost' queues='4'/> 
                </interface>
                ...
            </devices>
        </domain>
        

      总线配置

      概述

      总线是计算机各个部件之间进行信息通信的通道。外部设备需要挂载到对应的总线上,每个设备都会被分配一个唯一地址(由子元素address指定),通过总线网络完成与其他设备或中央处理器的信息交换。常见的设备总线有ISA总线、PCI总线、USB总线、SCSI总线、PCIe总线。

      PCIe总线是一种典型的树结构,具有比较好的扩展性,总线之间通过控制器关联,这里以PCIe总线为例介绍如何为虚拟机配置总线拓扑。

      说明:
      总线的配置相对比较繁琐,若不需要精确控制设备拓扑结构,可以使用libvirt自动生成的缺省总线配置。

      元素介绍

      在libvirt的XML配置中,每个控制器元素(使用controller元素表示)可以表示一个总线,根据虚拟机架构的不同,一个控制器上通常可以挂载一个或多个控制器或设备。这里介绍常用属性和子元素。

      controller:控制器元素,表示一个总线。

      • 属性type:控制器必选属性,表示总线类型。常用取值有“pci”、“usb”、“scsi”、“virtio-serial”、“fdc”、“ccid”。

      • 属性index:控制器必选属性,表示控制器的总线“bus”编号(编号从0开始),可以在地址元素“address”元素中使用。

      • 属性model:控制器必选属性,表示控制器的具体型号,其可选择的值与控制器类型“type”的值相关,对应关系及含义请参见表1

      • 子元素address:为设备或控制器指定其在总线网络中的挂载位置。

        • 属性type:设备地址类型。常用取值有“pci”、“usb”、“drive”。address的type类型不同, 对应的属性也不同,常用type属性值及其该取值下address的属性请参见表2
      • 子元素model:控制器具体型号的名称。

        • 属性name:指定控制器具体型号的名称,和父元素controller中的属性model对应。

      表 4 controller属性type常用取值和model取值对应关系

      type属性值

      model属性值

      简介

      pci

      pcie-root

      PCIe根节点,可挂载PCIe设备或控制器

      pcie-root-port

      只有一个slot,可以挂载PCIe设备或控制器

      pcie-to-pci-bridge

      PCIe转PCI桥控制器,可挂载PCI设备

      usb

      ehci

      USB 2.0控制器,可挂载USB 2.0设备

      nec-xhci

      USB 3.0控制器,可挂载USB 3.0设备

      scsi

      virtio-scsi

      virtio类型SCSI控制器,可以挂载块设备,如磁盘,光盘等

      virtio-serial

      virtio-serial

      virtio类型串口控制器,可挂载串口设备,如pty串口

      表 5 address元素不同设备类型下的属性说明

      类型type属性值

      含义

      对应地址属性

      pci

      地址类型为PCI地址,表示该设备在PCI总线网络中的挂载位置。

      domain:PCI设备的域号

      bus:PCI设备的bus号

      slot:PCI设备的device号

      function:PCI设备的function号

      multifunction:controller元素可选,是否开启multifunction功能

      usb

      地址类型为USB地址,表示该设备在USB总线中的位置。

      bus:USB设备的bus号

      port:USB设备的port号

      drive

      地址类型存储设备地址,表示所属的磁盘控制器,及其在总线中的位置。

      controller:指定所属控制器号

      bus:设备输出的channel号

      target:存储设备target号

      unit:存储设备lun号

      配置示例

      该示例给出一个PCIe总线的拓扑结构。PCIe根节点(BUS 0)下挂载了三个PCIe-Root-Port控制器。第一个PCIe-Root-Port控制器(BUS 1)开启了multifunction功能,并在其下挂载一个PCIe-to-PCI-bridge控制器,形成了一个PCI总线(BUS 3),该PCI总线上挂载了一个virtio-serial设备和一个USB 2.0控制器。第二个PCIe-Root-Port控制器(BUS 2)下挂载了一个SCSI控制器。第三个PCIe-Root-Port控制器(BUS 0)下无挂载设备。配置内容如下:

      <domain type='kvm'>
          ...
          <devices>
              <controller type='pci' index='0' model='pcie-root'/>
      	<controller type='pci' index='1' model='pcie-root-port'>
      	    <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x0' multifunction='on'/>
      	</controller>
      	<controller type='pci' index='2' model='pcie-root-port'>
      	    <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x1'/>
      	</controller>
      	<controller type='pci' index='3' model='pcie-to-pci-bridge'>
      	    <model name='pcie-pci-bridge'/>
      	    <address type='pci' domain='0x0000' bus='0x01' slot='0x00' function='0x0'/>
      	</controller>
      	<controller type='pci' index='4' model='pcie-root-port'>
      	    <address type='pci' domain='0x0000' bus='0x00' slot='0x01' function='0x2'/>
      	</controller>
      	<controller type='scsi' index='0' model='virtio-scsi'>
      	    <address type='pci' domain='0x0000' bus='0x02' slot='0x00' function='0x0'/>
      	</controller>
      	<controller type='virtio-serial' index='0'>
      	    <address type='pci' domain='0x0000' bus='0x03' slot='0x02' function='0x0'/>
      	</controller>
      	<controller type='usb' index='0' model='ehci'>
      	    <address type='pci' domain='0x0000' bus='0x03' slot='0x01' function='0x0'/>
      	</controller>
      	...
      	</devices>
      </domain>
      

      其它常用设备

      概述

      除存储设备、网络设备外,XML配置文件中还需要指定一些其他外部设备,本节介绍这些元素的配置方法。

      元素介绍

      • serial:串口设备

        属性type:用于指定串口类型。常用属性值为pty、tcp、pipe、file。

      • video:媒体设备

        属性type:媒体设备类型。AArch架构常用属性值为virtio,x86_64架构通常使用属性值为vga或cirrus。

        子元素model:video的子元素,用于指定媒体设备类型。

        在model元素中,type属性为vga表示配置VGA类型显卡,vram属性代表显存大小,单位默认为KB。

        例如:给x86_64架构虚拟机配置16MB的VGA类型的显卡,XML示例如下,其中vram属性代表显存大小,单位默认为KB:

        <video>
            <model type='vga' vram='16384' heads='1' primary='yes'/>
        </video>
        
      • input:输出设备

        属性type:指定输出设备类型。常用属性值为tabe、keyboard,分别表示输出设备为写字板、键盘。

        属性bus:指定挂载的总线。常用属性值为USB。

      • emulator:模拟器应用路径

      • graphics:图形设备

        属性type:指定图形设备类型。常用属性值为vnc。

        属性listen:指定侦听的IP地址。

      配置示例

      例如,在下面的示例中,配置了虚拟机的模拟器路径,pty串口、virtio媒体设备、USB写字板、USB键盘以及VNC图形设备。

      说明:
      graphics的type配置为VNC时,建议配置属性passwd,即使用VNC登录时的密码。

      <domain type='kvm'>
          ...
          <devices>
              <emulator>/usr/libexec/qemu-kvm</emulator>
              <console type='pty'/>
              <video>
                  <model type='virtio'/>
              </video>
              <input type='tablet' bus='usb'/>
              <input type='keyboard' bus='usb'/>
              <graphics type='vnc' listen='0.0.0.0' passwd='n8VfjbFK'/>
      	...
      	</devices>
      </domain>
      

      体系架构相关配置

      概述

      XML中还有一部分体系架构相关的配置,这部分配置包括主板,CPU,一些与体系架构相关的feature,本章节主要介绍它们的配置和含义。

      元素介绍

      • os:定义虚拟机启动参数。

        子元素type:指定虚拟机类型,属性arch表示架构类型,如aarch64,属性machine表示虚拟机的芯片组类型,虚拟机支持的芯片组可以通过 qemu-kvm -machine ? 命令查询,如AArch64结构使用“virt”类型。

        子元素loader:指定加载固件 ,如配置EDK提供的UEFI文件,属性readonly表示是否是只读文件,值为“yes”或“no”,属性type表示loader的类型,常用的值有“rom”、“pflash”。

        子元素nvram:指定nvram文件路径,用于存储UEFI启动配置。

      • features:hypervisor支持控制一些虚拟机CPU/machine的特性,如高级电源管理接口“acpi”,ARM处理器指定GICv3中断控制器等。

      AArch64架构配置示例

      虚拟机的类型为AArch64结构,使用virt芯片组,利用UEFI启动的虚拟机配置如下:

      <domain type='kvm'>
          ...
          <os>
              <type arch='aarch64' machine='virt'>hvm</type>
              <loader readonly='yes' type='pflash'>/usr/share/edk2/aarch64/QEMU_EFI-pflash.raw</loader>
              <nvram>/var/lib/libvirt/qemu/nvram/openEulerVM.fd</nvram>
          </os>
          ...
      </domain>
      

      为虚拟机配置ACPI和GIC V3中断控制器特性。

      <features>
          <acpi/>
          <gic version='3'/>
      </features>
      

      x86_64架构配置示例

      x86_64架构支持BIOS和UEFI两种启动方式,如果不配置loader,则使用默认启动方式BIOS。这里给出启动方式为UEFI、芯片组为q35的配置参考。

      <domain type='kvm'>
          ...
          <os>
              <type arch='x86_64' machine='q35'>hvm</type>
              <loader type='rom'>/usr/share/edk2/ovmf/OVMF.fd</loader>
          </os>
          ...
      </domain>
      

      其他常见配置项

      概述

      除系统资源和虚拟设备外,XML配置文件还需要配置一些其他元素,本节介绍这些元素的配置方法。

      元素介绍

      • iothreads:指定iothread数量,可以用于加速存储设备性能。

      • on_poweroff:虚拟机关闭时采取的动作。

      • on_reboot:虚拟机重启时采取的动作。

      • on_crash:虚拟机崩溃时采取的动作。

      • clock:采用的时钟类型。

        属性offset:设置虚拟机时钟的同步类型,可选的值有“localtime”、“utc”、“timezone”、“variable”等。

      配置示例

      为虚拟机配置两个iothread,用于加速存储设备性能。

      <iothreads>2</iothreads>
      

      虚拟机关闭时,销毁虚拟机。

      <on_poweroff>destroy</on_poweroff>
      

      虚拟机重启时,重新启动虚拟机。

      <on_reboot>restart</on_reboot>
      

      虚拟机崩溃时,重新启动虚拟机。

      <on_crash>restart</on_crash>
      

      时钟采用“utc”的同步方式。

      <clock offset='utc'/>
      

      XML配置文件示例

      概述

      本节给出一个基本的AArch64虚拟机和一个x86_64虚拟机的XML配置文件示例,供用户参考。

      示例一

      一个包含基本元素的AArch64架构虚拟机的XML配置文件,其内容示例如下:

      <domain type='kvm'>
          <name>openEulerVM</name>
          <memory unit='GiB'>8</memory>
          <vcpu>4</vcpu>
          <os>
      	<type arch='aarch64' machine='virt'>hvm</type>
      	<loader readonly='yes' type='pflash'>/usr/share/edk2/aarch64/QEMU_EFI-pflash.raw</loader>
      	<nvram>/var/lib/libvirt/qemu/nvram/openEulerVM.fd</nvram>
          </os>
          <features>
      	<acpi/>
      	<gic version='3'/>
          </features>
          <cpu mode='host-passthrough'>
              <topology sockets='2' cores='2' threads='1'/>
          </cpu>
          <iothreads>1</iothreads>
          <clock offset='utc'/>
          <on_poweroff>destroy</on_poweroff>
          <on_reboot>restart</on_reboot>
          <on_crash>restart</on_crash>
          <devices>
      	<emulator>/usr/libexec/qemu-kvm</emulator>
      	<disk type='file' device='disk'>
      	    <driver name='qemu' type='qcow2' iothread="1"/>
      	    <source file='/mnt/openEuler-image.qcow2'/>
      	    <target dev='vda' bus='virtio'/>
      	    <boot order='1'/>
      	</disk>
      	<disk type='file' device='cdrom'>
      	    <driver name='qemu' type='raw'/>
      	    <source file='/mnt/openEuler-20.03-LTS-aarch64-dvd.iso'/>
      	    <readonly/>
      	    <target dev='sdb' bus='scsi'/>
      	    <boot order='2'/>
      	</disk>
      	<interface type='bridge'>
      	    <source bridge='br0'/>
      	    <model type='virtio'/>
      	</interface>
      	<console type='pty'/>
              <video>
                 <model type='virtio'/>
              </video>
              <controller type='scsi' index='0' model='virtio-scsi'/>
      	<controller type='usb' model='ehci'/>
      	<input type='tablet' bus='usb'/>
      	<input type='keyboard' bus='usb'/>
      	<graphics type='vnc' listen='0.0.0.0' passwd='n8VfjbFK'/>
          </devices>
          <seclabel type='dynamic' model='dac' relabel='yes'/>
      </domain>
      

      示例二

      一个包含基本元素及总线元素x86_64架构虚拟机的XML配置文件,其配置示例如下:

      <domain type='kvm'>
        <name>openEulerVM</name>
        <memory unit='KiB'>8388608</memory>
        <currentMemory unit='KiB'>8388608</currentMemory>
        <vcpu placement='static'>4</vcpu>
        <iothreads>1</iothreads>
        <os>
          <type arch='x86_64' machine='pc-i440fx-4.0'>hvm</type>
        </os>
        <features>
          <acpi/>
        </features>
        <cpu mode='host-passthrough' check='none'>
          <topology sockets='2' cores='2' threads='1'/>
        </cpu>
        <clock offset='utc'/>
        <on_poweroff>destroy</on_poweroff>
        <on_reboot>restart</on_reboot>
        <on_crash>restart</on_crash>
        <devices>
          <emulator>/usr/libexec/qemu-kvm</emulator>
          <disk type='file' device='disk'>
            <driver name='qemu' type='qcow2' iothread='1'/>
            <source file='/mnt/openEuler-image.qcow2'/>
            <target dev='vda' bus='virtio'/>
            <boot order='1'/>
            <address type='pci' domain='0x0000' bus='0x00' slot='0x08' function='0x0'/>
          </disk>
          <controller type='scsi' index='0' model='virtio-scsi'>
          </controller>
          <controller type='virtio-serial' index='0'>
          </controller>
          <controller type='usb' index='0' model='ehci'>
          </controller>
          <controller type='sata' index='0'>
          </controller>
          <controller type='pci' index='0' model='pci-root'/>
          <interface type='bridge'>
            <mac address='52:54:00:c1:c4:23'/>
            <source bridge='virbr0'/>
            <model type='virtio'/>
          </interface>
          <serial type='pty'>
            <target type='isa-serial' port='0'>
              <model name='isa-serial'/>
            </target>
          </serial>
          <console type='pty'>
            <target type='serial' port='0'/>
          </console>
          <input type='tablet' bus='usb'>
            <address type='usb' bus='0' port='1'/>
          </input>
          <input type='keyboard' bus='usb'>
            <address type='usb' bus='0' port='2'/>
          </input>
          <input type='mouse' bus='ps2'/>
          <input type='keyboard' bus='ps2'/>
          <graphics type='vnc' port='-1' autoport='yes' listen='0.0.0.0'>
            <listen type='address' address='0.0.0.0'/>
          </graphics>
          <video>
            <model type='vga' vram='16384' heads='1' primary='yes'/>
            <address type='pci' domain='0x0000' bus='0x00' slot='0x02' function='0x0'/>
          </video>
          <memballoon model='virtio'>
          </memballoon>
        </devices>
      </domain>
      

      文档捉虫

      “有虫”文档片段

      问题描述

      提交类型 issue

      有点复杂...

      找人问问吧。

      PR

      小问题,全程线上修改...

      一键搞定!

      问题类型
      规范和低错类

      ● 错别字或拼写错误;标点符号使用错误;

      ● 链接错误、空单元格、格式错误;

      ● 英文中包含中文字符;

      ● 界面和描述不一致,但不影响操作;

      ● 表述不通顺,但不影响理解;

      ● 版本号不匹配:如软件包名称、界面版本号;

      易用性

      ● 关键步骤错误或缺失,无法指导用户完成任务;

      ● 缺少必要的前提条件、注意事项等;

      ● 图形、表格、文字等晦涩难懂;

      ● 逻辑不清晰,该分类、分项、分步骤的没有给出;

      正确性

      ● 技术原理、功能、规格等描述和软件不一致,存在错误;

      ● 原理图、架构图等存在错误;

      ● 命令、命令参数等错误;

      ● 代码片段错误;

      ● 命令无法完成对应功能;

      ● 界面错误,无法指导操作;

      风险提示

      ● 对重要数据或系统存在风险的操作,缺少安全提示;

      内容合规

      ● 违反法律法规,涉及政治、领土主权等敏感词;

      ● 内容侵权;

      您对文档的总体满意度

      非常不满意
      非常满意
      提交
      根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。
      文档捉虫
      编组 3备份