From 28f94e7a24a017f168c477a8f86f6f24ac58452a Mon Sep 17 00:00:00 2001 From: david liu Date: Wed, 16 Sep 2015 16:35:33 +0800 Subject: [PATCH] Add instructions for uploading data with validated users. Closes-Bug: #1490691 Change-Id: Ib692c565d1030c7bccbef81ce130dcbd7e5a926c --- doc/uploading-private-results.md | 88 ++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 doc/uploading-private-results.md diff --git a/doc/uploading-private-results.md b/doc/uploading-private-results.md new file mode 100644 index 00000000..5086266a --- /dev/null +++ b/doc/uploading-private-results.md @@ -0,0 +1,88 @@ +How to upload test results to RefStack +====================================== + +RefStack allows test results contributors to submit test results and have them +displayed either anonymously, or identified with a vendor. As such, test +results should be uploaded with validated users. Users will first log into +RefStack with their OpenStack ID to upload their public keys. RefStack test +results can then be uploaded to RefStack using the corresponding private key. +By default, the uploaded data isn't shared, but authorized users can decide to +share the results with the community anonymously. + +The following is a quick guide outlining the steps needed to upload your first +set of test results. + +####Register an OpenStack ID + +The RefStack server uses OpenStack OpenID for user authentication. Therefore, +the RefStack server requires that anyone who wants to upload test data to have +an OpenStack ID. As you click on the Sign In/Sign Up link on the RefStack +pages, you will be redirected to the official OpenStack user log in page where +you can either log in with your OpenStack ID or register for one. The +registration page can also be found directly through: +[https://www.openstack.org/join/register](https://www.openstack.org/join/register). + +####Generate ssh keys locally + +You will need to generate ssh keys locally. If your operating system is a Linux +distro, then you can use the following instructions. + +First check for existing keys with command: + +- `ls -al ~/.ssh` + +If you see you already have existing public and private keys that you want to +use, you can skip this step; otherwise: + +- `ssh-keygen -t rsa -b 4096 -C "youropenstackid"` + +The 'youropenstackid' string is the username you chose when you registered for +your OpenStack ID account. Enter the file name in which to save the key +(/home/you/.ssh/id_rsa), then press enter. You will be asked to enter a +passphrase. Just press enter again as passphrase protected keys currently +aren't supported. Your ssh keys will then be generated. + +####Sign Key with RefStack Client + +** IMPORTANT ** You must have the RefStack client on you computer to complete +this step. + +Generate a signature for your public key using your private key with +[refstack-client](https://github.com/openstack/refstack-client) + +- `./refstack-client sign /path-of-sshkey-folder/key-file-name` + +The '/path-of-sshkey-folder' string is the path of the folder where the +generated ssh keys are stored locally. The 'key-file-name' portion refers to +the private key file name. If the command runs correctly, there will be output +like below: + + Public key: + ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDSGo2xNDcII1ZaM3H2uKh3iXBzvKIOa5W/5HxKF23yrzwho7nR7td0kgFtZ/4fe0zmkkUuKdUhOACCD3QVyi1N5wIhKAYN1fGt0/305jk7VJ+yYhUPlvo... + + Self signature: + 19c28fc07e3fbe1085578bd6db2f1f75611dcd2ced068a2195bbca60ae98af7e27faa5b6968c3c5aef58b3fa91bae3df3... + +####Upload the ssh public key and the signature + +Sign into [http://refstack.net](http://refstack.net) with +your OpenStack ID. Click the "Profile" link in the upper right corner. Now +click the "Import public key" button on your profile page. A popup window with +two entry fields will appear. Just copy and paste the key and signature +generated in the previous step into the corresponding textboxes. Note that +the strings 'Public key:' and 'Self signature:' are not needed here. Once +complete, click the 'Import public key' button. + +####Upload the test result with refstack-client + +- `./refstack-client upload /path_to_testresult_json_file --url http://refstack.net/api -i ~/.ssh/id_rsa` + +The 'path\_to\_testresult\_json\_file' here is the json file of your test +result. If the command runs correctly, there will be output like below: + + Test results will be uploaded to http://refstack.net/api. Ok? (yes/y): y + Test results uploaded! + URL: http://refstack.net/#/results/88a1e6f4-707d-4627-b658-b14b7e6ba70d. + +You can find your uploaded test results by clicking the 'My Results' link on +the RefStack website.