Skip to content

Commit 504ead5

Browse files
aebrunoaebruno
authored
Merge pull request #69 from ubccr/formatting-fixes
Formatting fixes
2 parents fa1e411 + 7e2c838 commit 504ead5

3 files changed

Lines changed: 132 additions & 39 deletions

File tree

‎docs/docker_tips.md‎

Lines changed: 64 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,76 +3,121 @@
33
Some things you might find useful while using this setup:
44

55
### Docker Documentation
6+
67
https://docs.docker.com
78

89
### Install & Start Docker
10+
911
https://docs.docker.com/engine/install/
1012

1113
**NOTE: You'll need to make sure the account you're running docker with is in the 'docker' group**
1214

1315
### Install Docker Compose
16+
1417
https://docs.docker.com/compose/install/
1518

1619
### Verify working Docker
17-
`docker info`
20+
21+
```
22+
docker info
23+
```
24+
1825
**This should display your system info along with Docker-specific info. If there are any errors, stop/start Docker**
1926

2027
### Error when starting up tutorial containers
2128

2229
If you get this error when starting the tutorial
23-
`ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?`
30+
31+
```
32+
ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?
33+
2434
or
25-
`ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?`
35+
36+
ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?
37+
```
2638

2739
Try stopping and starting Docker (restart doesn't usually fix the problem). Commands for this differ depending on operating system.
2840

29-
If the error persists, try:
30-
`export DOCKER_HOST=127.0.0.1`
41+
If the error persists, try:
42+
43+
```
44+
export DOCKER_HOST=127.0.0.1
45+
```
46+
3147
NOTE: this is only necessary on some systems so don't use it if the previous command works
3248

3349
**Sometimes restarting your operating system is the only solution.**
3450

3551
### Docker Troubleshooting
52+
3653
Linux: https://docs.docker.com/engine/install/linux-postinstall/
3754
MacOS - Docker Desktop: https://docs.docker.com/docker-for-mac/troubleshoot/
3855
Windows - Docker Desktop: https://docs.docker.com/docker-for-windows/troubleshoot/
3956

4057
### Display Docker processes
41-
`docker ps -a`
58+
59+
```
60+
docker ps -a
61+
```
4262

4363
### Display Tutorial Container Logs
44-
`docker-compose logs -f`
64+
65+
```
66+
docker-compose logs -f
67+
```
4568

4669
### Display Docker containers
47-
`docker container list`
70+
71+
```
72+
docker container list
73+
```
4874

4975
### Display Docker images
50-
`docker image list`
76+
77+
```
78+
docker image list
79+
```
5180

5281
### Display Docker volumes
53-
`docker volume list`
82+
83+
```
84+
docker volume list
85+
```
5486

5587
### Shutting down the tutorial containers
88+
5689
**NOTE: This is the preferred method to stop/start or tear down the tutorial setup as the containers rely on each other and stopping, starting or deleting them individually usually has unintended side effects**
5790

5891
To tear down all containers and remove the volumes:
59-
`./hpcts stop`
92+
93+
```
94+
./hpcts stop
95+
```
6096

6197
To tear down all containers, remove volumes, and remove the container images (next time you run start they will be re-downloaded):
62-
`./hpcts cleanup`
98+
99+
```
100+
./hpcts cleanup
101+
```
63102

64103
### Starting everything up again
65104

66-
`./hpcts start`
105+
```
106+
./hpcts start
107+
```
67108

68109
### Deleting Docker containers/images/volumes manually
110+
69111
If you really want to clean up images and start fresh:
70-
`docker image list`
71-
`docker image rm XX` (XX=image id)
72-
`docker container list`
73-
`docker container rm XX` (XX=container id)
74-
`docker volume list`
75-
`docker volume rm XX` (XX=volume id)
112+
113+
```
114+
docker image list
115+
docker image rm XX (XX=image id)
116+
docker container list
117+
docker container rm XX (XX=container id)
118+
docker volume list
119+
docker volume rm XX (XX=volume id)
120+
```
76121

77122
If you're getting an error about volumes in use but there is nothing running, stop docker, manually delete the files, and start docker again. These commands are different depending on the operating system so we recommend using your favorite search provider to locate instructions for this.
78123

‎docs/getting_started.md‎

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,21 @@ An overview of the containers in the cluster:
77
![Container Overview](HPC-Toolset-sm.png)
88

99
## Requirements
10+
1011
If you haven't already installed and tested the required packages, please refer to the [requirements page](requirements.md)
1112

1213
## Getting started
1314

1415
You will need to clone the tutorial repo and then run the helper script. The first time running this, you'll be downloading all the containers from Docker Hub. This can take quite a long time depending on your network speed. The images total approximately 7GB in size. Once the containers are downloaded, they are started and the services launched. For point of reference: on a recent test from a home fiber optic network this download and container startup process took 17 minutes.
1516

1617
NOTE: For Windows, if you haven't already done so, you will need to configure git not to convert line endings into Windows format. Run this command using the git-bash shell application before cloning the tutorial repo:
18+
1719
```
1820
git config --global core.autocrlf input
1921
```
2022

2123
### Clone Repo and Start Containers
24+
2225
```
2326
$ git clone https://github.com/ubccr/hpc-toolset-tutorial.git
2427
$ cd hpc-toolset-tutorial
@@ -73,6 +76,7 @@ Login to frontend: ssh -p 6222 hpcadmin@localhost
7376
7477
7578
```
79+
7680
**NOTE: Despite seeing this output with URLs, the processes on these containers may not be fully running yet. Depending on the speed of your computer, starting up the processes may take a few minutes (or even up to 10 minutes). Use the command below to check the docker logs if the websites are not yet displaying.**
7781

7882
NOTE: Windows users will get several pop-up messages from Docker Desktop during this process asking to allow local system access to the Docker containers. Please click the "Share it" button:
@@ -81,21 +85,31 @@ NOTE: Windows users will get several pop-up messages from Docker Desktop during
8185

8286
### Error when starting up tutorial containers
8387

84-
If you get this error when starting the tutorial
85-
`ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?`
88+
If you get this error when starting the tutorial:
89+
90+
```
91+
ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?
92+
8693
or
87-
`ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?`
94+
95+
ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?
96+
```
8897

8998
Try stopping and starting Docker (restart doesn't usually fix the problem). Commands for this differ depending on operating system.
9099

91100
If the error persists, try:
92-
`export DOCKER_HOST=127.0.0.1`
101+
102+
```
103+
export DOCKER_HOST=127.0.0.1
104+
```
105+
93106
NOTE: this is only necessary on some systems so don't use it if the previous command works
94107

95108
**Sometimes restarting your operating system is the only solution.**
96109

97110

98111
### Docker Logs
112+
99113
Once the helper script finishes you can check the status of the containers:
100114

101115
```
@@ -117,28 +131,44 @@ xdmod | ---> Starting XDMoD...
117131
```
118132

119133
## Something still not right?
134+
120135
If errors are showing up in the logs or the services have not all started, check to see which images have been downloaded and which containers are running. This is what you should see:
121136
![](containers_images.PNG)
122137

123138
If not, run the 'stop' option of the helper script to shut everything down and remove all volumes. Then start everything back up again:
124-
`./hpcts stop`
125-
`docker container list`
126-
Should show no containers
127-
`docker volume list`
128-
Should show no volumes
129-
If either do, you should run the corresponding remove command:
130-
`docker container rm [ContainerID]`
131-
`docker volume rm [VolumeName]`
139+
140+
```
141+
$ ./hpcts stop
142+
$ docker container list
143+
(Should show no containers)
144+
145+
$ docker volume list
146+
(Should show no volumes)
147+
```
148+
149+
If either of the above do, you should run the corresponding remove command:
150+
151+
```
152+
$ docker container rm [ContainerID]
153+
$ docker volume rm [VolumeName]
154+
```
155+
132156
Then start it all up again:
133-
`./hpcts start`
157+
158+
```
159+
./hpcts start
160+
```
161+
134162
Since you already downloaded all the images, this command will only startup the containers and services which only takes a few minutes.
135163

136164
To completely start over, run:
137-
`./hpcts cleanup`
138-
`./hpcts start`
139165

140-
Just in case none of this worked here are [more Docker tips](docker_tips.md)
166+
```
167+
$ ./hpcts cleanup
168+
$ ./hpcts start
169+
```
141170

171+
Just in case none of this worked here are [more Docker tips](docker_tips.md)
142172

143173

144174
## Tutorial Navigation

‎docs/requirements.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,61 @@ For this tutorial you will need to have **12GB of free disk space** and git, doc
88

99

1010
NOTE: For Windows, if you haven't already done so, you will need to configure git not to convert line endings into Windows format. Run this command using the git-bash shell application before cloning the tutorial repo:
11+
1112
```
1213
git config --global core.autocrlf input
1314
```
1415

1516
### Install & Start Docker
17+
1618
https://docs.docker.com/engine/install/
1719

1820
**NOTE: You'll need to make sure the account you're running docker with is in the 'docker' group**
1921

2022
### Install Docker Compose
23+
2124
https://docs.docker.com/compose/install/
2225

2326
### Verify working Docker
24-
`docker info`
27+
28+
```
29+
docker info
30+
```
31+
2532
**This should display your system info along with Docker-specific info. If there are any errors, stop/start Docker. Do NOT proceed with the tutorial until you are sure you have a working Docker setup**
2633

2734

2835
### Error when running 'docker info' or when starting up tutorial containers
2936

3037
If you get this error when starting the tutorial
31-
`ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?`
38+
39+
```
40+
ERROR: Couldn't connect to Docker daemon at http+docker://localunixsocket - is it running?
41+
3242
or
33-
`ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?`
43+
44+
ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?
45+
```
3446

3547
Try stopping and starting Docker (restart doesn't usually fix the problem). Commands for this differ depending on operating system.
3648

3749
If the error persists, try:
38-
`export DOCKER_HOST=127.0.0.1`
50+
51+
```
52+
export DOCKER_HOST=127.0.0.1
53+
```
54+
3955
NOTE: this is only necessary on some systems so don't use it if the previous command works
4056

4157
## Docker Tips
58+
4259
Some useful info on installing Docker, navigating this tutorial and learning a bit about docker-compose
4360

4461
[Docker Tips](docker_tips.md)
4562
[Docker Compose Tutorial](https://youtu.be/DX1T-PKHKhg) *Unaffiliated with us but a very good overview of Docker Compose*
4663

4764

4865
## Tutorial Navigation
66+
4967
[Next - Getting Started](getting_started.md)
5068
[Back to Start](../README.md)

0 commit comments

Comments
 (0)