-
Notifications
You must be signed in to change notification settings - Fork 55
Improved documentation for Ubuntu15+ installations #39
Conversation
Making this more n00b (or Steph) friendly! Only got as far as systemd stuff since I'm encountering issues at that point and have raised a bug Azure/azure-docker-extension#94
thanks for this I'll review. |
0. Make it executable: `chmod +x /usr/bin/azurefile-dockervolumedriver` | ||
0. Download the tar.gz from "Releases" tab of the repo | ||
+ Currently this would be `wget https://github.com/Azure/azurefile-dockervolumedriver/archive/0.2.1.tar.gz` | ||
0. Extract and copy the extracted files to `/usr/bin/azurefile-dockervolumedriver`: |
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.
this is not quite accurate, we have a single file.
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.
Sorry, left the remnant in - should be changed to "Extract the files so we can get the relevant config files we need later"
I think we have a bit of disagreement. This product is a bit intended for Linux-savvy people as it is Linux-only a well as an advanced tool. I'm not very big fan of explaining every single bit of detail of the steps and it appears like it gets kind of harder to follow for the advanced users. I'll add our docs expert @squillace to comment. |
0. Save the `.default` file to `/etc/default/azurefile-dockervolumedriver` | ||
+ Copy the file: `cp azurefile-dockervolumedriver-0.2.1/contrib/init/systemd/azurefile-dockervolumedriver.default /etc/default/azurefile-dockervolumedriver` |
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.
I think this is wgettable as well from the file's raw.github.com URL. I don't think the users should be downloading the entire tar.gz.
Also, if we document it like this, we'll be have to support this library structure (or docs will get broken).
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.
I think it's important users know where to get the files - not least because they might end up with the wrong copies from the init folder. If you think that it's easier for them to get the file from the git dirs that's fine - although you'd still have an issue with restricted folder structures?
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.
it's just generally the instructions did not seem complicated to me at all (perhaps because I'm the author of the project of course). However I think we can just clarify the file paths in the original version, but I'm a bit against providing full wget
links etc. That seemed a bit far too verbose.
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.
Fair enough - can we simply refer to the directory they should be in ie ../contrib/init/systemd
?
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.
@stephlocke yeah
Per discussions
- Directed people to wget direct from github for the default and services files - Removed references to current release number
|
||
0. `sudo -s` | ||
0. Download the binary from “Releases” tab of the repo to `/opt/bin/`: `wget -qO/usr/bin/azurefile-dockervolumedriver [url]` | ||
0. Make it executable: `chmod +x /usr/bin/azurefile-dockervolumedriver` | ||
0. Download the tar.gz from "Releases" tab of the repo for copies of config files |
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.
I'm still a bit against downloading tar.gz. People can just download the .service & .default files individually from the GitHub repo?
Default image for azure docker-machine extension is 15.04 so this line is needed for that set up method but isn't needed for other ubuntu versions
0. Save the `.default` file to `/etc/default/azurefile-dockervolumedriver` | ||
+ Copy the file: `cp azurefile-dockervolumedriver.default /etc/default/azurefile-dockervolumedriver` |
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.
well, they don't have it on their disk at this point. so maybe we should point them to the file with something like:
- download [azurefile-dockervolumedriver.default](../path/to/azurefile-dockervolumedriver.default) file first
0. Edit `/etc/default/azurefile-dockervolumedriver` with your Azure Storage Account credentials. | ||
0. Save the `.service` file to `/etc/systemd/system/azurefile-dockervolumedriver.service` | ||
+ [Ubuntu 15.x only] Make the requisite directories if they don't exist: `mkdir /etc/systemd && mkdir /etc/systemd/system` |
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.
these can be briefly done as mkdir -p /etc/systemd/system
looks way better now. thanks! 👍 🎊 |
On the level the docs should be pitched at.... cc @squillace |
I think there is a good balance between totally n00b docs and an advanced one. This is way better now. Thanks for your contribution. 🎆 |
My pleasure, apologies for being hassle! |
As I've gone through the process as a n00b I identified various points where there were issues (like the wget going to wrong dir) or where there it just assumed you were comfortable with linux.
I added a TL;DR so that people who were really expert could get going quickly.
Hopefully, these docs are considered an improvement. If they are, I'm happy to do a similar modification to the Ubuntu14 notes.