[PATCH compass-ci] doc/manual: add 如何登陆测试机.md

1 Dec 2020

Add a document for introducing how to log in test machine

Signed-off-by: Zhang Yu <2134782174@qq.com>
---
 ...06\346\265\213\350\257\225\346\234\272.md" | 80 +++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 "doc/manual/\345\246\202\344\275\225\347\231\273\351\231\206\346\265\213\350\257\225\346\234\272.md"

diff --git "a/doc/manual/\345\246\202\344\275\225\347\231\273\351\231\206\346\265\213\350\257\225\346\234\272.md" "b/doc/manual/\345\246\202\344\275\225\347\231\273\351\231\206\346\265\213\350\257\225\346\234\272.md"
new file mode 100644
index 0000000..8855695
--- /dev/null
+++ "b/doc/manual/\345\246\202\344\275\225\347\231\273\351\231\206\346\265\213\350\257\225\346\234\272.md"
@@ -0,0 +1,80 @@
+这篇文档将告诉你如何登陆测试环境
+
+# 1 前提条件
+请先学习:
+submit 命令详解：
+参考文档：[submit命令详解.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/submit命令详解.md)
+如何申请测试机，并在本地生成RSA公私钥对：
+参考文档：[submit命令详解.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/如何申请测试机.md)
+apply-account.md， 配置个人邮箱：
+参考文档：[submit命令详解.md](https://gitee.com/wu_fengguang/compass-ci/blob/master/doc/manual/apply-accou...)
+
+# 2. 操作方法
+## 2.1 在job.yaml里加上sshd和sleep字段, 以host-info.yaml任务为例：
+    suite: host-info 
+    category: functional 
+    
+    sshd:
+        pub_key: <%=
+        begin
+          File.read("#{ENV['HOME']}/.ssh/id_rsa.pub").chomp
+        rescue
+          nil
+        end
+        %>
+    # sleep at the bottom
+    sleep: 1h
+
+    host-info:
+
+## 2.2 提交任务的方式有2种， 适用于不同的登陆需求：
+### 第一种：使用submit -m -c的方式提交任务：
+    这种方式提交的任务会在指定的位置sleep并直接登陆到测试机中，适用于登陆测试环境后手动调试
+    命令：submit -m -c host-info.yaml
+    任务提交完成后，当测试执行到sshd后会自动登陆到测试机器上：
+    效果如下：
+    hi6325@account-vm ~% submit -m -c atomic.yaml                               
+    submit atomic.yaml, got job_id=crystal.146528                               
+    query=>{"job_id":["crystal.146528"]}                                                  
+    connect to ws://localhost:11310/filter                                                
+    {"job_id": "crystal.146528", "result_root": "/srv/result/atomic/2020-12-01/vm-2p8g/openeuler-20.03-aarch64/1-1000/crystal.146528", "job_state": "set result root"
+    	{"job_id": "crystal.146528", "job_state": "boot"}                  
+    	{"job_id": "crystal.146528", "job_state": "download"}
+    	{"time":"2020-12-01 10:12:33","mac":"0a-2d-7b-d9-f8-b1","ip":"172.18.252.12","job_id":"crystal.146528","state":"running","testbox":"vm-2p8g.zhyl-453231"}
+    	{"job_state":"running","job_id":"crystal.146528"}
+    	{"job_id": "crystal.146528", "state": "set ssh port", "ssh_port": "51750", "tbox_name": "vm-2p8g.zhyl-453231"}
+    	
+	root@vm-2p8g ~#
+
+### 第二种：使用submit的方式提交任务：
+    这种方式提交的任务会在测试执行完成后，系统自动发送一封邮件提醒您可以在指定时间内登陆到测试环境
+    命令： submit host-info.yaml
+    任务执行完成后，系统发送邮件如下：
+    Subject: [NOTIFY Compass-ci] vm-2p8g-294828 ready to use
+    
+    Dear $my_username:
+    	Thanks for your participation in software ecosystem!
+    	According to your application, vm-2p8g-294828 has been provisioned.
+    	The datails are as follows:
+    
+    	Login:
+    		ssh root@api.compass-ci.openeuler.org -p $port
+    	Due time:
+    		$deadline
+    	HW:
+    		nr_cpu: $nr_cpu
+    		memory: $memory
+    		testbox: $testbox
+    	OS:
+    		$os $os_version $os_arch
+    
+    Regards
+    Compass-Ci
+
+    可通过ssh方式登陆到测试环境：
+    命令： ssh root@api.compass-ci.openeuler.org -p $port
+    效果如下：
+    hi6325@account-vm ~% ssh root@api.compass-ci.openeuler.org -p 51400
+   
+    
+    root@vm-2p8g ~# 
-- 
2.23.0

    

Zhang Yu

Zhang Yale

Zhang Yu

Zhang Yu

tags

participants (2)