Hadolint：Lint Dockerfile 的完整指南

想学习如何使用 Hadolint 对 Dockerfile 进行 lint 处理吗？这篇博文将向您展示如何操作。这是关于 Dockerfile linting 的完整指南。

通过对 Dockerfile 进行 lint 检查，您可以及早发现错误和问题，并确保它们遵循最佳实践。

什么是Hadolint？

Hadolint 是一个使用 Haskell 构建的开源命令行 Dockerfile linter 工具，可帮助您编写无错误的 Dockersfile。Hadolint 会检查您的 Dockerfile 是否存在可能的错误、安全漏洞和性能问题。它在 GitHub 上有超过 9k 的启动

这是它的工作原理。

  1. Hadolint 读取 Dockerfile
  2. 它将 Dockerfile 解析为 AST（抽象语法树），以标识与其关联的每个指令和参数。
  3. 然后，它根据预定义的规则集检查每条指令，这些规则涵盖安全性、效率和代码质量。这些规则是 Hadolint 源代码的一部分。您可以在此处查看规则列表。
  4. Hadolint 会标记所有违反规则的行为，并会针对所有检测到的问题创建反馈。

问题的严重性分类如下：

  1. Info– 您将获得有关信息改进的建议。它被认为不太严重。
  2. Style – 与 Dockerfile 的格式或结构相关，例如使用缩进或使用长单行等。
  3. Warning – 不太严重的问题和需要改进的次要安全问题。
  4. Error– 这些问题很严重，可能与安全漏洞或重大最佳实践违规有关。

现在我们已经对 Hadolint 有了基本的了解，让我们继续安装并查看它的实际效果。

安装 Hadolint

您可以在 Linux、Mac 和 Windows 系统上安装 Hadolint。

在 Linux 中安装

如果要在Linux系统中安装Hadolint，请按照以下步骤操作。

步骤1：从 Hadolint Github 发布页面下载最新的 Linux Hadolint 包。

wget -O hadolint https://github.com/hadolint/hadolint/releases/download/v2.12.0/hadolint-Linux-x86_64

步骤2： 下载应用程序后，将其移动到 /usr/local/bin 目录。

sudo mv hadolint /usr/local/bin/hadolint

第 3 步：使用下面给出的命令向 Hadolint 授予执行权限。

sudo chmod +x /usr/local/bin/hadolint

在 Mac 中安装

您可以使用下面给出的命令在 Mac 系统上安装 Hadolint。

brew install hadolint

要检查 Linux 或 Mac 系统上是否安装了 Hadolint，请运行以下命令：

hadolint --version

在 Windows 中安装

使用 scoop 在 Windows 上安装 Hadolint

scoop install hadolint

安装 hadolint 后，您将拥有 hadolint CLI 来对 Dockerfile 运行 lint 测试。

要了解所有 CLI 选项，可以使用 –help 标志。

hadolint --help

使用 Hadolint 的 lint Dockerfile

要使用 Hadolint，只需将其安装在您的系统上并使用 Dockerfile 运行该命令。Hadolint 将提供它在 Dockerfile 中发现的错误列表作为输出，以及严重性级别和该问题的原因。

为了获得实际的理解，我们将使用未优化的 Dockerfile。

将以下内容另存为 Dockerfile。

FROM ubuntu:latest
RUN apt-get update
RUN apt-get install -y curl
RUN apt-get update && apt-get install -y curl
RUN echo "hello world" | grep "world" | wc -l
CMD ["echo", "Hello, world!"]

让我们针对上面的 Dockerfile 运行 Hadolint。确保 Dockerfile 位于运行 hadolint 命令的同一目录中。

hadolint Dockerfile

您将收到以下输出，其中包含“警告”和“信息”消息，其中包含规则编号和修正信息，如下图所示。

如果您检查编号 7，Hadolint 也会提供有关 shell 脚本的信息。Hadolint 在后台使用 Shellcheck 对属于 RUN 指令一部分的 shell 脚本进行 lint 处理。

现在，如果您检查退出代码，您将获得一个非零返回。

hadolint-examples git:(main) ✗ echo $?                      
1
➜  hadolint-examples git:(main) ✗

如果实现所有建议，将获得以下 Dockerfile。

# Use Ubuntu 20.04 as the base image
FROM ubuntu:20.04

# Set the default shell with -o pipefail
SHELL ["/bin/bash", "-o", "pipefail", "-c"]

