devodev/inotify

docker-inotify

快速参考

• 维护者: https://github.com/devodev

支持的标签及对应的 Dockerfile 链接

• https://github.com/devodev/docker-inotify

快速参考（续）

• 问题反馈地址: https://github.com/devodev/docker-inotify/issues

什么是 Inotify？

GitHub 仓库: https://github.com/inotify-tools/inotify-tools

来自 Linux 手册页（<[***]>）：

inotify API 提供了一种监控文件系统事件的机制。Inotify 可用于监控单个文件或目录。当监控目录时，inotify 将返回目录本身及其内部文件的事件。

inotify-tools 软件包包含两个命令行工具（inotifywait、inotifywatch），允许与 Inotify API 交互。

如何使用此镜像

docker-inotify 提供基于 Alpine 的镜像，包含 inotify-tools 软件包、bash 以及一系列网络相关命令行工具（如 curl、netcat 等）。它还包含轻量级脚本 inotifywait.sh，可监控文件和/或目录并将事件发送到用户定义的脚本。该脚本可通过环境变量完全配置。

此镜像的主要用例是提供一种基于配置文件更改触发操作的简单方法。只需在边车容器中挂载要监控的卷，并提供事件接收时触发的脚本即可。

工作原理

inotifywait 进程监控 INOTIFY_TARGET，并使用触发的事件数据作为参数运行 INOTIFY_SCRIPT。

使用默认配置值时，脚本将接收以下参数：

参数示例

监控事件: modify delete delete_self

被监控文件被修改/删除时：

bash
22:48:36 /test MODIFY
22:48:36 /test DELETE_SELF

被监控目录中的文件被修改/删除时：

bash
22:48:36 /test/ MODIFY a_file
22:48:36 /test/ DELETE a_file

以下部分描述如何配置监控进程。

环境变量

全局变量

监控配置变量

默认值在大多数情况下适用。

有关 inotifywait 可用标志的更多详情，请参见 https://github.com/inotify-tools/inotify-tools%E3%80%82

布尔值可设置为任何值以被视为 true。

示例

Kubernetes

以下示例定义包含应用容器和 inotify 边车容器的 Pod，当挂载的配置文件（此处为共享 ConfigMap）更新时，边车容器将触发服务器重载。

yaml
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: application-conf
data:
  application.conf: |-
    [server]
    property=value
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: inotify-example-reload-script
data:
  reload-server.sh: |-
    #!/usr/bin/env bash

    timestamp="$1"; shift
    file="$1"; shift
    event="$1"; shift

    echo "[${timestamp}] 文件: ${file} 已更改（${event}），触发服务器重载"
    curl -s -X POST http://localhost:8080/reload
---
apiVersion: v1
kind: Pod
metadata:
  name: inotify-example
spec:
  containers:
  - name: application
    image: application/server:latest
    ports:
      - containerPort: 8080
        name: server
    volumeMounts:
      - name: conf
        mountPath: /conf/application.conf
        readOnly: true
        subPath: application.conf
  - name: reload-server-sidecar
    image: devodev/inotify:latest
    env:
      - name: INOTIFY_TARGET
        value: "/conf/application.conf"
      - name: INOTIFY_SCRIPT
        value: "/reload-server.sh"
    volumeMounts:
      - name: conf
        mountPath: /conf/application.conf
        readOnly: true
        subPath: application.conf
      - name: reload-script
        mountPath: /reload-server.sh
        readOnly: true
        subPath: reload-server.sh
  volumes:
    - name: conf
      configMap:
        name: application-conf
    - name: reload-script
      configMap:
        name: inotify-example-reload-script
        # 确保脚本可执行
        defaultMode: 0777