Iteration 3 Feedback

[andrewbutterfield]

Group 5 - Iteration 3 - Feedback

The README is almost un-readable using a text editor.

Please put all install/update instructions inline,
and stop referring off to other websites

All I want to know is how to install your stuff - not have to wade through general instructions about a wide range of install options.

Even when I look at the README on github (hoping it is 0.3's readme)
it is not clear what to do.

What is this "Happy Path" stuff?

Here is a transcript of what happens when I try to follow these instructions

part 1 -----
butrfeld@CS4098:~/CS4098/pathways$ docker-compose up -d
The program 'docker-compose' is currently not installed. You can install it by typing:
sudo apt install docker-compose
end of part 1----------

I ignore that advice and do what you suggested earlier

part 2 -------
butrfeld@CS4098: tilde /CS4098/pathways$ sudo curl -o /usr/local/bin/docker-compose -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s-uname -m`
[sudo] password for butrfeld:
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 600 0 600 0 0 597 0 --:--:-- 0:00:01 --:--:-- 597
100 8066k 100 8066k 0 0 1338k 0 0:00:06 0:00:06 --:--:-- 1696k
butrfeld@CS4098:~/CS4098/pathways$ sudo chmod +x /usr/local/bin/docker-compose
end of part 2--------

So far, so good!

I then try:

part 3 ------
butrfeld@CS4098:~/CS4098/pathways$ docker-compose up -d
ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?

If it's at a non-standard location, specify the URL with the DOCKER_HOST environment variable.
butrfeld@CS4098:~/CS4098/pathways$
end of part 3------

now I'm puzzled

If I follow the "Docker Hub" link I get a page with lists using Greek names - all very classical, but which one of these, if any, is 0.3 ??????

Looking at one suggests I need all three!!!

Then I see "Tags" ! This is getting very complicated.

The README should state clearly exactly what needs to be loaded from here.
How about some command-line stuff or a script that collects precisely the right stuff?

Your instructions regarding checking out 0.3 don't work - same problem as above.

Building manually.

OK - you need to provide scripts to do the DNS fixup/revert

It fails for me:

butrfeld@CS4098:/CS4098/pathways$ echo "{"dns": ["134.226.251.200", "134.226.251.100"]}" | sudo tee -a /etc/docker/daemon.json
[sudo] password for butrfeld:
{"dns": ["134.226.251.200", "134.226.251.100"]}
butrfeld@CS4098:/CS4098/pathways$ sudo service docker restart
butrfeld@CS4098:~/CS4098/pathways$ docker build -t tomtoothfairies/asclepius asclepius
Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Post http://%2Fvar%2Frun%2Fdocker.sock/v1.26/build?buildargs=%7B%7D&cachefrom=%5B%5D&cgroupparent=&cpuperiod=0&cpuquota=0&cpusetcpus=&cpusetmems=&cpushares=0&dockerfile=Dockerfile&labels=%7B%7D&memory=0&memswap=0&networkmode=default&rm=1&shmsize=0&t=tomtoothfairies%2Fasclepius&ulimits=null: dial unix /var/run/docker.sock: connect: permission denied

I am unable to get this going in any kind of reasonable time - the README needs a complete rewrite to have a clear approach to installing the software..

[houli]

Hi Andrew, all of the issues relating to docker and docker-compsose commands are related to not running with sudo. We stated this at the top of our README file

For Docker installations on Ubuntu sudo is required to run Docker and Docker Compose commands.

[houli]

In terms of the platforms we are supporting (Windows, Mac, Linux) having to use sudo on linux is the exceptional case so we've left it out of the commands in the README and other documentation however we did leave a message before getting into any of the installation instructions for people using linux to run the software

[andrewbutterfield]

I see that but forget as I wade through the material below. Given that Ubuntu 16.0.4 has been specified as the target platform for this project, please update the README to use the commands as required on Ubuntu We'll discuss this on Wed, but the README needs to be re-written - it is far to confusing as it stands. Most of the other groups have something like install.sh that does all the work....

On 6 Mar 2017, at 15:28, Eoin Houlihan ***@***.***> wrote: Hi Andrew, all of the issues relating to docker and docker-compsose commands are related to not running with sudo. We stated this at the top of our README file For Docker installations on Ubuntu sudo is required to run Docker and Docker Compose commands. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#92 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAj59_WLt9Hh4MKe5WcUp7TYqFCHEfikks5rjCYrgaJpZM4MUSB7>.

Andrew Butterfield School of Computer Science & Statistics Trinity College Dublin 2, Ireland

[22a]

We have been linking to the official docker install instructions instead of hardcoding the commands in the readme as these commands change as docker is updated so it is standard industry practice to link to the most recent steps.

We do have a single command that does all the work, docker-compose up -d, the only prerequisite is that docker (and compose) be setup on your system. We didn't want to provide a script that attempts to install docker and compose every time you run the application as you have stated that the virtual machine does not get reset after each iteration/release so we assumed that docker was correctly installed.

Regardless, I have just ran the following 8 commands on a fresh Ubuntu 16.04.2 x64 virtual machine and it is running correctly on http://138.68.169.108:4000/. You can run the following commands to get the app up and running in your virtual machine:

1. Install docker

sudo apt-get -y install \
  apt-transport-https \
  ca-certificates \
  curl

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

sudo add-apt-repository \
       "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
       $(lsb_release -cs) \
       stable"

sudo apt-get update

sudo apt-get -y install docker-ce

2. Install compose

sudo curl -o /usr/local/bin/docker-compose -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m`

sudo chmod +x /usr/local/bin/docker-compose

3. Run our application

sudo docker-compose up -d

[22a]

@andrewbutterfield Apologies, I made an error in the last command. It needs to be run as sudo, I have edited the comment above but just in case you copy the command from an email please note that the last command should be:

sudo docker-compose up -d

[andrewbutterfield]

Why don't you simply segregate these commands into those that only need to run once, and those that need to run every time - and put into distinct scripts. e..g dependencies.sh and build.sh So on a new vm I do source depedencies.sh source build.sh sudo docker-compose up -d and off I go....

On 6 Mar 2017, at 16:10, Peter Meehan ***@***.***> wrote: We have been linking to the official docker install instructions instead of hardcoding the commands in the readme as these commands change as docker is updated so it is standard industry practice to link to the most recent steps. We do have a single command that does all the work, docker-compose up -d, the only prerequisite is that docker (and compose) be setup on your system. We didn't want to provide a script that attempts to install docker and compose every time you run the application as you have stated that the virtual machine does not get reset after each iteration/release so we assumed that docker was correctly installed. Regardless, I have just ran the following 8 commands on a fresh Ubuntu 16.04.2 x64 virtual machine and it is running correctly on http://138.68.169.108:4000/ <http://138.68.169.108:4000/>. You can run the following commands to get the app up and running in your virtual machine: Install docker sudo apt-get -y install \ apt-transport-https \ ca-certificates \ curl curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - sudo add-apt-repository \ "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ $(lsb_release -cs) \ stable" sudo apt-get update sudo apt-get -y install docker-ce Install compose sudo curl -o /usr/local/bin/docker-compose -L https://github.com/docker/compose/releases/download/1.11.2/docker-compose-`uname -s`-`uname -m` sudo chmod +x /usr/local/bin/docker-compose Run our application docker-compose up -d — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#92 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAj593xvJJ4YAbLSa7m0t4b0crLCseNkks5rjC_ygaJpZM4MUSB7>.

Andrew Butterfield School of Computer Science & Statistics Trinity College Dublin 2, Ireland

[c-brenn]

@andrewbutterfield We have made the requested changes on the realease 1 branch.

The readme should now be much clearer, and an install script for docker/docker-compose has been added.

See the unreleased section of the changelog for details.