maorfr/cain

Cain

Cain 是 Kubernetes 上的 Cassandra 备份和恢复工具，名称来源于 DC 漫画超级英雄 Cassandra Cain。

Cain 支持以下云存储服务：

• AWS S3
• Minio S3
• Azure Blob Storage
• Google Cloud Storage

Cain 现已成为 Helm https://github.com/helm/charts/tree/master/incubator/cassandra chart 的官方组成部分！

安装

先决条件

1. git
2. https://github.com/golang/dep

从发布版安装

从 https://github.com/maorfr/cain/releases 下载最新版本，或使用 https://hub.docker.com/r/maorfr/cain%E3%80%82

从源码安装

mkdir -p $GOPATH/src/github.com/maorfr && cd $_
git clone https://github.com/maorfr/cain.git && cd cain
make

命令

将 Cassandra 集群备份到云存储

Cain 按以下方式执行备份：

1. 备份 keyspace schema（使用 cqlsh）。
2. 使用 nodetool snapshot 获取备份数据 - 在指定 namespace 中（根据 selector）的所有 Cassandra pod 中创建 keyspace 的快照。
3. 使用 https://github.com/maorfr/skbn 并行复制文件到云存储 - 将文件复制到指定 dst 下的 namespace/<cassandraClusterName>/keyspace/<keyspaceSchemaHash>/tag/ 路径。
4. 清除所有快照。

用法

$ cain backup --help
backup cassandra cluster to cloud storage

Usage:
  cain backup [flags]

Flags:
  -b, --buffer-size float           用于文件复制的内存缓冲区大小（MB，每个文件的缓冲区）。覆盖 $CAIN_BUFFER_SIZE（默认 6.75）
      --cassandra-data-dir string   Cassandra 数据目录。覆盖 $CAIN_CASSANDRA_DATA_DIR（默认 "/var/lib/cassandra/data"）
  -c, --container string            要操作的容器名称。覆盖 $CAIN_CONTAINER（默认 "cassandra"）
      --dst string                  备份目标路径。示例：s3://bucket/cassandra。覆盖 $CAIN_DST
  -k, --keyspace string             要操作的键空间。覆盖 $CAIN_KEYSPACE
  -n, --namespace string            查找 Cassandra 集群的命名空间。覆盖 $CAIN_NAMESPACE（默认 "default"）
  -p, --parallel int                并行复制的文件数量。设为 0 表示完全并行。覆盖 $CAIN_PARALLEL（默认 1）
  -l, --selector string             用于过滤的选择器。覆盖 $CAIN_SELECTOR（默认 "app=cassandra"）

示例

备份到 AWS S3

cain backup \
    -n default \
    -l release=cassandra \
    -k keyspace \
    --dst s3://db-backup/cassandra

备份到 Azure Blob Storage

cain backup \
    -n default \
    -l release=cassandra \
    -k keyspace \
    --dst abs://my-account/db-backup-container/cassandra

备份到 Google Cloud Storage

cain backup \
    -n default \
    -l release=cassandra \
    -k keyspace \
    --dst gcs://db-backup/cassandra

从云存储恢复 Cassandra 备份

Cain 按以下方式执行恢复：

1. 如果指定了 schema，则恢复 schema。
2. 截断 keyspace 中的所有表。
3. 从指定 src（位于 keyspace/<keyspaceSchemaHash>/tag/ 下）复制文件 - 仅支持恢复相同键空间 schema 的备份。
4. 使用 nodetool refresh 加载新数据。

用法

$ cain restore --help
restore cassandra cluster from cloud storage

Usage:
  cain restore [flags]

Flags:
  -b, --buffer-size float           用于文件复制的内存缓冲区大小（MB，每个文件的缓冲区）。覆盖 $CAIN_BUFFER_SIZE（默认 6.75）
      --cassandra-data-dir string   Cassandra 数据目录。覆盖 $CAIN_CASSANDRA_DATA_DIR（默认 "/var/lib/cassandra/data"）
  -c, --container string            要操作的容器名称。覆盖 $CAIN_CONTAINER（默认 "cassandra"）
  -k, --keyspace string             要操作的键空间。覆盖 $CAIN_KEYSPACE
  -n, --namespace string            查找 Cassandra 集群的命名空间。覆盖 $CAIN_NAMESPACE（默认 "default"）
  -p, --parallel int                并行复制的文件数量。设为 0 表示完全并行。覆盖 $CAIN_PARALLEL（默认 1）
  -s, --schema string               要恢复的 schema 版本（可选）。覆盖 $CAIN_SCHEMA
  -l, --selector string             用于过滤的选择器。覆盖 $CAIN_SELECTOR（默认 "app=cassandra"）
      --src string                  恢复源路径。示例：s3://bucket/cassandra/namespace/cluster-name。覆盖 $CAIN_SRC
  -t, --tag string                  要恢复的标签。覆盖 $CAIN_TAG
      --user-group string           应拥有恢复文件的用户和组。覆盖 $CAIN_USER_GROUP（默认 "cassandra:cassandra"）

