portworx/talisman

Talisman 镜像文档

1. 镜像概述和主要用途

Talisman是一个专为Kubernetes环境设计的工具镜像，主要用于Portworx集群的管理操作。其核心功能是帮助管理员简化Portworx集群的升级流程和清理操作，适用于需要对Kubernetes集群中部署的Portworx存储系统进行版本升级或资源清理的场景，旨在提升集群管理效率。

2. 核心功能和特性

2.1 核心功能

• Portworx集群升级：支持对Kubernetes环境中的Portworx集群进行版本升级，自动化处理升级过程中的关键步骤。
• Portworx集群清理：提供Portworx集群的清理功能，可安全移除不再使用的Portworx集群资源，避免残留资源占用系统空间。

2.2 主要特性

• Kubernetes原生集成：专为Kubernetes环境设计，可直接在Kubernetes集群中通过Pod或Job运行。
• 操作流程简化：将复杂的Portworx升级和清理操作抽象为标准化流程，降低人工操作复杂度。
• Portworx专项优化：针对Portworx存储系统的特性进行适配，确保操作兼容性和安全性。

3. 使用场景和适用范围

3.1 使用场景

• Portworx版本升级：当需要将Kubernetes集群中的Portworx存储系统升级至新版本时，使用Talisman自动化完成升级流程。
• Portworx集群清理：当Portworx集群不再使用或需要重建时，使用Talisman清理集群相关资源（如存储卷、配置文件、集群元数据等）。

3.2 适用范围

• 环境要求：已部署Portworx作为存储解决方案的Kubernetes集群。
• 用户群体：Kubernetes集群管理员、DevOps工程师、负责Portworx存储管理的运维人员。

4. 使用方法和配置说明

4.1 部署方式

Talisman通常通过Kubernetes Job或Pod在目标集群中运行，以下为典型部署示例：

4.1.1 通过Kubernetes Job运行（推荐）

创建Job配置文件（如talisman-job.yaml）：

yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: talisman-operation
spec:
  template:
    spec:
      containers:
      - name: talisman
        image: <talisman-image-url>  # 替换为实际Talisman镜像地址
        command: ["/talisman"]
        args: ["--operation", "<operation-type>", "--px-cluster-name", "<cluster-name>"]
        env:
        - name: PX_VERSION  # 升级操作时指定目标版本
          value: "<target-version>"
        - name: NAMESPACE  # Portworx部署的命名空间
          value: "portworx"
      restartPolicy: Never

通过kubectl应用配置：

bash
kubectl apply -f talisman-job.yaml

4.2 关键配置参数说明

4.3 操作示例

4.3.1 升级Portworx集群

yaml
# talisman-upgrade-job.yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: talisman-upgrade
spec:
  template:
    spec:
      containers:
      - name: talisman
        image: <talisman-image-url>
        command: ["/talisman"]
        args: ["--operation", "upgrade", "--px-cluster-name", "px-cluster-01"]
        env:
        - name: PX_VERSION
          value: "2.12.0"
        - name: NAMESPACE
          value: "portworx"
      restartPolicy: Never

应用并查看日志：

bash
kubectl apply -f talisman-upgrade-job.yaml
kubectl logs -f job/talisman-upgrade

4.3.2 清理Portworx集群

yaml
# talisman-wipe-job.yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: talisman-wipe
spec:
  template:
    spec:
      containers:
      - name: talisman
        image: <talisman-image-url>
        command: ["/talisman"]
        args: ["--operation", "wipe", "--px-cluster-name", "px-cluster-01"]
        env:
        - name: NAMESPACE
          value: "portworx"
      restartPolicy: Never

应用并查看日志：

bash
kubectl apply -f talisman-wipe-job.yaml
kubectl logs -f job/talisman-wipe

5. 注意事项

• 清理操作（wipe）会永久删除Portworx集群资源，请确保操作前已备份重要数据。
• 升级操作前请确认目标版本与当前Kubernetes集群版本兼容（参考Portworx官方兼容性文档）。
• 运行Talisman的Pod需要具备足够的权限（如访问Portworx API、修改集群资源等），建议配置适当的RBAC权限。