Skip to content

Commit fa1fcc0

Browse files
aebrunoaebruno
authored
Merge pull request #129 from dsajdak/master
Updates to various instruction pages
2 parents 5b0b6e7 + cfd72c2 commit fa1fcc0

9 files changed

Lines changed: 91 additions & 40 deletions

‎docs/acknowledgments.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ A condensed version of this tutorial will be presented at [Gateways 2020](https:
2222

2323
An updated version of this tutorial was presented at the PRACTICE AND EXPERIENCE IN ADVANCED RESEARCH COMPUTING 2021 Virtual Conference (PEARC21) - https://pearc.acm.org/pearc21/
2424

25+
An updated version of this tutorial was presented at the PRACTICE AND EXPERIENCE IN ADVANCED RESEARCH COMPUTING 2022 Conference (PEARC22), Boston, MA - https://pearc.acm.org/pearc22/
26+
2527

2628
#### Container Development
2729

‎docs/applications.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Because these applications are configured for single-sign on (SSO), if you login
3333
ColdFront is used for managing center resources and providing access to those resources
3434

3535
SSH container name: coldfront (must login to front end first)
36-
URL:https://localhost:2443
36+
URL: https://localhost:2443
3737
*Portal logins include:*
3838
Local administrator account: `admin` password: `admin`
3939
Any of the LDAP accounts listed above

‎docs/containers_images.PNG‎

-34.9 KB
Loading

‎docs/docker_tips.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,30 @@ NOTE: this is only necessary on some systems so don't use it if the previous com
4848

4949
**Sometimes restarting your operating system is the only solution.**
5050

51+
### Windows Errors
52+
53+
NOTE: Windows users should 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:
54+
![](windows_sharing.PNG)
55+
56+
If you have notifications blocked, you may not see these pop-ups and the authorization will eventually time out. If this happens, you will get this type of error message:
57+
58+
```
59+
Error response from daemon: user declined directory sharing C:\Users\path_to_my_folder
60+
```
61+
Open Docker Desktop, navigate to Settings - Resources, and click on File Sharing. Then add the directory where you've cloned the HPC Toolset Tutorial and click "Apply & Restart"
62+
63+
Re-run:
64+
```
65+
./hpcts start
66+
```
67+
68+
If this doesn't work, please run:
69+
```
70+
./hpcts cleanup
71+
./hpcts start
72+
```
73+
74+
5175
### Docker Troubleshooting
5276

5377
Linux: https://docs.docker.com/engine/install/linux-postinstall/

‎docs/getting_started.md‎

Lines changed: 62 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -28,60 +28,85 @@ $ cd hpc-toolset-tutorial
2828
$ ./hpcts start
2929
Fetching latest HPC Toolset Images..
3030
31-
Pulling ldap ... done
32-
Pulling base ... done
33-
Pulling mongodb ... done
34-
Pulling mysql ... done
35-
Pulling slurmdbd ... done
36-
Pulling slurmctld ... done
37-
Pulling cpn01 ... done
38-
Pulling cpn02 ... done
39-
Pulling frontend ... done
40-
Pulling coldfront ... done
41-
Pulling ondemand ... done
42-
Pulling xdmod ... done
31+
[+] Running 12/12
32+
- base Pulled 5.2s
33+
- ondemand Pulled 5.3s
34+
- cpn01 Pulled 5.3s
35+
- cpn02 Pulled 5.1s
36+
- mongodb Pulled 5.2s
37+
- xdmod Pulled 5.1s
38+
- ldap Pulled 5.2s
39+
- mysql Pulled 5.2s
40+
- coldfront Pulled 5.2s
41+
- frontend Pulled 5.2s
42+
- slurmdbd Pulled 5.1s
43+
- slurmctld Pulled 5.2s
4344
4445
Starting HPC Toolset Cluster..
4546
46-
Creating network "hpc-toolset-tutorial_compute" with the default driver
47-
Creating volume "hpc-toolset-tutorial_etc_munge" with default driver
48-
Creating volume "hpc-toolset-tutorial_etc_slurm" with default driver
49-
Creating volume "hpc-toolset-tutorial_home" with default driver
50-
Creating volume "hpc-toolset-tutorial_var_lib_mysql" with default driver
51-
Creating volume "hpc-toolset-tutorial_data_db" with default driver
52-
Creating volume "hpc-toolset-tutorial_srv_www" with default driver
53-
Creating mysql ... done
54-
Creating ldap ... done
55-
Creating mongodb ... done
56-
Creating hpc-toolset-tutorial_base_1 ... done
57-
Creating slurmdbd ... done
58-
Creating slurmctld ... done
59-
Creating frontend ... done
60-
Creating cpn02 ... done
61-
Creating cpn01 ... done
62-
Creating coldfront ... done
63-
Creating xdmod ... done
64-
Creating ondemand ... done
47+
[+] Running 23/23
48+
- Network hpc-toolset-tutorial_compute Created 0.1s
49+
- Volume "hpc-toolset-tutorial_etc_slurm" Created 0.0s
50+
- Volume "hpc-toolset-tutorial_cpn02_slurmd_state" Created 0.0s
51+
- Volume "hpc-toolset-tutorial_slurmdbd_state" Created 0.0s
52+
- Volume "hpc-toolset-tutorial_slurmctld_state" Created 0.0s
53+
- Volume "hpc-toolset-tutorial_data_db" Created 0.0s
54+
- Volume "hpc-toolset-tutorial_home" Created 0.0s
55+
- Volume "hpc-toolset-tutorial_var_lib_mysql" Created 0.0s
56+
- Volume "hpc-toolset-tutorial_srv_www" Created 0.0s
57+
- Volume "hpc-toolset-tutorial_cpn01_slurmd_state" Created 0.0s
58+
- Volume "hpc-toolset-tutorial_etc_munge" Created 0.0s
59+
- Container mongodb Started 12.0s
60+
- Container mysql Started 11.9s
61+
- Container ldap Started 11.8s
62+
- Container hpc-toolset-tutorial-base-1 Started 12.3s
63+
- Container slurmdbd Started 13.2s
64+
- Container slurmctld Started 13.0s
65+
- Container frontend Started 15.2s
66+
- Container cpn02 Started 14.2s
67+
- Container cpn01 Started 15.2s
68+
- Container ondemand Started 15.2s
69+
- Container coldfront Started 15.7s
70+
- Container xdmod Started 15.5s
6571
66-
Coldfront URL: https://localhost:2443
72+
Coldfront URL: https://localhost:2443
6773
6874
69-
OnDemand URL: https://localhost:3443
75+
OnDemand URL: https://localhost:3443
7076
7177
72-
XDMoD URL: https://localhost:4443
78+
XDMoD URL: https://localhost:4443
7379
7480
75-
Login to frontend: ssh -p 6222 hpcadmin@localhost
76-
81+
Login to frontend: ssh -p 6222 hpcadmin@localhost
7782
7883
```
7984

8085
**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.**
8186

82-
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:
87+
### Windows Errors
88+
89+
NOTE: Windows users should 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:
8390
![](windows_sharing.PNG)
8491

92+
If you have notifications blocked, you may not see these pop-ups and the authorization will eventually time out. If this happens, you will get this type of error message:
93+
94+
```
95+
Error response from daemon: user declined directory sharing C:\Users\path_to_my_folder
96+
```
97+
Open Docker Desktop, navigate to Settings - Resources, and click on File Sharing. Then add the directory where you've cloned the HPC Toolset Tutorial and click "Apply & Restart"
98+
99+
Re-run:
100+
```
101+
./hpcts start
102+
```
103+
104+
If this doesn't work, please run:
105+
```
106+
./hpcts cleanup
107+
./hpcts start
108+
```
109+
85110

86111
### Error when starting up tutorial containers
87112

‎docs/requirements.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
For this tutorial you will need to have **13GB of free disk space** and git, docker, docker-compose and a web browser installed on your local machine. This tutorial has been tested on various versions of Linux, MacOS, and Windows 10 with the following package versions:
44

55
- git 2.17+ (Windows users we recommend: https://gitforwindows.org/)
6-
- docker version 19.03.8+
7-
- docker-compose 1.25.2+
6+
- docker engine version 20.10.12+
7+
- docker-compose 2.6.0+
88

99
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:
1010

‎docs/xdmod_empty.PNG‎

-58.5 KB
Binary file not shown.

‎docs/xdmod_jobs.PNG‎

-89.8 KB
Binary file not shown.

‎docs/xdmod_login.PNG‎

-50.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)