示例

从 S3 恢复

cain restore \
    --src s3://db-backup/cassandra/default/ring01 \
    -n default \
    -k keyspace \
    -l release=cassandra \
    -t 20180903091624

从 Azure Blob Storage 恢复

cain restore \
    --src abs://my-account/db-backup-container/cassandra/default/ring01 \
    -n default \
    -k keyspace \
    -l release=cassandra \
    -t 20180903091624

从 Google Cloud Storage 恢复

cain restore \
    --src gcs://db-backup/cassandra/default/ring01 \
    -n default \
    -k keyspace \
    -l release=cassandra \
    -t 20180903091624

描述键空间 schema

Cain 使用 cqlsh 描述 keyspace schema。可返回 schema 本身或 schema 文件的校验和（供 backup 和 restore 使用）。

用法

$ cain schema --help
get schema of cassandra cluster

Usage:
  cain schema [flags]

Flags:
  -c, --container string   要操作的容器名称。覆盖 $CAIN_CONTAINER（默认 "cassandra"）
  -k, --keyspace string    要操作的键空间。覆盖 $CAIN_KEYSPACE
  -n, --namespace string   查找 Cassandra 集群的命名空间。覆盖 $CAIN_NAMESPACE（默认 "default"）
  -l, --selector string    用于过滤的选择器。覆盖 $CAIN_SELECTOR（默认 "app=cassandra"）
      --sum                仅打印校验和。覆盖 $CAIN_SUM

示例

cain schema \
    -n default \
    -l release=cassandra \
    -k keyspace

cain schema \
    -n default \
    -l release=cassandra \
    -k keyspace \
    --sum

环境变量支持

Cain 命令支持使用环境变量代替标志。例如： backup 命令可按示例执行：

cain backup \
    -n default \
    -l release=cassandra \
    -k keyspace \
    --dst s3://db-backup/cassandra

也可设置相应环境变量（CAIN_FLAG，使用下划线代替连字符）：

export CAIN_NAMESPACE=default
export CAIN_SELECTOR=release=cassandra
export CAIN_KEYSPACE=keyspace
export CAIN_DST=s3://db-backup/cassandra

cain backup

额外存储服务支持

由于 Cain 使用 https://github.com/maorfr/skbn%EF%BC%8C%E6%B7%BB%E5%8A%A0%E5%AF%B9%E9%A2%9D%E5%A4%96%E5%AD%98%E5%82%A8%E6%9C%8D%E5%8A%A1%E7%9A%84%E6%94%AF%E6%8C%81%E9%9D%9E%E5%B8%B8%E7%AE%80%E5%8D%95%E3%80%82%E9%98%85%E8%AF%BB 这篇文章 了解更多信息。

Skbn 兼容性矩阵

凭证

Kubernetes

Cain 按以下顺序获取凭证：

1. 如果设置了 KUBECONFIG 环境变量 - Cain 将使用该配置文件中的当前上下文
2. 如果 ~/.kube/config 存在 - Cain 将使用该配置文件中的当前上下文，采用 https://github.com/kubernetes/client-go/tree/master/examples/out-of-cluster-client-configuration
3. 如果 ~/.kube/config 不存在 - Cain 将假设在 pod 内运行，并使用 https://github.com/kubernetes/client-go/tree/master/examples/in-cluster-client-configuration

AWS

Cain 使用默认的 AWS 凭证链。

Azure Blob Storage

Cain 使用 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量进行身份验证。

Google Cloud Storage

Cain 使用 Google 应用默认凭证。 主要流程：首先查找 GOOGLE_APPLICATION_CREDENTIALS 环境变量；如果未定义，将查找默认服务账户，若未配置则抛出错误。

示例

1. Helm 示例
2. 代码示例