d3fk/nfs-client

d3fk/nfs-client Docker镜像文档

镜像概述和主要用途

d3fk/nfs-client是一个轻量级多架构Docker NFS客户端镜像，基于Alpine构建，旨在为容器环境或主机系统提供NFS共享挂载能力。该镜像支持NFS 3和NFS 4协议（通过标签和环境变量配置），兼容数据库（如MariaDB、MySQL）等对文件系统稳定性要求较高的应用场景，可灵活用于手动或自动挂载NFS共享，尤其适合小型操作系统或容器化环境中补充NFS客户端功能。

核心功能和特性

• 多架构支持：适配多种硬件架构，包括linux/amd64、linux/386、linux/arm/v6、linux/arm/v7、linux/arm64/v8、linux/ppc64le、linux/s390x。
• 轻量级：基于Alpine Linux，镜像体积小，资源占用低。
• NFS版本兼容：默认支持NFS 3（latest标签）和NFS 4（v4标签），可通过环境变量切换其他文件系统类型（如cifs、ext4等）。
• 灵活挂载方式：支持手动在主机挂载NFS共享，或自动将共享挂载到容器内供其他容器访问。
• 数据库兼容：优化的启动脚本确保与数据库应用（如MariaDB、MySQL）的文件系统需求兼容。
• 主机网络共享：可通过--net=host模式在主机网络中提供NFS客户端能力，补充小型操作系统的NFS功能。

镜像标签

环境变量

使用场景

1. 主机NFS客户端功能补充：在缺乏NFS客户端的主机（如小型操作系统）上，通过容器提供NFS挂载能力。
2. 容器间共享NFS存储：将NFS共享挂载到nfs-client容器中，通过卷共享给其他容器（如数据库容器）访问。
3. RancherOS自动部署：在RancherOS启动时自动运行，提供NFS客户端支持，实现系统级NFS挂载。
4. 手动灵活挂载：启动容器后手动在主机上挂载任意NFS共享，无需预先配置环境变量。

使用方法

前提条件

• 容器需以特权模式（--privileged=true）运行，以允许挂载操作。
• 若需与主机网络共享NFS客户端能力，需使用--net=host网络模式。

1. 手动在主机上挂载NFS共享

适用于需要在主机上灵活挂载多个NFS共享的场景，无需预先设置SERVER和SHARE。

步骤：

1. 启动nfs-client容器：

   bash
   docker run -itd --privileged=true --net=host --name nfs-client docker.xuanyuan.run/d3fk/nfs-client
   

2. 在主机上执行挂载命令：

   bash
   sudo mount -t nfs <NFS_SERVER_IP>:/<SHARED_PATH> <主机挂载点>
   

   示例（挂载服务器192.168.1.100的/data到主机/mnt/host_nfs）：

   bash
   sudo mount -t nfs 192.168.1.100:/data /mnt/host_nfs
   

2. 将NFS共享挂载到容器中

通过环境变量自动挂载NFS共享到容器，并可通过卷共享给其他容器。

基础命令（无卷共享）

bash
docker run -itd \
  --privileged=true \
  --net=host \
  --name nfs-client \
  -e SERVER=192.168.1.100 \  # NFS服务器IP
  -e SHARE=/data \            # NFS共享路径
  d3fk/nfs-client

带卷共享（推荐）

通过卷将容器内的NFS挂载点共享给主机或其他容器，需添加--volume参数并指定:shared选项（允许卷被多容器共享）。

bash
docker run -itd \
  --privileged=true \
  --net=host \
  --name nfs-client \
  -v /mnt/host_shared:/mnt/nfs-1:shared \  # 主机路径:容器挂载点:shared
  -e SERVER=192.168.1.100 \
  -e SHARE=/data \
  -e MOUNT_OPTIONS="nfsvers=3,rw" \  # 自定义挂载选项（如读写权限）
  d3fk/nfs-client:latest

其他容器使用共享卷：
通过--volume-from复用nfs-client容器的卷：

bash
docker run -itd \
  --name app-container \
  --volume-from docker.xuanyuan.run/nfs-client \ # 共享nfs-client的卷
  nginx  # 示例应用（如Nginx、数据库等）

3. 在RancherOS中启动时自动运行

通过RancherOS的cloud-config配置，在系统启动时自动部署nfs-client容器，实现NFS客户端能力的持久化。

配置示例（cloud-config.yml）

yaml
#cloud-config
rancher:
  services:
    nfs-client:
      image: docker.xuanyuan.run/d3fk/nfs-client:latest
      privileged: true
      net: host
      volumes:
        - /mnt/rancher_nfs:/mnt/nfs-1:shared
      environment:
        - SERVER=192.168.1.100
        - SHARE=/data
        - MOUNT_OPTIONS=nfsvers=3,rw
      restart: always

应用配置

将上述配置添加到RancherOS的启动配置文件（如user-config.yml或cloud-config.yml），系统启动时会自动运行nfs-client容器，并挂载NFS共享。

许可证

本镜像基于MIT许可证开源，详见https://github.com/Angatar/docker-nfs-client/blob/master/LICENSE。

text
The MIT License (MIT)

Copyright (c) 2015 Evey Quirk, Chris Fordham, 2016 d3fk

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.