-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates to documentation for initial setup #13
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also write down the documentation for how to install docker-machine and add to your path variable- this is the starting page https://docs.docker.com/machine/install-machine/#install-machine-directly but it assumes you have sudo ; in our case we want to just install it "personally".
cp samples/*.fastq.gz treeshop/primary/original/TEST/ | ||
|
||
Spin up a single cluster machine: | ||
Spin up a single cluster machine (make sure you have created your SSH key): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Provide instructions for:
a) checking if you already have an "~/.ssh/id_rsa" private+public keypair files that don't require a password
b) if you don't have a keypair, how to create it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another thing to incorporate at the end:
- how to spin down machines when done
- the info from Rob's April 12 email "Floating IPs" about how to clear the IP addresses after spinning down machines.
Thank you @aglyle ; I'm satisfied. @klearned , passing this to you -- could you please do a readthrough of the new treeshop.md for potential improvements? |
Yes, I'll read through the new treeshop.md today |
@aglyle looks great. I approve this doc. |
@rcurrie Updates to the treeshop.md ready to be merged with master. Let me know if there's anything you want me to change. |
Good work - thank you for filling in pieces. I made a bunch of comments (feel free to push back!). In general I want to be careful about helping someone use this vs. helping someone that shouldn’t be using this.
… On May 31, 2018, at 12:35 PM, Geoff Lyle ***@***.***> wrote:
@rcurrie <https://github.com/rcurrie> Updates to the treeshop.md ready to be merged with master. Let me know if there's anything you want me to change.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub <#13 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAeEGjVKXYBzwy1aThYuhOxVnJIVkIVYks5t4EXngaJpZM4TW7PA>.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some specific comments below, but in general suggest this should be very prescriptive step by step so that someone can bring up a single group of machines, process, and shut down all with the HEAD of master.
treeshop.md
Outdated
|
||
#echo mypath=$PATH | ||
export PATH=$HOME/bin:$PATH | ||
export PATH=$PATH:/pod/pstore/groups/treehouse/sratoolkit/sratoolkit.2.8.2-1-centos_linux64/bin/:/scratch/<username> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't need SRA
treeshop.md
Outdated
|
||
fab down | ||
|
||
#### Select machines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest we remove all of this. Most people should follow a very rote path: up process down, repeat. At the very end have a section called 'advanced' where you point them to the fabric and docker-machine docs and allude to this but not spell it out. Having subsets of machines running, and the need to reset, is asking for problems for those that don't know how all this really works.
treeshop.md
Outdated
@@ -155,3 +275,7 @@ quite a bit of extra provenance by writing methods.json files as well as organiz | |||
per the Treehouse storage layout. That said if you have some custom additional pipelines you want to | |||
run its fairly easy to just add another target to the Makefile and then copy/paste inside of the | |||
fabfile.py process method. | |||
|
|||
If using multiple versions of the fabfile, you can select which version to use via the -f flag: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also remove this toward a very prescriptive approach to these docs. The advanced pointer can list capabilities (running multiple fab files, multiple clusters via fab and docker-machine) but not spell it out. Multiple fab files plus multiple clusters to someone not familar with distributed computing. Also if they have an editied fabfile the hash in the methods.json will not be correct and we'll have no way to sort out what happened after the fact.
@rcurrie Incorporated your comments. Removed sections that we expect users to know (SSH Key creation), unsure if you wanted to keep PATH setup or not, but it's removed in the latest version. Also moved documentation for shutting down select machines and different fabfiles to links in the options. Removed shutting down IPs as it is Treehouse specific. |
Adds documentation to bypass setup errors.