propelled/deployer

Prøpelled部署工具镜像

镜像概述和主要用途

该镜像为将Prøpelled与现有CI解决方案集成的部署工具，用于简化从CI流程到Prøpelled平台的自动化部署流程。通过配置文件定义部署参数，结合压缩打包与HTTP下载功能，实现项目的便捷部署。

核心功能和特性

• 配置文件支持：通过propelled-deploy.yaml定义部署元数据、公共目录及共享目录等参数
• 压缩打包能力：支持将项目文件压缩为tar.gz格式，便于传输和部署
• HTTP协议部署：支持从HTTP/HTTPS地址下载tar包进行部署，包含认证信息处理
• 环境变量配置：通过环境变量设置Prøpelled部署服务API地址和密钥，保障部署安全

使用场景和适用范围

适用于需要将现有CI流程与Prøpelled部署服务集成的开发团队，尤其适合从版本控制系统（如Bitbucket）下载tar包进行自动化部署的场景，提升CI/CD流程的衔接效率。

使用方法和配置说明

1. 创建部署配置文件

在项目根目录添加propelled-deploy.yaml配置文件，示例如下：

yaml
apiVersion: deployer.propelled.io/v1beta
kind: Deploy
metadata:
  name: XXXXX  # 部署名称，可自定义
  
spec:
  publicDir: web  # 指定项目的公共目录路径
  shared:
  - name: uploads  # 共享目录名称
    path: web/app/uploads  # 共享目录在项目中的具体路径

2. 压缩项目文件

将项目文件压缩为tar.gz格式，命令示例：

bash
tar czf wordpress.tar.gz *
# 将生成的wordpress.tar.gz上传至可访问的下载位置（如代码仓库的下载区）

3. 执行部署命令

使用docker run命令启动部署流程，关键参数说明如下：

环境变量

• PROPELOY_DEPLOYAPI：Prøpelled部署服务API地址
• PROPELOY_DEPLOYAPISECRET：Prøpelled部署服务API密钥

命令行参数

• -type：部署类型，固定为http
• -http.type：HTTP部署模式，此处固定为tar（表示部署tar包）
• -http.url：tar包的HTTP下载地址，支持包含认证信息（格式：https://user:pass@<下载地址>）

部署命令示例

bash
docker run -t \
    -e PROPELOY_DEPLOYAPI=[***] \
    -e PROPELOY_DEPLOYAPISECRET=xxxx \
    propelled/deployer:latest \
    -type=http \
    -http.type "tar" \
    -http.url "[***]"