You need to enable JavaScript to run this app.
导航

使用工具检测自定义镜像规范

最近更新时间2024.01.09 11:40:56

首次发布时间2023.05.09 08:20:32

火山引擎为您提供了自定义镜像规范检测工具(下文简称检测工具),可以自动检测Linux操作系统各项配置是否符合创建ECS实例规范,缩短您制作自定义镜像的周期,避免通过自定义镜像创建出功能不齐全的ECS实例。

本文为您介绍检测工具的操作步骤与检测指标。

注意事项

  • 检测工具暂仅支持检测Linux类型镜像,包括Ubuntu、CentOS、Debian、OpenSUSE、Fedora、veLinux、Rocky Linux和其它Linux发行版本,不支持检测Windows类型镜像。
  • 检测工具主要检测自定义镜像是否可以创建出功能齐全的ECS实例,导入镜像要求可查看导入自定义镜像要求

操作步骤

  1. 登录您的服务器、虚拟机或其他云平台的云服务器。
  2. 执行如下命令,通过公网下载检测工具压缩包到当前目录。
    wget https://image-check-shanghai.tos-cn-shanghai.volces.com/image_check.tar
    
  3. 执行如下命令,解压检测工具压缩包。
    tar -xvf image_check.tar
    
  4. 执行如下命令,为检测工具文件添加可执行权限。
    cd image_check
    chmod +x image_check
    
  5. 执行如下命令,使用root权限运行检测工具,避免检测工具无法读取已设置访问权限的配置文件。
    sudo <检测工具所在路径>/image_check –p [检测报告存放路径] 
    
  6. 等待检测工具检测系统配置。
    Detecting your system...
    date: 2023-04-10 11:42:12
    --------------------------------------------------
    your system: centos
    Version: 7
    Disk size: 40 GB
    --------------------------------------------------
    [ Check virtio driver ]                      [  OK  ] 
    [ Check cloud init ]                         [  OK  ] 
    [ Check /etc/shadow ]                        [  OK  ] 
    [ Check disk uuid ]                          [  OK  ] 
    [ Check password command ]                   [  OK  ] 
    [ Check disk size ]                          [  OK  ] 
    [ Check disk use rate ]                      [  OK  ] 
    [ Check inode use rate ]                     [  OK  ] 
    [ Check reset-authentication ]               [  OK  ] 
    --------------------------------------------------
    ok count : 9
    failed count : 0
    warning count : 0
    --------------------------------------------------
    the path generated by the report is :image_check/linux_image_check_report_2023-04-10_11-42-12.txt
    Please query the report to get the specific check result information
    
    检测工具会根据检测项给出OKFAILURE或者WARNING检测结果,对于不符合规范的检测项,您可以根据下文“检测项 > 修改建议”进行调整。
    • OK:检测项均符合要求。
    • FAILURE:检测项不符合要求,使用该自定义镜像创建的ECS实例无法正常启动。建议您修复报错项后再制作镜像,以提高实例启动效率。
    • WARNING:检测项不符合要求,使用该自定义镜像创建的ECS实例可以安全启动,但ECS无法通过有效途径干预您的实例配置。您可以选择立即修复,也可以暂时忽略问题直接制作镜像。
  7. 您可以执行如下命令,查看检测工具生成的检测报告。
    报告仅支持.txt格式,检测工具会在运行结果中显示检测报告所在路径,检测报告格式为镜像类型_image_check_report_日期_时间.txt
    您可以执行如下命令,查看检测报告。

    请将报告路径替换为the path generated by the report is :后内容。

    cat image_check/linux_image_check_report_2023-04-10_11-42-12.txt
    
    报告示例:
    Detecting your system...
    date: 2023-04-10 11:42:12
    --------------------------------------------------
    your system: ubuntu
    Version: 20.04
    Disk size: 40 GB
    --------------------------------------------------
    [ Check virtio driver ]
            PASS: kvm virtio driver exists.
            PASS: virtio 1.1 driver exists.
    --------------------------------------------------
    [ Check cloud-init ]
            PASS: the config dirver source is openstack or volcstack.
            PASS: the cloud-init meets the specifications
    --------------------------------------------------
    [ Check /etc/shadow ]
            PASS: /etc/shadow is writable.
    --------------------------------------------------
    [ Check disk uuid ]
            PASS: You have used uuid to mount the system partition.
    --------------------------------------------------
    [ Check password command ]
            PASS: your system have passwd command.
    --------------------------------------------------
    [ Check disk size ]
            PASS: the size of your system disk is 40 GB.
                  The recommended system disk size is 40G-500G.
    --------------------------------------------------
    [ Check disk use rate ]
            PASS: The use rate of your root partition:7%.
    --------------------------------------------------
    [ Check inode use rate ]
            PASS: The inode use rate:4%.
    --------------------------------------------------
    [ Check reset-authentication ]
            PASS: reset-authentication is exist.
    --------------------------------------------------
    

检测项

检测项等级说明修改建议
virtio driverFAILURE检测是否已安装Virtio驱动。
导入火山引擎的自定义镜像需安装虚拟化驱动。
安装Virtio驱动
cloud initWARNING检测是否安装Cloud-init。
导入火山引擎的自定义镜像需安装Cloud-init,且数据源为火山引擎源。
安装Cloud-Init
/etc/shadowFAILURE检测密码文件是否具有写权限。
该文件必须可更改,否则用户不能通过火山引擎云服务器控制台重置密码。
请勿使用chattr命令锁定文件

disk size

FAILURE

检测磁盘容量大小是否符合要求。
镜像的虚拟磁盘大小(而非使用容量)配置系统盘的大小,其容量需不大于500GiB。

说明

若您镜像中系统盘容量低于40GiB,使用该镜像创建云服务器实例时,火山引擎将默认为您创建40GiB大小的系统盘。

-

disk uuidWARNING检测是否通过磁盘UUID挂载分区。使用UUID挂载分区
password commandWARNING检测是否存在password命令。
需保留passwd/chpasswd命令,否则无法修改密码。
-
disk use rateWARNING检测磁盘使用率是否正常。
需保持磁盘使用空间不高于98%。
删除不必要文件
inode use rateWARNING检测inode资源使用率是否正常。
需保持inode资源不高于98%。
删除不必要文件
reset-authenticationWARNING检测是否已安装密码插件。
需安装密码插件,用于修改、调整该镜像创建的云服务器实例密码。
安装密码插件