# Run commands
RUN apt-get update && \
    apt-get install -y curl=8.4.0 --no-install-recommends && \
    apt-get clean && \
    rm -rf /var/lib/apt/lists/* && \
    echo "hello world" | grep -c "world"

# Default command to run
CMD ["echo", "Hello, world!"]

现在，如果对修正和更新的 Dockerfile 运行 Hadolint，则不会收到任何警告或信息消息。如果您检查返回值，您将获得如下图所示。0

忽略规则

在某些情况下，你可能不希望修正所有建议。在这种情况下，您可以使用 --ignore 标志忽略特定规则。

例如，如果我想忽略建议指定软件包版本的 DL3008，可以使用以下命令。

hadolint --ignore DL3008 Dockerfile

在使用 CI/CD 系统时，我们需要标准化衬里的所有配置和规则。这是配置文件hadolint.yaml的用武之地。

hadolint.yaml

handolint.yaml 是 Hadolint 的配置文件。您可以使用配置文件自定义 Hadolint 处理输出和建议的方式。

当您希望对跨组织或项目进行 linting Dockerfile 的标准化和自定义时，这特别有用。此模板可以与开发 Dockerfile 的开发人员或 DevOps 工程师共享。

您可以参考官方文档了解所有支持的参数。

让我们来看看关键参数。

  1. failure-threshold：指定 lint 应失败的级别或提供非零fanhuizhi。例如，默认情况下，Hadolinit 为所有级别提供非零退出代码。使用此参数，您可以为错误和警告配置非零退出代码。对于非零退出代码，将忽略 Info 和 style。
  2. ignored：如果要忽略特定规则，可以在 ignore 参数下列出它们。
  3. override：如果要覆盖特定规则的严重性，则此参数特别有用。例如，DL3015 规则位于 info 下。但是，您希望将其归类为警告。因此，您可以将 DL3015 添加到覆盖下的警告类别下。对于使用此配置的所有 Hadolint 运行，DL3015 将列为警告。
  4. trustedRegistries：在大多数组织中，只允许使用内部容器注册表。如果只想允许来自特定容器注册表的映像，可以在这些参数下添加这些注册表终结点。如果 Dockerfile 包含来自其他注册表的映像，则 lint 将失败。

下面是包含所有关键参数的示例配置。将以下配置另存为 .hadolint.yaml

failure-threshold: warning
format: tty
ignored:
- DL3007
override:
  error:
  - DL3015
  warning:
  - DL3015
  info:
  - DL3008
  style:
  - DL3015
trustedRegistries:
- docker.io
- techiescamp.com:5000
- "*.gcr.io"
- quay.io

您可以将配置文件与 Hadolint 一起使用，如下所示

hadolint --config .hadolint.yaml Dockerfile

​

在 Docker 镜像构建中使用 Hadolint

作为标准做法，开发人员可以在创建 Dockerfile 时运行 Hadolint，然后再将其推送到存储库。但是，Hadolint 的主要用途在于 Docker 映像构建管道。

可以使用 Hadolint 添加 Dockerfile 链接，作为 Docker 生成 CI 管道的一部分。当为创建/更新 Dockerfile 引发 PR 时，管道中的第一步将是 linting。

如果 Dockerfile 不遵守 Hadolint 规则，则生成将失败，开发人员可以使用 Hadolint 反馈来纠正 Dockerfile 的问题。

您可以根据组织的标准和项目要求使用该文件自定义规则和配置。hadolint.yaml

这样，您可以捕获 Dockerfile 中的所有错误，并确保它在提交到主分支之前遵循标准最佳实践。

使用 Docker 运行 Hadolint

有一种方法可以在不在您的系统中安装 Hadolint 的情况下使用它，我们可以将 Docker 镜像用于 Hadolint。下面给出了使用 Hadolint Docker 映像的命令。

docker run --rm -i hadolint/hadolint < Dockerfile

​

使用此命令的最佳部分是，如果系统中没有Hadolint Docker映像，它将首先下载Docker映像，然后扫描Dockerfile。

Hadolint 在线版

有一个 Hadolint 的在线版本，您可以在其中从浏览器中对 Dockerfile 进行 lint 检查。这对于快速测试很有用。

您可以在此处访问在线版本。

使用 Hadolint 的好处

根据这篇关于 Dockerfile 的 IEEE 研究论文，其数据集中近 84% 的 GitHub 项目在其 Dockerfile 代码中都有气味，尤其是 DL 气味。

使用 Hadolint 有很多好处，下面列出了一些好处：

  1. 改进了 Dockerfile 质量：Hadolint 识别 Dockerfile 中的错误，从而改进和优化 Dockerfile
  2. 降低安全风险：Hadolint 可以识别 Dockerfile 中的安全漏洞，例如使用旧的基础映像，并帮助减少攻击面。
  3. 提高性能：Hadolint 可以在 Dockerfile 中发现降低 Docker 映像性能的问题，例如构建不必要的大型映像。
  4. 提高一致性：Hadolint 确保您的 Dockerfile 与最佳实践一致，从而使它们符合您组织的策略。

使用Hadolint的提示

以下是使用 Hadolint 的一些提示：

  1. 首先修复最严重的错误：Hadolint 将为其发现的每个错误分配一个严重性级别。首先，修复最严重的错误，因为这些错误最有可能导致问题。
  2. 启用所有规则：Hadolint 附带了一组默认启用的默认规则。但是，还可以启用许多可选规则。考虑启用所有规则以使 Hadolint 高效工作。您可以根据排除要求再次自定义这些规则。
  3. 根据需要配置 Hadolint：您还可以修改启用的规则和不同冲突的严重性级别，还可以指定输出格式。

结论

在开发过程中，Linting Dockerfile 是一种很好的做法，就像在 Infra 管道中一样。我强烈建议您将 Hadolint 添加为 Docker 映像构建管道的一部分，以获得安全和优化的容器映像。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/300074.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

数据结构期中模拟

数据结构期中模拟

一、填空题 1.二叉树就是度为 2 的树。&#xff08;F&#xff09; 二叉树的度<2 2.线性表采用链式存储表示时&#xff0c;所有结点之间的存储单元地址可以连续也可以不连续。(T) 在顺序表中&#xff0c;逻辑上相邻的元素&#xff0c;其物理位置一定相邻。在单链表中&#x…
阅读更多...
java案例知识点

java案例知识点

一.会话技术 概念 技术 二.跨域 三.过滤器 四.拦截器
阅读更多...
电脑丢失dll文件怎么办，dll修复工具可一键修复dll问题

电脑丢失dll文件怎么办，dll修复工具可一键修复dll问题

在计算机使用过程中&#xff0c;我们经常会遇到一些错误提示&#xff0c;其中最常见的就是“找不到指定的模块”或“无法找到某某.dll文件”。这种情况通常是由于dll文件丢失或损坏导致的。那么&#xff0c;究竟是什么原因导致了dll文件的丢失呢&#xff1f;又该如何预防dll文件…
阅读更多...
Linux 编译安装 Nginx

Linux 编译安装 Nginx

目录 一、前言二、四种安装方式介绍三、本文安装方式&#xff1a;源码安装3.1、安装依赖库3.2、开始安装 Nginx3.3、Nginx 相关操作3.4、把 Nginx 注册成系统服务 四、结尾 一、前言 Nginx 是一款轻量级的 Web 服务器、[反向代理]服务器&#xff0c;由于它的内存占用少&#xf…
阅读更多...
CentOS中开启mysql挂载

CentOS中开启mysql挂载

挂载的作用其实说白了就是备份。防止数据库文件损害或者数据库被误删导致数据丢失。 创建一个文件名为my.cnf内容如下 # Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. # # This program is free software; you can redistribute it and/or modif…
阅读更多...
用通俗易懂的方式讲解：使用 Mistral-7B 和 Langchain 搭建基于PDF文件的聊天机器人

用通俗易懂的方式讲解：使用 Mistral-7B 和 Langchain 搭建基于PDF文件的聊天机器人

在本文中&#xff0c;使用LangChain、HuggingFaceEmbeddings和HuggingFace的Mistral-7B LLM创建一个简单的Python程序&#xff0c;可以从任何pdf文件中回答问题。 一、LangChain简介 LangChain是一个在语言模型之上开发上下文感知应用程序的框架。LangChain使用带prompt和few…
阅读更多...
Halcon区域的灰度特征值gray_features

Halcon区域的灰度特征值gray_features

Halcon区域的灰度特征值 gray_features 算子用于计算指定区域的灰度特征值。其输入是一组区域&#xff0c;每个区域的特征都存 储在一组value数组中。 典型的基于灰度值的特征如下&#xff1a; &#xff08;1&#xff09;area&#xff1a;灰度区域面积。 &#xff08;2&#x…
阅读更多...
c++学习第八讲---类和对象---继承

c++学习第八讲---类和对象---继承

继承&#xff1a; 使子类&#xff08;派生类&#xff09;拥有与父类&#xff08;基类&#xff09;相同的成员&#xff0c;以节约代码量。 1.继承的基本语法&#xff1a; class 子类名&#xff1a;继承方式 父类名{} &#xff1b; 例&#xff1a; class father { public:in…
阅读更多...
Unity 了解Input Manage下默认的输入轴

Unity 了解Input Manage下默认的输入轴

在Unity菜单Edit->Project Settings->Input Manager->Axes下有一些默认的输入轴&#xff0c;如 这些输入轴代表不同类型的输入&#xff0c;其中&#xff1a; Horizontal&#xff1a;水平移动输入轴。通常与键盘的左右箭头键、A和D键、游戏手柄的左摇杆水平轴等相关联…
阅读更多...
数据结构入门到入土——链表（2）

数据结构入门到入土——链表（2）

目录 一&#xff0c;与链表相关的题目&#xff08;2&#xff09; 1.输入两个链表&#xff0c;找出它们的第一个公共节点 2.给定一个链表&#xff0c;判断链表中是否有环 3.给定一个链表&#xff0c;返回链表开始入环的第一个节点&#xff0c;若无则返回null 一&#xff0c;…
阅读更多...
SonarQube 漏洞扫描

SonarQube 漏洞扫描

SonarQube 漏洞扫描 一、部署服务 1.1 docker方式部署 #安装docker curl -L download.beyourself.org.cn/shell-project/os/get-docker-latest.sh | sh yum install -y docker-compose #进去输入:set paste可以保证不穿行 [rootlocalhost sonar]# vim docker-compose.yml v…
阅读更多...
Python从入门到网络爬虫（异常处理详解）

Python从入门到网络爬虫（异常处理详解）

前言 异常即是一个事件&#xff0c;该事件会在程序执行过程中发生&#xff0c;影响了程序的正常执行。一般情况下&#xff0c;在python无法正常处理程序时就会发生一个异常。异常是python对象&#xff0c;表示一个错误。当python脚本发生异常时我们需要捕获处理它&#xff0c;…
阅读更多...
如何把电脑中的项目快速传进Github中？

如何把电脑中的项目快速传进Github中？

一、打开GitHub网站:https:github.com 登录自己的个人账号 1.新建一个项目 2.用鼠标直接拖拽电脑中的项目文件夹与文件到新创建的项目中点击保存即可。
阅读更多...
家里有必要买NAS吗？

家里有必要买NAS吗？

完全没有必要&#xff0c;因为用旧电脑搭建NAS不仅价格实惠&#xff0c;而且非常简单&#xff0c;效果也完全不差买了的&#xff01; 并且......还环保 教程链接&#xff1a; 用旧电脑搭建NAS在您的家庭中&#xff0c;通过将旧 PC 转变为NAS服务器&#xff0c;您可以轻松搭建…
阅读更多...
【Docker】创建，查看，进入容器

【Docker】创建，查看，进入容器

目录 方式一&#xff1a; 创建 查看 ​编辑 方式二&#xff1a; 创建 查看 进入容器 方式一&#xff1a; 首先查看有什么镜像 创建 docker run -i -t --namefreedom centos:7 /bin - i 表示容器一直运行着&#xff0c;容器如果没有客户端连接就会关闭&#xff0c;加了…
阅读更多...
【无标题】MySQL8修改非root用户密码

【无标题】MySQL8修改非root用户密码

首先查看修改的用户信息&#xff0c;我这里用户名是demo&#xff0c;host是**%** 然后使用alter命令修改密码 这里USER后的参数是第一步里查询得到的user与host的组合。ALTER USER demo% IDENTIFIED WITH mysql_native_password BY 新密码;可能会出现的错误&#xff1a; 如果百…
阅读更多...
听GPT 讲Rust源代码--compiler(32)

听GPT 讲Rust源代码--compiler(32)

File: rust/compiler/rustc_middle/src/middle/exported_symbols.rs 在Rust的源代码中&#xff0c;rust/compiler/rustc_middle/src/middle/exported_symbols.rs文件的作用是实现编译器中处理导出符号的功能。 该文件中定义了一些结构体和枚举&#xff0c;用于描述导出符号的信…
阅读更多...
李沐-《动手学深度学习》-- 01-预备知识

李沐-《动手学深度学习》-- 01-预备知识

一、线性代数知识 1. 矩阵计算 a. 矩阵求导 ​ 当y和x分别为标量和向量时候&#xff0c;进行求导得到的矩阵形状&#xff0c;矩阵求导就是矩阵A中的每一个元素对矩阵B中的每一个元素求导 ​ 梯度指向的是值变化最大的方向 ​ 分子布局和分母布局&#xff1a; b. 常识 ax…
阅读更多...
设计模式③ ：生成实例

设计模式③ ：生成实例

文章目录 一、前言二、Singleton 模式1. 介绍2. 应用3. 总结 三、Prototype 模式1. 介绍2. 应用3. 总结 四、Builder 模式1. 介绍2. 应用3. 总结 五、Abstract Factory 模式1. 介绍2. 应用3. 总结 参考内容 一、前言 有时候不想动脑子&#xff0c;就懒得看源码又不像浪费时间所…
阅读更多...
Linux_CentOS_7.9_Oracle11gr2配置数据库及监听服务自启动多方案实操之简易记录

Linux_CentOS_7.9_Oracle11gr2配置数据库及监听服务自启动多方案实操之简易记录

前言： 作为运维保障，都无法准确预估硬件宕机的突发阶段，其生产数据实时在产出，那作为dba数据库服务以及相关Listener的其重要性、必要性就突显而出。这里拿虚拟机试验做个配置记录，便于大家学习参考。 实现方法一： 环境变量值：：$ORACLE_HOME= /data/oracle/product/1…
阅读更多...
最新文章

Copyright @ 2022~2023