mdneuzerling/plumber-on-k8s

Plumber on Kubernetes

这是博客文章《Hosting a Plumber API with Kubernetes》（链接：[***]

Kubernetes基础架构

容器的理解

Kubernetes的核心概念是容器。将应用及其运行所需的软件打包成一个容器，即可在未安装该应用或依赖的机器上运行。例如，Rocker项目提供包含R或RStudio的容器，无需本地安装即可使用。最常用的容器创建与运行工具是Docker。

容器解决了诸多问题：可打包R脚本与依赖包的精确版本以实现可复现分析；通过Plumber将R脚本转为API并放入容器，运行容器即可托管API；同一机器可运行多个容器（即使应用无关），如同时运行依赖R 3.6和4.0的应用。

大规模容器运行

Kubernetes针对多容器运行的复杂性设计。用户只需描述期望的系统状态（如“始终运行3个容器A和2个容器B”），Kubernetes会尽力实现。

Kubernetes通常运行在多机器集群上，可在多机器上运行同一容器的副本（replicas）以分担负载或实现故障冗余。容器被视为临时且可替换的，便于应对需求激增时的扩容。

Kubernetes的层级结构：

• 节点（Node）：运行容器的机器（如树莓派、服务器或云虚拟机）。
• 控制平面（Control Plane）：至少一个节点包含控制平面，负责协调容器；其他节点为工作节点（Worker Node），运行容器。
• Pod：容器的分组单位。相互依赖的容器可在同一Pod中运行，独立容器也可单独运行一个Pod。用户实际配置的是Pod而非容器。

文件说明

创建API

Plumber API包含两个文件：

• plumber.R：实现基础API端点：
  • /parity：判断整数奇偶性
  • /wait：等待5秒后返回格式化当前时间
  • /fail：将alive全局变量设为FALSE
  • /quit：执行quit()退出API进程
  • /health：若alive为TRUE返回"OK"，否则抛出错误
• entrypoint.R：加载依赖并运行Plumber API，可通过Rscript entrypoint.R执行

创建Docker镜像

Dockerfile用于构建运行entrypoint.R并暴露8000端口的镜像。构建命令：

bash
docker build -t mdneuzerling/plumber-on-k8s <文件所在目录>

运行镜像命令：

bash
docker run -p 8000:8000 docker.xuanyuan.run/mdneuzerling/plumber-on-k8s

镜像可托管于Docker Hub等容器仓库。

部署API

Kubernetes通过YAML文件配置期望状态。该API需以下配置：

• deployment.yaml：配置Kubernetes集群上的部署，包含3个镜像副本，并通过/health端点配置存活与就绪探针
• service.yaml：实现对部署中Pod的8000端口的服务暴露
• ingress.yaml：将服务暴露到外部，以便查询API（本地部署需考虑防火墙设置）

应用YAML文件命令：

bash
kubectl apply -f https://raw.githubusercontent.com/mdneuzerling/plumber-on-k8s/main/deployment.yaml