kdeploy 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfcdcad209af73c3d5cb1d272a49a9e8c5cabf784616b3f05c43c1c75b4fef25
-  data.tar.gz: 8583a28f2a36e460a64617beb30f8b1e1054f649d8188ba15ab9b989bd2e5269
+  metadata.gz: acdfc170983f536cbc11351f4bcc1c55d3eae2c0c11fd00e245b1de8fb27023e
+  data.tar.gz: 01cb5edb4625625bd39ce011b4c658fa04d38c54e58745b51fec6f86f81186d0
 SHA512:
-  metadata.gz: 6f6f3409c9932e9d9477ab07a3966dfa254883f2324c2e6a9e409a30e1c54506e4aca9f9dc868de1ff3f4ec56d9b56fc64027b24ac9809a762184938211cd132
-  data.tar.gz: d6ed8e62f6bb0b74360aee9214714eedbffbb4329cea170248c0f53c045eab2a882e46134172d71d0721eaf466710b0a86af585f3e0c7ebc88078446b2441c23
+  metadata.gz: 5cf3bcbaf739597384afbf38223d7ceae24a7dbe0519563c56de1fe00dcdd709ada2f49e6529edf8eb405c45240fa459cd9da6d84558f00d217931d9f5a6d93c
+  data.tar.gz: 3534c6c126d01c89836bcad4bdb7293552911ab7ddbb285ad23bf7a8ab39ac40ff759be894fcc6a36599f0f11549b0e2f19388a20b370f70a9e53f9feca10ffb

data/README.md

@@ -259,6 +259,13 @@ host "web03",
   ip: "10.0.0.3",
   key: "~/.ssh/id_rsa",
   port: 2222
+
+# 使用 sudo 的主机（所有命令自动使用 sudo）
+host "web04",
+  user: "ubuntu",
+  ip: "10.0.0.4",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true
 ```
 
 #### 主机配置选项
@@ -270,6 +277,8 @@ host "web03",
 | `key` | String | 否* | SSH 私钥文件路径 |
 | `password` | String | 否* | SSH 密码 |
 | `port` | Integer | 否 | SSH 端口（默认: 22） |
+| `use_sudo` | Boolean | 否 | 是否对所有命令自动使用 sudo（默认: false） |
+| `sudo_password` | String | 否 | sudo 密码（如果需要密码验证） |
 
 \* 身份验证需要 `key` 或 `password` 之一。
 
@@ -394,6 +403,44 @@ run <<~SHELL
 SHELL
 ```
 
+**参数:**
+- `command`: 要执行的命令字符串
+- `sudo`: 布尔值，是否使用 sudo 执行此命令（可选，默认: nil，继承主机配置）
+
+**sudo 使用方式:**
+
+1. **在主机级别配置**（所有命令自动使用 sudo）:
+```ruby
+host "web01",
+  user: "ubuntu",
+  ip: "10.0.0.1",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true  # 所有命令自动使用 sudo
+```
+
+2. **在命令级别配置**（仅特定命令使用 sudo）:
+```ruby
+task :deploy do
+  run "systemctl restart nginx", sudo: true  # 仅此命令使用 sudo
+  run "echo 'Deployed'"  # 此命令不使用 sudo
+end
+```
+
+3. **使用 sudo 密码**（如果需要密码验证）:
+```ruby
+host "web01",
+  user: "ubuntu",
+  ip: "10.0.0.1",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true,
+  sudo_password: "your-sudo-password"  # 仅在需要密码时配置
+```
+
+**注意:**
+- 如果命令已经以 `sudo` 开头，工具不会重复添加
+- 推荐使用 NOPASSWD 配置 sudo，避免在配置文件中存储密码
+- 命令级别的 `sudo` 选项会覆盖主机级别的 `use_sudo` 配置
+
 **最佳实践**: 对多行命令使用 heredoc (`<<~SHELL`) 以提高可读性。
 
 #### `upload` - 上传文件

data/README_EN.md

@@ -259,6 +259,13 @@ host "web03",
   ip: "10.0.0.3",
   key: "~/.ssh/id_rsa",
   port: 2222
+
+# Host with sudo (all commands automatically use sudo)
+host "web04",
+  user: "ubuntu",
+  ip: "10.0.0.4",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true
 ```
 
 #### Host Configuration Options
@@ -270,6 +277,8 @@ host "web03",
 | `key` | String | No* | Path to SSH private key file |
 | `password` | String | No* | SSH password |
 | `port` | Integer | No | SSH port (default: 22) |
+| `use_sudo` | Boolean | No | Automatically use sudo for all commands (default: false) |
+| `sudo_password` | String | No | sudo password (if password authentication is required) |
 
 \* Either `key` or `password` is required for authentication.
 
@@ -394,6 +403,44 @@ run <<~SHELL
 SHELL
 ```
 
