internal user: CLI tool: answerback-email external user: send 'apply account' email
Signed-off-by: Luan Shengde shdluan@163.com --- doc/apply-ssh-account.md | 49 ++++++++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 12 deletions(-)
diff --git a/doc/apply-ssh-account.md b/doc/apply-ssh-account.md index 69d8df6..d718d0d 100644 --- a/doc/apply-ssh-account.md +++ b/doc/apply-ssh-account.md @@ -1,18 +1,22 @@
-# apply for ssh account +# apply for jumper account
## purpose
-The ssh account is used to login our jumper VM, where you can +The jumper account is used to login the jumper VM, where you can - submit a job - ssh into a testbox +- read output of the job
## steps overview -1. send email to apply for ssh account - If approved, you'll get a response email with: +### manually assign account +for internal user +1. run assign account tool + usage: + answerback-mail.rb [-e|--email email] [-s|--ssh-pubkey pub_key_file] [-f|--raw-email email_file] [-g|--gen-sshkey]
- login command: - ssh -p port account@server_ip + login command: + ssh -p port account@server_ip
2. login authentication - use pub key @@ -20,18 +24,39 @@ The ssh account is used to login our jumper VM, where you can
3. submit jobs - prepare job.yaml - - run job + - submit job - command: submit job.yaml
-## example apply email +### apply account with email +for external user +1. send apply account email + - send apply account email to: compass-ci@qq.com + attention: + email subject: + apply account + email body: + my oss commit: https://github.com/torvalds/linux/commit/7be74942f184fdfba34ddd19a0d995deb34... + attachment: + ssh pubkey file + it will return email with my_email, my_name, my_uuid if successfully applied account + +2. prepare to submit job + execute on user's local host + - config default yaml file: + ~/.config/compass-ci/default/account.yaml + - prepare job.yaml + - submit job + +3. apply account email format + example:
- To: team@crystal.ci - Subject: apply ssh account + To: compass-ci@qq.com + Subject: apply account
# Show a commit URL that you contributed to an OSS project # We'll validate whether the URL contains your email. # for example, - commit: https://github.com/torvalds/linux/commit/7be74942f184fdfba34ddd19a0d995deb34... + my oss commit: https://github.com/torvalds/linux/commit/7be74942f184fdfba34ddd19a0d995deb34...
- # attach your ssh pub key as file (optionally but highly recommended) + # attach your ssh pub key to the email as attachment