obeoneorg/nfs-server

obeone/nfs-server（从erichough/nfs-server分叉）

https://github.com/obeone/docker-nfs-server/actions/workflows/build-and-push-v2.yaml/badge.svg?branch=main&event=push](https://github.com/obeone/docker-nfs-server/actions/workflows/build-and-push-v2.yaml)

轻量级、健壮、灵活的容器化NFS服务器。

https://github.com/obeone/docker-nfs-server/pkgs/container/nfs-server%EF%BC%8C%E5%B9%B6%E4%B8%94%E6%B8%85%E5%8D%95%E5%B7%B2%E4%BD%BF%E7%94%A8cosign%E7%AD%BE%E5%90%8D%EF%BC%81

https://github.com/obeone/charts/tree/main/charts/nfs-server%EF%BC%8C%E4%BE%BF%E4%BA%8E%E5%9C%A8Kubernetes%E4%B8%8A%E9%83%A8%E7%BD%B2

为什么选择此镜像？

这是唯一提供以下所有特性的容器化NFS服务器：

• 小型（约15MB）Alpine Linux镜像
• 同时支持NFS版本3、4或两者
• 终止时服务的干净拆除（Docker主机上没有残留的nfsd进程）
• 灵活构建/etc/exports
• 通过环境变量进行广泛的服务器配置
• 人类可读的日志（带有有用的https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/logging.md%EF%BC%89
• 可选附加功能
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/kerberos.md
  • 通过idmapd实现https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/apparmor.md%E5%85%BC%E5%AE%B9%E6%80%A7

此分叉版本添加了以下特性：

• 支持架构：linux/amd64、linux/arm64、linux/i386、linux/armhf、linux/armel
• 每日构建以保持与上游发行版（alpine）同步

目录

• 要求
• 使用方法
  • 启动服务器
  • Docker部署方案示例
  • 从客户端挂载文件系统
• 可选特性
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/logging.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/kerberos.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/apparmor.md
• 高级功能
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/ports.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/nfs-versions.md
  • https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/performance-tuning.md
• 帮助！
• 剩余任务
• 致谢

要求

1. Docker 主机内核需要以下内核模块

   • nfs
   • nfsd
   • rpcsec_gss_krb5（仅在使用Kerberos时需要）

   您可以在Docker主机上手动启用这些模块：

   modprobe {nfs,nfsd,rpcsec_gss_krb5}

   或者您可以允许容器https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md%E3%80%82

2. 容器需要使用CAP_SYS_ADMIN（或--privileged）运行。这是必要的，因为服务器需要在容器内挂载多个文件系统以支持其操作，而没有这些功能，从容器内部执行挂载是不可能的。

3. 容器需要本地访问您希望通过NFS提供的文件。您可以使用Docker卷、绑定挂载、烘焙到自定义镜像中的文件，或几乎任何其他向Docker容器提供文件的方式。

使用方法

启动服务器

启动ghcr.io/obeone/nfs-server镜像将启动NFS服务器。您需要在容器启动时提供一些信息，基本的docker run命令可能如下所示：

docker run                                            \
  -v /host/path/to/shared/files:/some/container/path  \
  -v /host/path/to/exports.txt:/etc/exports:ro        \
  --cap-add SYS_ADMIN                                 \
  -p 2049:2049                                        \
  ghcr.io/obeone/nfs-server

启动服务器需要以下几个关键部分：

1. 提供要通过NFS共享的文件：使用绑定挂载、卷或自定义镜像提供文件
2. 提供NFS导出配置：通过挂载/etc/exports文件、环境变量或自定义镜像提供
3. 提供必要权限：使用--cap-add SYS_ADMIN或--privileged
4. 暴露端口：根据NFS版本暴露相应端口

Docker部署方案示例

基本NFSv4服务器部署

bash
docker run \
  -v /host/data:/data \
  -e NFS_EXPORT_0='/data *(rw,no_subtree_check,fsid=0)' \
  --cap-add SYS_ADMIN \
  -p 2049:2049 \
  ghcr.io/obeone/nfs-server

支持NFSv3的完整部署

bash
docker run \
  -v /host/shared:/shared \
  -e NFS_EXPORT_0='/shared 192.168.1.0/24(rw,no_subtree_check)' \
  --cap-add SYS_ADMIN \
  -p 2049:2049 -p 2049:2049/udp \
  -p 111:111 -p 111:111/udp \
  -p 32765:32765 -p 32765:32765/udp \
  -p 32767:32767 -p 32767:32767/udp \
  ghcr.io/obeone/nfs-server

使用自定义exports文件部署

bash
# 首先创建exports.txt文件
echo '/data 10.0.0.0/8(rw,no_root_squash,no_subtree_check)' > exports.txt

# 运行容器
docker run \
  -v /host/data:/data \
  -v $(pwd)/exports.txt:/etc/exports:ro \
  --cap-add SYS_ADMIN \
  -p 2049:2049 \
  ghcr.io/obeone/nfs-server

从客户端挂载文件系统

# mount <container-IP>:/some/export /some/local/path

可选特性

• https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/logging.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/kerberos.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/apparmor.md

高级功能

• https://github.com/obeone/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/ports.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/nfs-versions.md
• https://github.com/obeone/docker-nfs-server/blob/develop/doc/advanced/performance-tuning.md

帮助！

如果您有任何问题、建设性的批评或无法使某些功能正常工作，请https://github.com/obeone/docker-nfs-server/issues%E3%80%82

剩余任务

• 弄清楚为什么rpc.nfsd 需要5分钟才能启动/超时，除非rpcbind正在运行
• 添加更多示例

致谢

这项工作基于先前的项目：

• https://github.com/f-u-z-z-l-e/docker-nfs-server
• https://github.com/sjiveson/nfs-server-alpine
• https://github.com/ehough/docker-nfs-server

参见https://github.com/obeone/docker-nfs-server