Skip to content

Commit 9916d04

Browse files
committed
Modifications for half day tutorial
1 parent bdee951 commit 9916d04

3 files changed

Lines changed: 29 additions & 13 deletions

File tree

coldfront/README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
- This is where you'd enable or disable any plugins and set variables for your local installation. Check out the [full configuration options available in the ColdFront documentation](https://coldfront.readthedocs.io/en/latest/config/)
55
- View `hpc-toolset-tutorial/coldfront/coldfront-nginx.conf` for an example of ColdFront web configuration
66

7+
### Seed ColdFront with data for tutorial
8+
This step allows you to skip the next section and go right into testing out ColdFront. This will seed the ColdFront database with user permissions and resources. If you'd like to see how this is done (because you'll need to do this if you install for your organization), you can skip this and go through the steps in the next section.
9+
10+
```
11+
cat coldfront.dump | docker exec -i mysql mysql --user coldfrontapp --password=9obCuAphabeg coldfront
12+
```
713

814
### Login to ColdFront, setup account permissions & create resource
915
URL https://localhost:2443/
@@ -13,7 +19,9 @@ You'll need to login as some of the users for this tutorial to get things starte
1319
- Login locally as username `cgray` password: `test123`
1420
- Logout
1521
- Login locally as username `csimmons` password: `ilovelinux`
22+
- Logout
1623
- Login locally as username `sfoster` password: `ilovelinux`
24+
- Logout
1725
- Login locally as username `admin` password: `admin`
1826
- Go to Admin menu and click on `ColdFront Administration` Once there, scroll halfway down to the `Authentication and Authorization` section. Then click on the `Users` link.
1927
- Click on the hpcadmin user and scroll down to the `Permissions` section
@@ -29,7 +37,7 @@ You'll need to login as some of the users for this tutorial to get things starte
2937
- Click on the Home link to go to back to the Admin interface, scroll to the bottom of the page under the `User` section and click `User Profiles`
3038
- Click on `cgray` check ``"Is pi"`` - click SAVE
3139

32-
Create a new resource:
40+
Create a new cluster resource:
3341
- Click on the Home link to go to back to the Admin interface, scroll down near the bottom to the `Resource` section and Click on `Resources` then click the `Add Resource` button
3442
- Add a resource with the following settings:
3543
Resource type: select `cluster`
@@ -41,8 +49,20 @@ Click `Add another Resource attribute` and select `OnDemand` from the drop down
4149
- Then click SAVE
4250
**See more info on the OnDemand plugin at the end**
4351

52+
Create a new storage resource:
53+
- Click on the Home link to go to back to the Admin interface, scroll down near the bottom to the `Resource` section and Click on `Resources` then click the `Add Resource` button
54+
- Add a resource with the following settings:
55+
Resource type: select `storage`
56+
Name: type `project storage`
57+
Description: enter anything you want
58+
Ensure that the following are checked: `Is available`, `Is public`, `Is allocatable`
59+
Under the resource attributes section, click `Add another Resource attribute` and select `quantity_label` from the drop down menu. In the `value` field, enter `Enter storage in 1TB increments`
60+
Click `Add another Resource attribute` and select `quantity_default_value` from the drop down menu. In the `1`
61+
Click `Add another Resource attribute` and select `OnDemand` from the drop down menu. In the `value` field, enter `Yes`
62+
- Then click SAVE
63+
4464
Make an allocation attribute changeable:
45-
- Under the `Allocation` section, click on `Allocation Attribute Types` Click on `slurm_account_name` check the box next to `Is changeable` and then click the SAVE button.
65+
- Under the `Allocation` section, click on `Allocation Attribute Types` Click on `Storage Quota` check the box next to `Is changeable` and then click the SAVE button.
4666
- Logout
4767

4868
### Create a project & request an allocation

docs/requirements.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ For this tutorial you will need to have **20GB of free disk space** and git, doc
44

55
- git 2.17+ (Windows users we recommend: https://gitforwindows.org/)
66
- docker engine version 20.10.12+
7-
- docker-compose 2.6.0+
7+
- docker compose 2.6.0+ (this is distributed with newer versions of docker and not necessary to install separately)
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

@@ -29,10 +29,6 @@ https://docs.docker.com/engine/install/
2929

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

32-
### Install Docker Compose
33-
34-
https://docs.docker.com/compose/install/
35-
3632
### Verify working Docker
3733

3834
```

hpcts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ log_warn() {
1010

1111
start() {
1212
log_info "Fetching latest HPC Toolset Images.."
13-
docker-compose pull
13+
docker compose pull
1414

1515
log_info "Starting HPC Toolset Cluster.."
16-
docker-compose up -d --no-build
16+
docker compose up -d --no-build
1717

1818
log_info "Coldfront URL: https://localhost:2443"
1919
log_info "OnDemand URL: https://localhost:3443"
@@ -23,14 +23,14 @@ start() {
2323

2424
stop() {
2525
log_info "Stopping HPC Toolset Cluster containers.."
26-
docker-compose stop
26+
docker compose stop
2727
}
2828

2929
destroy() {
3030
log_info "Stopping and removing HPC Toolset Cluster containers and volumes.."
31-
docker-compose stop && \
32-
docker-compose rm -f -v && \
33-
docker-compose down -v
31+
docker compose stop && \
32+
docker compose rm -f -v && \
33+
docker compose down -v
3434
}
3535

3636
cleanup() {

0 commit comments

Comments
 (0)