kdeploy 0.1.0 → 0.3.0

data/exe/kdeploy

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "kdeploy"
+
+Kdeploy::CLI.start(ARGV)

data/k.md

@@ -0,0 +1,149 @@
+以下是将 Kdeploy 项目的开发需求整理成的标准 Markdown 格式文档，可保存为 `dev_requirements.md`：
+
+---
+
+```markdown
+# 📦 Kdeploy 开发需求文档
+
+> **项目名称**：Kdeploy
+> **项目类型**：Ruby Gem
+> **定位**：轻量级 agentless 运维部署工具
+> **灵感来源**：Ansible、Chef、Puppet
+> **目标用户**：DevOps、SRE、系统运维工程师
+
+---
+
+## 🧭 项目目标
+
+- 提供 **无 agent** 的远程部署解决方案
+- 使用 **优雅的 Ruby DSL** 编写部署任务
+- 支持任务的 **并发执行**
+- 能够进行任务 **状态统计与结果输出**
+- 管理 **完整的部署生命周期**（准备、执行、清理、回滚等）
+- 简洁、轻量、便于嵌入其他工具链
+- 可支持 **多主机、多环境配置管理**
+
+---
+
+## 📁 项目结构
+
+```
+
+kdeploy/
+├── bin/
+│   └── kdeploy             # 主执行文件
+├── lib/
+│   ├── kdeploy/
+│   │   ├── dsl.rb          # DSL 定义
+│   │   ├── executor.rb     # 并发执行器
+│   │   ├── inventory.rb    # 主机清单管理
+│   │   ├── lifecycle.rb    # 生命周期管理
+│   │   ├── logger.rb       # 日志与输出
+│   │   └── version.rb
+│   └── kdeploy.rb          # 主入口
+├── tasks/
+│   └── deploy.rb           # 示例任务（用户自定义）
+├── spec/
+│   └── kdeploy\_spec.rb     # RSpec 测试
+├── kdeploy.gemspec
+└── README.md
+
+````
+
+---
+
+## 🔧 功能模块设计
+
+### 1. DSL 任务定义
+
+```ruby
+host 'web01', user: 'ubuntu', ip: '10.0.0.1'
+
+task :deploy_web do
+  run 'sudo systemctl stop nginx'
+  upload './nginx.conf', '/etc/nginx/nginx.conf'
+  run 'sudo systemctl start nginx'
+end
+````
+
+### 2. 并发执行器
+
+* 线程池并发执行远程任务
+* 自动记录成功/失败状态
+* 支持最大并发数限制
+
+### 3. 生命周期管理
+
+* `prepare`：初始化（如环境检查）
+* `run`：主要任务执行
+* `cleanup`：清理临时文件或状态
+* `rollback`：失败回滚（可选）
+
+### 4. 主机清单
+
+支持静态或动态清单，如：
+
+```ruby
+inventory do
+  host 'web01', user: 'ubuntu', ip: '10.0.0.1'
+  host 'db01', user: 'root', ip: '10.0.0.2'
+end
+```
+
+### 5. 输出日志与状态统计
+
+* 控制台美化输出（使用 `pastel`、`tty-table` 等）
+* 最终报告：执行成功/失败主机、任务耗时、回滚信息等
+
+---
+
+## 🖥️ 命令行工具设计
+
+执行文件：`bin/kdeploy`
+
+```bash
+kdeploy run tasks/deploy.rb --limit web01,web02 --parallel 5 --dry-run
+```
+
+| 参数            | 说明            |
+| ------------- | ------------- |
+| `run`         | 执行某个 DSL 任务文件 |
+| `--limit`     | 限定主机          |
+| `--parallel`  | 设置并发线程数       |
+| `--dry-run`   | 预览任务，不真正执行    |
+| `--rollback`  | 启动回滚          |
+| `--inventory` | 使用特定主机清单文件    |
+
+---
+
+## 🧩 可扩展性设计
+
+* 支持插件机制：可注册自定义任务类型
+* 可支持其他协议（如 WinRM、Docker、Kubernetes 等）
+* 日后可支持多环境配置（dev/stage/prod）
+* 支持本地/远程日志聚合
+
+---
+
+## 📦 开发计划建议
+
+| 阶段         | 内容                                        |
+| ---------- | ----------------------------------------- |
+| 1️⃣ 初始化    | 使用 `bundle gem .` 生成项目骨架，添加执行文件     |
+| 2️⃣ DSL 实现 | 定义基本任务语法（`host`, `task`, `run`, `upload`） |
+| 3️⃣ SSH 执行 | 实现基础 SSH 执行器（使用 `net-ssh`）                |
+| 4️⃣ 并发执行   | 引入线程池或 `concurrent-ruby`                  |
+| 5️⃣ 生命周期   | 支持 prepare/run/cleanup/rollback 阶段        |
+| 6️⃣ 状态统计   | 记录执行状态并输出汇总表                              |
+| 7️⃣ CLI 工具 | 实现 `bin/kdeploy` 命令入口                     |
+| 8️⃣ 测试与发布  | 使用 RSpec 添加测试，推送到 RubyGems                |
+
+---
+
+## 📝 初始化命令
+
+```bash
+bundle gem . --test=rspec --mit --coc --no-ext
+```
+
+

data/lib/kdeploy/banner.rb

@@ -1,28 +1,58 @@
 # frozen_string_literal: true
 
+require 'pastel'
+
 module Kdeploy
-  # Banner module for displaying ASCII art banner
   module Banner
     class << self
       def show
-        puts banner.colorize(:light_blue)
-      end
+        pastel = Pastel.new
+        <<~BANNER.freeze
+          #{pastel.bright_blue(ASCII_LOGO)}
 
-      private
+          #{pastel.bright_yellow('⚡')} #{pastel.bright_white('Lightweight Agentless Deployment Tool')}
+          #{pastel.bright_yellow('🚀')} #{pastel.bright_white('Deploy with confidence, scale with ease')}
 
-      def banner
-        <<~BANNER
-                    _            _
-            /\\ /\\__| | ___ _ __ | | ___  _   _
-           / //_/ _` |/ _ \\ '_ \\| |/ _ \\| | | |
-          / __ \\ (_| |  __/ |_) | | (_) | |_| |
-          \\/  \\/\\__,_|\\___| .__/|_|\\___/ \\__, |
-                          |_|            |___/
+          =====================================================================================================
 
-            ⚡ Lightweight Agentless Deployment Tool
-            🚀 Deploy with confidence, scale with ease
         BANNER
       end
+
+      def show_version
+        pastel = Pastel.new
+        <<~VERSION
+          #{show}
+          #{pastel.bright_white("Version: #{VERSION}")}
+
+        VERSION
+      end
+
+      def show_error(message)
+        pastel = Pastel.new
+        <<~ERROR
+          #{show}
+          #{pastel.red("Error: #{message}")}
+
+        ERROR
+      end
+
+      def show_success(message)
+        pastel = Pastel.new
+        <<~SUCCESS
+          #{show}
+          #{pastel.green("Success: #{message}")}
+
+        SUCCESS
+      end
+
+      ASCII_LOGO = <<~'LOGO'
+                  _            _
+          /\ /\__| | ___ _ __ | | ___  _   _
+         / //_/ _` |/ _ \ '_ \| |/ _ \| | | |
+        / __ \ (_| |  __/ |_) | | (_) | |_| |
+        \/  \/\__,_|\___| .__/|_|\___/ \__, |
+                        |_|            |___/
+      LOGO
     end
   end
 end