+**Parameters:**
+- `command`: Command string to execute
+- `sudo`: Boolean, whether to execute this command with sudo (optional, default: nil, inherits host configuration)
+
+**Using sudo:**
+
+1. **At host level** (all commands automatically use sudo):
+```ruby
+host "web01",
+  user: "ubuntu",
+  ip: "10.0.0.1",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true  # All commands automatically use sudo
+```
+
+2. **At command level** (only specific commands use sudo):
+```ruby
+task :deploy do
+  run "systemctl restart nginx", sudo: true  # Only this command uses sudo
+  run "echo 'Deployed'"  # This command does not use sudo
+end
+```
+
+3. **With sudo password** (if password authentication is required):
+```ruby
+host "web01",
+  user: "ubuntu",
+  ip: "10.0.0.1",
+  key: "~/.ssh/id_rsa",
+  use_sudo: true,
+  sudo_password: "your-sudo-password"  # Only configure if password is required
+```
+
+**Notes:**
+- If the command already starts with `sudo`, the tool will not add it again
+- It's recommended to use NOPASSWD sudo configuration to avoid storing passwords in configuration files
+- Command-level `sudo` option overrides host-level `use_sudo` configuration
+
 **Best Practice**: Use heredoc (`<<~SHELL`) for multi-line commands to improve readability.
 
 #### `upload` - Upload Files

data/lib/kdeploy/command_executor.rb

@@ -9,12 +9,14 @@ module Kdeploy
     end
 
     def execute_run(command, host_name)
-      show_command_header(host_name, :run, command[:command])
+      cmd = command[:command]
+      use_sudo = command[:sudo]
+      show_command_header(host_name, :run, cmd)
       result, duration = measure_time do
-        @executor.execute(command[:command])
+        @executor.execute(cmd, use_sudo: use_sudo)
       end
       show_command_output(result)
-      { command: command[:command], output: result, duration: duration, type: :run }
+      { command: cmd, output: result, duration: duration, type: :run }
     end
 
     def execute_upload(command, host_name)

data/lib/kdeploy/dsl.rb

@@ -63,9 +63,9 @@ module Kdeploy
       }
     end
 
-    def run(command)
+    def run(command, sudo: nil)
       @kdeploy_commands ||= []
-      @kdeploy_commands << { type: :run, command: command }
+      @kdeploy_commands << { type: :run, command: command, sudo: sudo }
     end
 
     def upload(source, destination)

data/lib/kdeploy/executor.rb

@@ -13,9 +13,14 @@ module Kdeploy
       @password = host_config[:password]
       @key = host_config[:key]
       @port = host_config[:port] # 新增端口支持
+      @use_sudo = host_config[:use_sudo] || false
+      @sudo_password = host_config[:sudo_password]
     end
 
-    def execute(command)
+    def execute(command, use_sudo: nil)
+      use_sudo = @use_sudo if use_sudo.nil?
+      command = wrap_with_sudo(command) if use_sudo
+
       Net::SSH.start(@ip, @user, ssh_options) do |ssh|
         execute_command_on_ssh(ssh, command)
       end
@@ -99,5 +104,19 @@ module Kdeploy
     def add_port_option(options)
       options[:port] = @port if @port
     end
+
+    def wrap_with_sudo(command)
+      # 如果命令已经以 sudo 开头，不重复添加
+      return command if command.strip.start_with?('sudo')
+
+      if @sudo_password
+        # 使用 echo 和管道传递密码给 sudo -S
+        # 注意：密码会出现在进程列表中，建议使用 NOPASSWD 配置
+        escaped_password = @sudo_password.gsub("'", "'\"'\"'").gsub('$', '\\$').gsub('`', '\\`')
+        "echo '#{escaped_password}' | sudo -S #{command}"
+      else
+        "sudo #{command}"
+      end
+    end
   end
 end

data/lib/kdeploy/initializer.rb

@@ -31,6 +31,8 @@ module Kdeploy
         # Define hosts
         host 'web01', user: 'ubuntu', ip: '10.0.0.1', key: '~/.ssh/id_rsa'
         host 'web02', user: 'ubuntu', ip: '10.0.0.2', key: '~/.ssh/id_rsa'
+        # Example: Host with sudo enabled (all commands automatically use sudo)
+        # host 'web03', user: 'ubuntu', ip: '10.0.0.3', key: '~/.ssh/id_rsa', use_sudo: true
         host 'db01', user: 'root', ip: '10.0.0.3', key: '~/.ssh/id_rsa'
 
         # Define roles
@@ -39,6 +41,8 @@ module Kdeploy
 
         # Define deployment task for web servers
         task :deploy_web, roles: :web do
+          # Example: Using sudo option for specific command
+          # run "systemctl stop nginx", sudo: true
           run <<~SHELL
             sudo systemctl stop nginx
             echo "Deploying..."
@@ -78,6 +82,8 @@ module Kdeploy
 
         # Define task for all hosts
         task :update do
+          # Example: Using sudo option for specific command
+          # run "apt-get update && apt-get upgrade -y", sudo: true
           run <<~SHELL
             sudo apt-get update && sudo apt-get upgrade -y
           SHELL
@@ -189,6 +195,22 @@ module Kdeploy
           worker_processes: 4
         ```
 
+        ## 🔐 Using Sudo
+
+        Kdeploy supports sudo execution in two ways:
+
+        1. **Host-level configuration** (all commands automatically use sudo):
+        ```ruby
+        host 'web01', user: 'ubuntu', ip: '10.0.0.1', key: '~/.ssh/id_rsa', use_sudo: true
+        ```
+
+        2. **Command-level configuration** (only specific commands use sudo):
+        ```ruby
+        run "systemctl restart nginx", sudo: true
+        ```
+
+        See the main documentation for more details on sudo usage.
+
         ## 🚀 Usage
 
         ### Task Execution

data/lib/kdeploy/version.rb

@@ -2,5 +2,5 @@
 
 # Kdeploy module for version management
 module Kdeploy
-  VERSION = '1.2.8' unless const_defined?(:VERSION)
+  VERSION = '1.2.9' unless const_defined?(:VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kdeploy
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Kk