K8S-利用Exec Websocket接口实现Pod间的文件拷贝，


 需求

想想咱们遇到以下问题一般怎么解决?

新建了一个Pod, 想把另外一个Pod中的文件拷贝到新Pod中进行分析, 怎么实现呢?

如何在项目中, 如何像kubectl cp拷贝文件一样, 实现Pod间文件拷贝呢?

新Pod与实例Pod共享pvc? 或者封装一个带认证上下文的kubectl执行命令行?

简介

本文通过K8S的exec websocket接口结合tar将文件树压缩为数据流以及解压还原, 实现两个Pod间拷贝文件的功能.

关于exec接口请参考:https://www.cnblogs.com/a00ium/p/10905279.html

请看图

流程说明

  • 首先初始化信号通道, 用于协程间的信号通知, 收到信号的协程执行暂停/退出循环/关闭通道等操作
  • 初始化数据通道srcStdOutCh, 类型为字节数组[]byte, 用于将源Pod的标准输出放入通道, 发送给目的Pod标准输入的数据就是从该数据通道中读取
  • 拼接exec接口的访问地址(集群连接,token), tar压缩命令, 标准输入/输出,tty, pod名,容器名等参数. tar czf - /var/log/xxx.log 表示将该文件树结构压缩为数据流
  • 调用websocket的Dialer方法与源Pod容器建立websocket连接, 并开启协程将标准输出写入数据通道srcStdOutCh
  • 参考源pod exec接口, 拼接目的Pod exec访问连接, tar xzf - -C /tmp表示从标准输入读取数据流, 并解压成文件树结构(注意:解压后包含文件目录树结构)
  • 与目的Pod建立wss连接, 开启协程从数据通道srcStdOutCh中读取源Pod标准输出, 并写入目的Pod的标准输入, 如果从数据通道读取超时,则表示数据已经传输完毕, 此时停止向目的容器输入数据, 并发送通知信号, 通知主协程可以退出,关闭源Pod的wss连接

注意事项

  • wesocket连上源Pod时, 标准输出中会输出空数据, tar命令输出等干扰数据, 所以接收数据的时候需要传入一个过滤器回调函数, 用于数据过滤
  • 向目的容器发送数据时, 需要将源容器收到的第一个字节删除, 一般为1, 表示标准输出标识, 发送给目的容器是不需要该字节的
  • 发送数据时, 需要设置第一个字节为0, 表示发送到标准输入

参考代码

