Merge pull request #17 from mritd/develop

v1.4.0

Author: mritd

Makefile

@@ -28,3 +28,5 @@ install:
 .EXPORT_ALL_VARIABLES:
 
 GO111MODULE = on
+GOPROXY = https://goproxy.io
+GOSUMDB = sum.golang.google.cn

README.md

@@ -4,7 +4,8 @@
 
 ### 安装
 
-可直接从 [release](https://github.com/mritd/mmh/releases) 页下载预编译的二进制文件，然后执行 `mmh install` (需要root 权限，自动请求 `sudo`)即可；卸载直接执行 `mmh uninstall`，卸载命令不会删除 `~/.mmh` 配置目录。
+可直接从 [release](https://github.com/mritd/mmh/releases) 页下载预编译的二进制文件，然后执行 `mmh install` (需要root 权限，自动请求 `sudo`)即可；
+卸载直接执行 `mmh uninstall`，卸载命令不会删除 `~/.mmh` 配置目录。
 
 **默认安装到 `/usr/bin` 目录下，如果受权限限制无法安装，请使用 `--dir` 选项指定其他安装目录**
 
@@ -26,7 +27,9 @@ Available Commands:
   go          Login single server
   help        Help about any command
   install     Install mmh
+  ping        Ping server
   server      Server command
+  tun         SSH tunnel
   uninstall   Uninstall mmh
   version     Print version
 
@@ -43,6 +46,8 @@ Use "mmh [command] --help" for more information about a command.
 - `mmh cp` ==> `mcp`
 - `mmh server` ==> `mcs`
 - `mmh ctx` ==> `mcx`
+- `mmh ping` ==> `mping`
+- `mmh tun` ==> `mtun`
 
 ### 配置文件
 
@@ -61,62 +66,56 @@ Use "mmh [command] --help" for more information about a command.
 
 ``` yaml
 basic: default
+current: test
 contexts:
 - name: default
-  config_path: ./default.yaml
-- name: dohko
-  config_path: ./dohko.yaml
-current: dohko
+  config_path: /Users/mritd/MEGA/mmh/default.yaml
+- name: test
+  config_path: test.yaml
 ```
 
-主配置文件中可以配置多个 `context`，由 `current` 字段指明当前使用哪个 `context`, `basic` 设置的 `context` 会作为额外补充服务器加入 `current` 指明的 `context` 中；**`basic` 适用于存放一些常规服务器，比如个人的 vps 等，以保证在任何 `context` 都可以访问这些服务器。**
+主配置文件中可以配置多个 `context`，由 `current` 字段指明当前使用哪个 `context`, `basic` 设置的 `context` 会作为
+额外补充服务器加入 `current` 指明的 `context` 中；**`basic` 适用于存放一些常规服务器，比如个人的 vps 等，以保证在任
+何 `context` 都可以访问这些服务器。**`config_path` 字段可以是绝对路径，也可以为相对路径，**相对路径默认位置为 `~/.mmh` 目录**
 
 #### default.yaml
 
 这个是真正的 SSH 配置，一般情况下其与对应的 `context` 名称相同；该配置文件样例如下
 
 ``` yaml
 basic:
-  user: root
-  password: ""
-  privatekey: /Users/mritd/.ssh/id_rsa
-  privatekey_password: ""
-  port: 22
-  server_alive_interval: 0s
-servers:
-- name: prod11
-  tags:
-  - prod
-  user: root
-  password: password
-  privatekey: ""
-  privatekey_password: ""
-  address: 10.10.4.11
-  port: 22
-  proxy: prod12
-  server_alive_interval: 20s
-- name: prod12
-  tags:
-  - prod
-  user: root
   password: ""
-  privatekey: /Users/mritd/.ssh/id_rsa
-  privatekey_password: password
-  address: 10.10.4.12
   port: 22
+  private_key: /Users/mritd/.ssh/id_rsa
+  private_key_password: ""
   proxy: ""
-  server_alive_interval: 10s
+  user: root
+max_proxy: 5
+servers:
+- name: nginx
+  address: 172.16.1.10
+  tags: ["docker"]
+- name: gitlab
+  address: 172.16.1.101
+  tags: ["docker"]
+  port: 2222
+- name: wiki
+  address: 172.16.1.104
+  tags: ["docker"]
 tags:
-- prod
+- k8s
+- docker
 ```
 
-`basic` 段为默认配置，用于在 `servers` 段中某项配置不存在时进行填充；`servers` 段中可以配置 N 多个服务器(`server`)；每个 `server` 除了常规的 SSH 相关配置外还增加了 `proxy` 字段用于支持无限跳板(具体见下文)；`tag` 字段必须存在于在下面的 `tags` 段中，该配置主要是为了给服务器打 `tag` 方便批量复制与执行；`maxproxy` 是一个数字，用于处理当出现配置错误导致 "真·无限跳板" 情况时自动断开链接；`server_alive_interval` 用于实现保持链接。
+`basic` 段为默认配置，用于在 `servers` 段中某项配置不存在时进行填充；`servers` 段中可以配置 N 多个服务器(`server`)；
+每个 `server` 除了常规的 SSH 相关配置外还增加了 `proxy` 字段用于支持无限跳板(具体见下文)；`tag` 字段必须存在于在下面的
+`tags` 段中，该配置主要是为了给服务器打 `tag` 方便批量复制与执行；`max_proxy` 是一个数字，用于处理当出现配置错误导致
+"真·无限跳板" 情况时自动断开链接；`server_alive_interval` 用于实现保持链接。
 
 
 ### 自动登录 
 
-可以使用 `mgo SERVER_NAME` 直接登录，如需交互式登录可执行 `mmh` 即可；其他相关命令如 `mms ls/add/del` 
-都与添加修改服务器配置相关，请自行尝试:
+可以使用 `mgo SERVER_NAME` 直接登录，如需交互式登录可执行 `mmh` 即可
 
 ![mmh](img/mmh.gif)
 
@@ -127,7 +126,7 @@ tags:
 如果 C 的 `proxy` 设置为 B，同时 B 的 `proxy` 设置为 A，那么实际在登录 C 时，工具实际连接顺序为: `local->A->B->C`
 
 **不要去尝试循环登录，比如 `A->B->C->A` 这种配置，工具内部已经做了检测防止产生这种 "真·无限跳板" 的情况，
-默认最大跳板机数量被限制为 5 台，可通过在配置文件中增加 `maxProxy` 字段进行调整**
+默认最大跳板机数量被限制为 5 台，可通过在配置文件中增加 `max_proxy` 字段进行调整**
 
 ### 管道式批量执行
 
@@ -160,7 +159,7 @@ Flags:
 ### 批量复制
 
 为了尽量方便使用，模仿了一下 `scp` 命令，增加了批量复制功能 `mcp`；批量复制支持 **本地到远端多机器的文件/目录批量复制** 和
-**单一远端机器到本地的文件/目录复制**；
+**单一远端机器到本地的文件/目录复制**；当指定 `-g` 选项时，则会类似 `mec` 命令一样向目标 `tag` 的一组服务器发起复制
 
 ```sh
 ➜  ~ mcp --help
@@ -174,9 +173,9 @@ Aliases:
   cp, mcp
 
 Flags:
-  -r, --dir      useless flag
-  -h, --help     help for cp
-  -s, --single   single server
+  -r, --dir     useless flag
+  -g, --group   multi-server copy
+  -h, --help    help for cp
 ```
 
 **注意: 批量复制并不可靠，请谨慎使用；并非说代码不可靠，只是相对来说对于登录等功能，即使工具出问题，也很难造成灾难性后果；
@@ -186,7 +185,9 @@ Flags:
 
 ### 多环境切换
 
-考虑到同时将多个环境的配置放在同一个配置文件中会有混乱，同时也可能出现误操作的情况，`v1.3.0` 版本增加了 `context` 的概念；每个 `context` 被认为是一种环境，比如 `prod`、`test`、`uat` 等，每个环境的机器配置被分成了独立的文件以方便单独修改与加载；控制使用哪个 `context` 可以使用 `mcx set CONTEXT_NAME` 命令
+考虑到同时将多个环境的配置放在同一个配置文件中会有混乱，同时也可能出现误操作的情况，`v1.3.0` 版本增加了 `context` 的概念；
+每个 `context` 被认为是一种环境，比如 `prod`、`test`、`uat` 等，每个环境的机器配置被分成了独立的文件以方便单独修改与加载；
+控制使用哪个 `context` 可以使用 `mcx set CONTEXT_NAME` 命令
 
 ``` sh
 ➜  ~ mcx --help

cmd/cp.go

@@ -5,7 +5,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var singleCPServer bool
+var groupServer bool
 var copyDir bool
 var cpCmd = &cobra.Command{
 	Use:     "cp [-r] FILE/DIR|SERVER_TAG:PATH SERVER_NAME:PATH|FILE/DIR",
@@ -17,13 +17,13 @@ Copies files between hosts on a network.`,
 		if len(args) < 2 {
 			_ = cmd.Help()
 		} else {
-			mmh.Copy(args, singleCPServer)
+			mmh.Copy(args, groupServer)
 		}
 	},
 }
 
 func init() {
 	RootCmd.AddCommand(cpCmd)
-	cpCmd.PersistentFlags().BoolVarP(&singleCPServer, "single", "s", false, "single server")
+	cpCmd.PersistentFlags().BoolVarP(&groupServer, "group", "g", false, "multi-server copy")
 	cpCmd.PersistentFlags().BoolVarP(&copyDir, "dir", "r", false, "useless flag")
 }

