longhornio/longhorn-cli

Longhorn CLI 镜像文档

镜像概述

Longhorn CLI镜像封装了用于管理Longhorn分布式块存储系统的命令行工具（lhctl），基于轻量级Linux环境构建，提供与Longhorn API的交互能力。该镜像旨在简化Kubernetes环境中Longhorn存储资源的管理流程，支持通过命令行执行存储卷生命周期管理、备份操作、集群监控等任务，适用于自动化运维与存储管理场景。

核心功能与特性

存储卷管理

• 创建、删除、挂载/卸载存储卷
• 在线扩容卷容量与调整副本数量
• 查看卷详细信息（状态、大小、副本分布等）
• 迁移卷至指定节点或调整调度策略

备份与恢复

• 创建、删除卷备份
• 从备份恢复创建新卷
• 管理备份目标（支持S3、NFS等存储后端）
• 查看备份历史与状态

集群监控

• 查询集群整体健康状态与存储使用率
• 监控节点、引擎、副本运行状态
• 查看卷IO性能指标（吞吐量、IOPS、延迟）

配置管理

• 查看/修改Longhorn全局设置（如默认备份策略、存储网络）
• 管理存储类与回收策略
• 配置访问控制权限与API认证

使用场景

• 自动化运维脚本：通过CLI命令编写Shell/Python脚本，实现存储卷创建、备份等操作的批量自动化
• CI/CD流程集成：在应用部署流水线中自动创建/清理测试环境存储卷
• 集群故障排查：快速查询卷状态、副本分布，定位存储相关故障
• 存储资源审计：生成卷使用报告，监控存储容量趋势

使用方法与配置说明

前置条件

1. Kubernetes集群已部署Longhorn（v1.2.0+推荐）
2. 环境已配置kubectl（具备集群管理员权限）
3. Longhorn API服务可访问（默认地址：http://longhorn-backend.longhorn-system.svc.cluster.local:9500）

获取镜像

bash
# 获取最新版本
docker pull longhornio/longhorn-cli:latest

# 获取指定版本（推荐生产环境使用）
docker pull longhornio/longhorn-cli:v1.6.0

基本命令示例

1. 认证与登录

Longhorn CLI默认通过Kubernetes ServiceAccount令牌认证，需挂载kubectl配置：

bash
docker run --rm -v $HOME/.kube/config:/root/.kube/config longhornio/longhorn-cli:latest lhctl auth login

2. 查看存储卷列表

bash
docker run --rm -v $HOME/.kube/config:/root/.kube/config longhornio/longhorn-cli:latest lhctl volume list

3. 创建存储卷

创建10GiB、2个副本的卷：

bash
docker run --rm -v $HOME/.kube/config:/root/.kube/config longhornio/longhorn-cli:latest \
  lhctl volume create my-volume --size 10Gi --replica-count 2

4. 扩容存储卷

将卷扩容至20GiB：

bash
docker run --rm -v $HOME/.kube/config:/root/.kube/config longhornio/longhorn-cli:latest \
  lhctl volume expand my-volume --size 20Gi

环境变量配置

Docker Run示例

bash
docker run -it --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  -e LONGHORN_URL="http://longhorn-backend.longhorn-system.svc.cluster.local:9500" \
  -e LHCTL_OUTPUT_FORMAT="json" \
  longhornio/longhorn-cli:latest \
  lhctl volume list

Docker Compose配置示例

yaml
version: '3'
services:
  longhorn-cli:
    image: longhornio/longhorn-cli:v1.6.0
    volumes:
      - $HOME/.kube/config:/root/.kube/config
    environment:
      - LONGHORN_URL=http://longhorn-backend.longhorn-system.svc.cluster.local:9500
      - LHCTL_OUTPUT_FORMAT=json
    command: lhctl volume list

注意事项

• 生产环境建议使用固定版本标签（如v1.6.0）确保兼容性
• 执行删除/恢复等敏感操作前，建议通过--dry-run参数验证
• 集群内使用可通过kubectl run创建临时交互Pod：

  bash
  kubectl run longhorn-cli --image=longhornio/longhorn-cli:v1.6.0 --rm -it -- sh