cp.go

  1. /* 
  2. 总结: 1.不带缓冲的通道需要先读后写 2.websocket ReadMessage方法是阻塞读取的, 如果要中断读取, 关闭连接, 捕获错误即可 
  3. */ 
  4. package cpFilePod2Pod 
  5.  
  6. import ( 
  7.   "crypto/tls" 
  8.   "errors" 
  9.   "fmt" 
  10.   "log" 
  11.   "net/url" 
  12.   "regexp" 
  13.   "strings" 
  14.   "sync" 
  15.   "time" 
  16.  
  17.   "github.com/gorilla/websocket" 
  18. ) 
  19.  
  20. // 定义过滤器回调函数 
  21. type filterCallback func(input string) bool 
  22.  
  23. // 带有互斥锁的Websocket连接对象 
  24. type WsConn struct { 
  25.   Conn *websocket.Conn 
  26.   mu   sync.Mutex 
  27. } 
  28.  
  29. // 发送字符串, 自动添加换行符 
  30. func (self *WsConn) Send(sender string, str string) { 
  31.   self.mu.Lock() 
  32.   defer self.mu.Unlock() 
  33.   // 利用k8s exec websocket接口发送数据时, 第一个字节需要设置为0, 表示将数据发送到标准输入 
  34.   data := []byte{0} 
  35.   data = append(data, []byte(str+"\n")...) 
  36.   err := self.Conn.WriteMessage(websocket.BinaryMessage, data) //发送二进制数据类型 
  37.   if err != nil { 
  38.     log.Printf("发送错误, %s", err.Error()) 
  39.   } 
  40.   log.Printf("%s, 数据:%s, 字节:%+v", sender, str, []byte(str+"\n")) 
  41. } 
  42.  
  43. //发送字符串, 不添加换行符, 内部做字节过滤,等操作 
  44. func (self *WsConn) SendWithFilter(sender string, str string) { 
  45.   self.mu.Lock() 
  46.   defer self.mu.Unlock() 
  47.   // log.Printf("向目的容器发送数据:%s", str) 
  48.   str = strings.ReplaceAll(str, "\r\n", "\n") // /r=13, /n=10, windows换行符转Linux换行符 
  49.   //去掉第一个字节(标准输出1, byte:[0 1 ...]), 因为从源容器输出的字节中, 第一位标识了标准输出1, 给目的容器发送字节时, 需要去除该标志 
  50.   //当WebSocket建立连接后，发送数据时需要在字节Buffer第一个字节设置为stdin(buf[0] = 0)，而接受数据时, 需要判断第一个字节, stdout(buf[0] = 1)或stderr(buf[0] = 2) 
  51.   strByte := append([]byte(str)[:0], []byte(str)[1:]...) 
  52.   data := []byte{0} 
  53.   data = append(data, strByte...) 
  54.   err := self.Conn.WriteMessage(websocket.BinaryMessage, data) 
  55.   log.Printf("向目的容器标准输入发送数据:\n%s, 字节数:%d, 字节:%+v", string(data), len(data), data) 
  56.   if err != nil { 
  57.     log.Printf("发送错误, %s", err.Error()) 
  58.   } 
  59. } 
  60.  
  61. //从连接中获取数据流, 并写入字节数组通道中, 内部执行过滤器(回调函数) 
  62. func (self *WsConn) Receive(receiver string, ch chan []byte, filter filterCallback) error { 
  63.   self.mu.Lock() 
  64.   defer self.mu.Unlock() 
  65.   msgType, msgByte, err := self.Conn.ReadMessage() //阻塞读取, 类型为2表示二进制数据, 1表示文本, -1表示连接已关闭:websocket: close 1000 (normal) 
  66.   log.Printf("%s, 读取到数据:%s, 类型:%d, 字节数:%d, 字节:%+v", receiver, string(msgByte), msgType, len(msgByte), msgByte) 
  67.   if err != nil { 
  68.     log.Printf("%s, 读取出错, %s", receiver, err.Error()) 
  69.     return err 
  70.   } 
  71.   if filter(string(msgByte)) && len(msgByte) > 1 { 
  72.     ch <- msgByte 
  73.   } else { 
  74.     log.Printf("%s, 数据不满足, 直接丢弃数据, 字符:%s, 字节数:%d, 字节:%v", receiver, string(msgByte), len(msgByte), msgByte) 
  75.   } 
  76.   return nil 
  77. } 
  78.  
  79. func NewWsConn(host string, path string, params map[string]string, headers map[string][]string) (*websocket.Conn, error) { 
  80.   paramArray := []string{} 
  81.   for k, v := range params { 
  82.     paramArray = append(paramArray, fmt.Sprintf("%s=%s", k, v)) 
  83.   } 
  84.   u := url.URL{Scheme: "wss", Host: host, Path: path, RawQuery: strings.Join(paramArray, "&")} 
  85.   log.Printf("API:%s", u.String()) 
  86.   dialer := websocket.Dialer{TLSClientConfig: &tls.Config{RootCAs: nil, InsecureSkipVerify: true}} 
  87.   conn, _, err := dialer.Dial(u.String(), headers) 
  88.   if err != nil { 
  89.     return nil, errors.New(fmt.Sprintf("连接错误:%s", err.Error())) 
  90.   } 
  91.   return conn, nil 
  92. } 
  93.  
  94. //核心: tar -cf - 将具有文件夹结构的数据转换成数据流, 通过 tar -xf - 将数据流转换成 linux 文件系统 
  95. func CpPod2Pod() { 
  96.   //通知主函数可以退出的信号通道 
  97.   signalExit := make(chan bool, 1) 
  98.   defer close(signalExit) 
  99.  
  100.   //下发不要给目的容器发送数据的信号 
  101.   signalStopDstSend := make(chan bool, 1) 
  102.   defer close(signalStopDstSend) 
  103.  
  104.   //下发不要从源容器读取数据的信号 
  105.   signalStopSrcRead := make(chan bool, 1) 
  106.   defer close(signalStopSrcRead) 
  107.  
  108.   //下发不要从目的容器读取数据的信号 
  109.   signalStopDstRead := make(chan bool, 1) 
  110.   defer close(signalStopDstRead) 
  111.  
  112.   //下发不要打印目的容器的输出数据 
  113.   signalStopPrintDstStdout := make(chan bool, 1) 
  114.   defer close(signalStopPrintDstStdout) 
  115.  
  116.   //连接pod 
  117.   host := "172.16.xxx.xxx:6443" 
  118.   token := "xxx" 
  119.   headers := map[string][]string{"authorization": {fmt.Sprintf("Bearer %s", token)}} 
  120.  
  121.   pathSrc := "/api/v1/namespaces/xxx/pods/xxx/exec" 
  122.   commandSrc := "tar&command=czf&command=-&command=/var/log/mysql/slow.log" //tar czf - sourceFile 
  123.   paraSrc := map[string]string{"stdout": "1", "stdin": "0", "stderr": "1", "tty": "0", "container": "xxx", "command": commandSrc} 
  124.   srcConn, err := NewWsConn(host, pathSrc, paraSrc, headers) 
  125.   if err != nil { 
  126.     log.Printf("源Pod连接出错, %s", err.Error()) 
  127.   } 
  128.  
  129.   pathDst := "/api/v1/namespaces/xxx/pods/xxx/exec" 
  130.   commandDst := "tar&command=xzf&command=-&command=-C&command=/tmp" // tar xzf - -C /tmp 
  131.   // paraDst := map[string]string{"stdout": "1", "stdin": "1", "stderr": "1", "tty": "0", "container": "xxx", "command": commandDst} 
  132.   paraDst := map[string]string{"stdout": "0", "stdin": "1", "stderr": "0", "tty": "0", "container": "xxx", "command": commandDst} //关闭目的Pod标准输出和错误输出 
  133.   dstConn, err := NewWsConn(host, pathDst, paraDst, headers) 
  134.   if err != nil { 
  135.     log.Printf("目的Pod连接出错, %s", err.Error()) 
  136.   } 
  137.  
  138.   wsSrc := WsConn{ 
  139.     Conn: srcConn, 
  140.   } 
  141.  
  142.   wsDst := WsConn{ 
  143.     Conn: dstConn, 
  144.   } 
  145.  
  146.   defer srcConn.Close() 
  147.   defer dstConn.Close() 
  148.  
  149.   srcStdOutCh := make(chan []byte, 2048) 
  150.   dstStdOutCh := make(chan []byte) 
  151.   defer close(srcStdOutCh) 
  152.   defer close(dstStdOutCh) 
  153.  
  154.   // 接收源容器标准输出到数据通道中 
  155.   go func() { 
  156.     i := 1 
  157.     for { 
  158.       log.Printf("第%d次, 从源容器读取标准输出", i) 
  159.       i++ 
  160.       //定义匿名过滤器回调方法, 对源容器标准输出中不需要的数据进行过滤 
  161.       err := wsSrc.Receive("源容器", srcStdOutCh, func(input string) bool { 
  162.         if input == "cat /var/log/mysql/slow.log" { 
  163.           return false 
  164.           // } else if match, _ := regexp.MatchString("root@(.+)#", input); match { 
  165.           //   return false 
  166.           // } else if match, _ := regexp.MatchString("cat /(.+).log", input); match { 
  167.           //   return false 
  168.           // } else if match, _ := regexp.MatchString("cat /tmp/(.+)", input); match { 
  169.           //   return false 
  170.         } else if match, _ := regexp.MatchString("tar: Removing leading(.+)", input); match { 
  171.           return false 
  172.         } else if len(input) == 0 { //过滤空消息 
  173.           // log.Printf("读取到标准错误输出") 
  174.           return false 
  175.         } 
  176.         return true 
  177.       }) 
  178.       if err != nil { 
  179.         log.Printf("读取源容器标准输出失败") 
  180.         // signalExit <- true 
  181.         break 
  182.       } 
  183.       // time.Sleep(time.Microsecond * 100) 
  184.     } 
  185.   }() 
  186.  
  187.   /* 注意, 这里不能开启并发协程去读取目的容器的标准输出, 如果开启可能会与发送数据的协程抢锁, 从而阻塞向目的容器发送数据*/ 
  188.   // // 从目的容器获取标准输出到数据通道中 
  189.   // go func() { 
  190.   //   // i := 0 
  191.   //   for { 
  192.   //     // 该过滤器直接返回true, 仅占位 
  193.   //     err := wsDst.Receive("目的容器", dstStdOutCh, func(input string) bool { 
  194.   //       return true 
  195.   //     }) 
  196.   //     if err != nil { 
  197.   //       log.Printf("从目的容器读取数据失败") 
  198.   //       break 
  199.   //     } 
  200.   //     // wsDst.Send() 
  201.   //     time.Sleep(time.Microsecond * 100000) 
  202.   //   } 
  203.   //   // log.Printf("从目的容器读取数据, 第%d次循环", i) 
  204.   //   // i++ 
  205.   // }() 
  206.  
  207.   // //从数据通道中读取, 目的容器的标准输出, 并打印 
  208.   // go func() { 
  209.   // BreakPrintDstPodStdout: 
  210.   //   for { 
  211.   //     select { 
  212.   //     case data := <-dstStdOutCh: 
  213.   //       log.Printf("目的容器标准输出:%s", string(data)) 
  214.   //       // time.Sleep(time.Microsecond * 200) 
  215.   //     case <-signalStopPrintDstStdout: 
  216.   //       log.Printf("收到信号, 停止打印目的容器标准输出") 
  217.   //       // close(dataOutput) 
  218.   //       // close(dataCh) 
  219.   //       // signalStopRead <- true 
  220.   //       // log.Printf("发送停止读信号") 
  221.   //       // close(dataOutput) 
  222.   //       // close(dataCh) 
  223.   //       break BreakPrintDstPodStdout 
  224.   //     } 
  225.   //     // time.Sleep(time.Microsecond * 100) 
  226.   //   } 
  227.   // }() 
  228.  
  229.   //从源容器标准输出的数据通道获取数据, 然后发送给目的容器标准输入 
  230.   //定义超时时间 
  231.   timeOutSecond := 3 
  232.   timer := time.NewTimer(time.Second * time.Duration(timeOutSecond)) 
  233. Break2Main: 
  234.   for { 
  235.     select { 
  236.     case data := <-srcStdOutCh: 
  237.       wsDst.SendWithFilter("向目的容器发送", string(data)) 
  238.       // time.Sleep(time.Millisecond * 200) 
  239.       timer.Reset(time.Second * time.Duration(timeOutSecond)) 
  240.     case <-timer.C: 
  241.       // time.Sleep(time.Second * 5) 
  242.       log.Printf("================ 源容器标准输出,没有新的数据,获取超时,停止向目的容器发送数据 ================") 
  243.       // log.Printf("发送信号:停止打印目的容器标准输出") 
  244.       // signalStopPrintDstStdout <- true 
  245.       log.Printf("发送信号:停止从源容器读取数据") 
  246.       wsSrc.Conn.Close() 
  247.       // log.Printf("发送信号:停止从目的容器读取数据") 
  248.       // wsDst.Conn.Close() 
  249.       log.Printf("发送信号:主函数可以退出了") 
  250.       signalExit <- true 
  251.       log.Printf("所有信号发送完毕") 
  252.       log.Printf("================== 跳出循环 =================") 
  253.       break Break2Main 
  254.     } 
  255.     // time.Sleep(time.Microsecond * 1000) 
  256.   } 
  257.  
  258.   // signalStopRead <- true 
  259.   <-signalExit //阻塞通道, 直到收到一个信号 
  260.   // signalStopRead <- true 
  261.   log.Printf("主函数收到信号, 准备退出") 
  262.   // close(dataCh) 
  263.   // time.Sleep(time.Second) 
  264.   // close(dataOutput) 
  265.   // time.Sleep(time.Second) 
  266.   // select {} 
  267. } 

cp_test.go

  1. package cpFilePod2Pod 
  2.  
  3. import ( 
  4.   "log" 
  5.   "testing" 
  6. ) 
  7.  
  8. // go test -race -test.run TestCpPod2Pod  切到该目录执行该测试 
  9. func TestCpPod2Pod(t *testing.T) { 
  10.   log.Printf("开始测试") 
  11.   CpPod2Pod() 
  12. } 

  1. 参考结果: 
  2. 源容器: 
  3. root@xxx-mysql-0:/var/log/mysql# md5sum slow.log 
  4. 16577613b6ea957ecb5d9d5e976d9c50  slow.log 
  5. 目的容器: 
  6. root@xxx-75bdcdb8cf-hq9wf:/tmp/var/log/mysql# md5sum slow.log 
  7. 16577613b6ea957ecb5d9d5e976d9c50  slow.log 

参考文档

Kubernetes exec API串接分析:https://www.cnblogs.com/a00ium/p/10905279.html

kubernetes-client-go-实现-kubectl-copy:https://ica10888.com/2019/08/31/kubernetes-client-go-%E5%AE%9E%E7%8E%B0-kubectl-copy.html

相关内容