cmd/exec.go

@@ -7,7 +7,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var singleExecServer bool
+var singleServer bool
 var execCmd = &cobra.Command{
 	Use:     "exec SERVER_TAG CMD",
 	Aliases: []string{"mec"},
@@ -19,12 +19,12 @@ Batch exec command.`,
 			_ = cmd.Help()
 		} else {
 			cmd := strings.Join(args[1:], " ")
-			mmh.Exec(args[0], cmd, singleExecServer)
+			mmh.Exec(args[0], cmd, singleServer, false)
 		}
 	},
 }
 
 func init() {
 	RootCmd.AddCommand(execCmd)
-	execCmd.PersistentFlags().BoolVarP(&singleExecServer, "single", "s", false, "single server")
+	execCmd.PersistentFlags().BoolVarP(&singleServer, "single", "s", false, "single server")
 }

cmd/install.go

@@ -17,6 +17,6 @@ Install mmh.`,
 }
 
 func init() {
-	installCmd.PersistentFlags().StringVar(&installDir, "dir", "/usr/bin", "install dir")
+	installCmd.PersistentFlags().StringVar(&installDir, "dir", "/usr/local/bin", "install dir")
 	RootCmd.AddCommand(installCmd)
 }

cmd/ping.go

@@ -0,0 +1,25 @@
+package cmd
+
+import (
+	"github.com/mritd/mmh/mmh"
+	"github.com/spf13/cobra"
+)
+
+var pingCmd = &cobra.Command{
+	Use:     "ping SERVER_NAME",
+	Aliases: []string{"mping"},
+	Short:   "Ping server",
+	Long: `
+Ping server.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		if len(args) == 1 {
+			mmh.Ping(args[0])
+		} else {
+			_ = cmd.Help()
+		}
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(pingCmd)
+}

cmd/server.go

@@ -16,30 +16,6 @@ Server command.`,
 	},
 }
 
