maorfr/orca

Orca

!orca logo


镜像概述和主要用途

Orca是一款高级CI/CD工具，专注于Kubernetes、Helm及CI/CD领域，同时在日常工作中也十分实用。它是一个简化器——将复杂任务转化为易于完成的操作。需要注意的是，Orca并非旨在替代Helm，而是增强Helm并实现简单的高级用法。

核心功能和特性

• 环境管理：将Kubernetes命名空间与一组已安装的Helm图表视为一个环境进行管理
• 动态环境创建：支持基于现有环境（如生产环境）快速创建新环境，可覆盖特定服务版本
• 静态环境维护：轻松部署和更新具有不同配置的环境，适用于多版本产品支持
• 环境状态跟踪：以Markdown或YAML格式导出环境中已安装的Helm图表列表，便于文档记录
• 灾难恢复支持：导出环境状态并保存，可在紧急情况下快速恢复配置
• 并行部署：支持指定图表部署的并行度，提高部署效率
• 环境锁定：部署时通过命名空间注解实现环境锁定，避免并发冲突
• 环境变量支持：可使用环境变量替代大多数命令行标志，简化CI/CD配置

使用场景和适用范围

动态环境创建（例如作为拉取请求的一部分）

• 基于"稳定"环境（如生产环境）配置创建测试环境
• 为单个服务或跨多个服务的功能测试创建隔离环境
• 在多个服务的CI/CD流程中协作更新同一测试环境，保护特定服务版本

静态环境管理

• 支持多版本产品，无需为所有服务持续维护CI/CD流程
• 通过单个charts.yaml文件管理环境配置，便于更新和部署

环境状态跟踪与文档

• 记录环境变更，触发事件时获取当前环境状态
• 生成Markdown格式的环境状态报告，用于文档或审计

灾难恢复准备

• 定期导出环境状态到文件并纳入版本控制
• 紧急情况下使用导出的配置快速恢复环境

详细使用方法和配置说明

前提条件

1. git
2. https://github.com/golang/dep
3. Helm（env和chart子命令需要）
4. https://github.com/helm/charts/tree/master/stable/chartmuseum%E6%88%96%E5%85%B6%E4%BB%96%E5%9B%BE%E8%A1%A8%E4%BB%93%E5%BA%93%E5%AE%9E%E7%8E%B0%EF%BC%88%60deploy%60%E5%91%BD%E4%BB%A4%E9%9C%80%E8%A6%81%EF%BC%89

安装方式

从发布版安装

从https://github.com/maorfr/orca/releases%E4%B8%8B%E8%BD%BD%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%EF%BC%8C%E6%88%96%E5%9C%A8CI/CD%E6%B5%81%E7%A8%8B%E4%B8%AD%E4%BD%BF%E7%94%A8https://hub.docker.com/r/maorfr/orca%E3%80%82

从源码安装

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

注意：master分支和latest Docker镜像为不稳定版本。如需稳定且经过测试的版本，请使用带标签的发布版或带标签的Docker镜像。

基本使用示例

1. 创建动态环境：从稳定环境部署到新环境

bash
# 获取源环境配置
orca get env --name $SRC_NS --kube-context $SRC_KUBE_CONTEXT > charts.yaml

# 部署到目标环境
orca deploy env --name $DST_NS -c charts.yaml \
    --kube-context $DST_KUBE_CONTEXT \
    --repo myrepo=$REPO_URL

附加标志：

• -p：指定图表部署的并行度
• -f：指定部署时使用的不同值文件
• -s：设置额外参数
• 多次使用-c：指定多个图表文件，从左到右合并（当前仅合并版本字段）

2. 创建动态环境：带覆盖和环境刷新

bash
orca get env --name $SRC_NS --kube-context $SRC_KUBE_CONTEXT > charts.yaml
orca deploy env --name $DST_NS -c charts.yaml \
    --kube-context $DST_KUBE_CONTEXT \
    --repo myrepo=$REPO_URL \
    --override $CHART_NAME=$CHART_VERSION \
    --protected-chart $CHART_NAME

特性：

• 部署"稳定"环境配置，但指定的覆盖图表使用CHART_VERSION版本
• 为指定图表设置保护注解，仅允许自身覆盖
• 若参考环境在部署期间发生变化，新环境将同步更新
• 通过命名空间"busy"注解实现环境锁定，避免并发冲突

3. 创建动态环境：带覆盖且无环境刷新

bash
orca get env --name $SRC_NS --kube-context $SRC_KUBE_CONTEXT > charts.yaml
orca deploy env --name $DST_NS -c charts.yaml \
    --kube-context $DST_KUBE_CONTEXT \
    --repo myrepo=$REPO_URL \
    --override $CHART_NAME=$CHART_VERSION \
    -x

特性：

• 初始部署"稳定"环境配置
• 环境已存在时，仅部署指定的覆盖图表
• 参考环境变化不会更新新环境

4. 静态环境管理

bash
# CI/CD流程示例
orca deploy env --name $NS -c charts.yaml \
    --kube-context $KUBE_CONTEXT \
    --repo myrepo=$REPO_URL

5. 环境状态跟踪

bash
# 以Markdown格式输出环境状态
orca get env --name $SRC_NS --kube-context $SRC_KUBE_CONTEXT -o md

6. 灾难恢复准备

bash
# 导出环境状态到文件
orca get env --name $NS --kube-context $KUBE_CONTEXT -o yaml > charts.yaml

环境变量支持

Orca命令支持使用环境变量替代大多数标志。例如：

命令行方式：

bash
orca get env \
    --kube-context <kubeContext> \
    --name <namespace>

环境变量方式：

bash
export ORCA_KUBE_CONTEXT=<kubeContext>
export ORCA_NAME=<namespace>

orca get env

命令说明

Orca作为CI/CD工具，提供以下命令帮助完成常见操作：

• deploy artifact：部署制品到Artifactory
• deploy chart：从图表仓库部署Helm图表
• push chart：推送Helm图表到图表仓库
• get env：获取环境（Kubernetes命名空间）中的Helm发布列表
• deploy env：从图表仓库部署Helm图表列表到环境（Kubernetes命名空间）
• delete env：删除环境（Kubernetes命名空间）及其所有Helm发布
• diff env：显示环境（Kubernetes命名空间）之间Helm发布的差异
• lock env：锁定环境（Kubernetes命名空间）
• unlock env：解锁环境（Kubernetes命名空间）
• validate env：验证环境（Kubernetes命名空间）
• create resource：通过REST API创建或更新资源
• get resource：通过REST API获取资源
• delete resource：通过REST API删除资源
• determine buildtype：基于路径过滤器确定构建类型

有关所有命令的详细说明，请参见命令文档部分。

示例

请查看示例文档部分获取更多使用案例！

参考资料

• The Nuvo Group CI\CD journey
• Dynamic Kubernetes Environments with Orca