-var serverAddCmd = &cobra.Command{
-	Use:   "add",
-	Short: "Add ssh server",
-	Long: `
-Add ssh server.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		mmh.AddServer()
-	},
-}
-
-var serverDelCmd = &cobra.Command{
-	Use:   "del SERVER1 SERVER2...",
-	Short: "Delete ssh server",
-	Long: `
-Delete ssh server.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		if len(args) > 0 {
-			mmh.DeleteServer(args)
-		} else {
-			_ = cmd.Help()
-		}
-	},
-}
-
 var serverListCmd = &cobra.Command{
 	Use:   "ls [SERVER_NAME]",
 	Short: "List ssh server",
@@ -55,6 +31,6 @@ List ssh server.`,
 }
 
 func init() {
-	serverCmd.AddCommand(serverAddCmd, serverDelCmd, serverListCmd)
+	serverCmd.AddCommand(serverListCmd)
 	RootCmd.AddCommand(serverCmd)
 }

cmd/tun.go

@@ -0,0 +1,31 @@
+package cmd
+
+import (
+	"github.com/mritd/mmh/mmh"
+	"github.com/spf13/cobra"
+)
+
+var tunLocalAddr, tunRemoteAddr string
+
+var tunCmd = &cobra.Command{
+	Use:     "tun SERVER_NAME",
+	Aliases: []string{"mtun"},
+	Short:   "SSH tunnel",
+	Long: `
+SSH tunnel.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		if len(args) == 1 {
+			mmh.Tunnel(args[0], tunLocalAddr, tunRemoteAddr)
+		} else {
+			_ = cmd.Help()
+		}
+	},
+}
+
+func init() {
+	tunCmd.Flags().StringVarP(&tunLocalAddr, "local", "l", "", "local address")
+	tunCmd.Flags().StringVarP(&tunRemoteAddr, "remote", "r", "", "local address")
+	_ = tunCmd.MarkFlagRequired("local")
+	_ = tunCmd.MarkFlagRequired("remote")
+	RootCmd.AddCommand(tunCmd)
+}

cmd/uninstall.go

@@ -17,6 +17,6 @@ Uninstall mmh.`,
 }
 
 func init() {
-	uninstallCmd.PersistentFlags().StringVar(&uninstallDir, "dir", "/usr/bin", "uninstall dir")
+	uninstallCmd.PersistentFlags().StringVar(&uninstallDir, "dir", "/usr/local/bin", "uninstall dir")
 	RootCmd.AddCommand(uninstallCmd)
 }

go.mod

@@ -1,18 +1,15 @@
 module github.com/mritd/mmh
 
+go 1.13
+
 require (
 	github.com/fatih/color v1.7.0
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/kr/pretty v0.1.0 // indirect
-	github.com/mattn/go-colorable v0.0.9 // indirect
-	github.com/mattn/go-isatty v0.0.4 // indirect
-	github.com/mitchellh/go-homedir v1.0.0
-	github.com/mritd/promptx v0.0.0-20181104120837-d3bd32bd6d64
+	github.com/mattn/go-colorable v0.1.2 // indirect
+	github.com/mattn/go-isatty v0.0.9 // indirect
+	github.com/mitchellh/go-homedir v1.1.0
+	github.com/mritd/promptx v0.0.0-20190919142911-51b6aa75496f
 	github.com/mritd/sshutils v0.0.0-20190114085520-a41b046f5b5c
-	github.com/spf13/cobra v0.0.3
-	github.com/spf13/pflag v1.0.3 // indirect
-	golang.org/x/crypto v0.0.0-20181127143415-eb0de9b17e85
-	golang.org/x/sys v0.0.0-20181128092732-4ed8d59d0b35 // indirect
-	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+	github.com/spf13/cobra v0.0.5
+	golang.org/x/crypto v0.0.0-20190911031432-227b76d455e7
 	gopkg.in/yaml.v2 v2.2.2
 )