Skip to content
This repository was archived by the owner on Mar 29, 2022. It is now read-only.

Commit 1199e73

Browse files
committed
stubbing out new app building process
1 parent 4d9421e commit 1199e73

File tree

5 files changed

+112
-22
lines changed

5 files changed

+112
-22
lines changed

docs/03.apps_ci_jenkins.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: page
3+
title: Continuous Integration with Jenkins
4+
tagline:
5+
---
6+
7+
Intro text.
8+
9+
1. List element 1
10+
2. List element 2
11+
3. List element 3
12+
13+
14+
<br>
15+
#### Header 1
16+
17+
```
18+
% code block
19+
```
20+
21+
22+
<br>
23+
#### Header 2
24+
25+
[Example link](https://url/)
26+
27+
28+
<br>
29+
#### Header 3
30+
31+
32+
33+
---
34+
Return to the [API Documentation Overview](../index.md)

docs/03.apps_deploy.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: page
3+
title: "Deploy a Custom Application"
4+
tagline: Apps-Deploy
5+
---
6+
7+
Intro text.
8+
9+
1. List element 1
10+
2. List element 2
11+
3. List element 3
12+
13+
14+
<br>
15+
#### Header 1
16+
17+
```
18+
% code block
19+
```
20+
21+
22+
<br>
23+
#### Header 2
24+
25+
[Example link](https://url/)
26+
27+
28+
<br>
29+
#### Header 3
30+
31+
32+
33+
---
34+
Return to the [API Documentation Overview](../index.md)

docs/03.apps_init.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: Title Here
4-
tagline:
3+
title: "Create a Custom Application"
4+
tagline: Apps-Init
55
---
66

77
Intro text.
@@ -22,7 +22,7 @@ Intro text.
2222
<br>
2323
#### Header 2
2424

25-
[Example link](https://url/)
25+
[Example link](https://url/)
2626

2727

2828
<br>

docs/singularity_gpu_01.md renamed to docs/05.container_gpu.md

+23-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
layout: page
3-
title: Utilizing GPUs with Singularity
3+
title: Run Containers on GPUs
44
tagline:
55
---
66

77
Utilizing GPGPUs on the Maverick supercomputer through containerized environments.
88

9-
## Choosing the Right System
9+
<br>
10+
#### Choosing the Right System
1011

1112
You can register your app to ANY system at TACC, but Maverick may not always be the best choice if you don't always need GPUs.
1213

@@ -19,18 +20,19 @@ You can register your app to ANY system at TACC, but Maverick may not always be
1920
| Wrangler | 24 | SSD Filesystem for fast I/O, Hosted Databases, Hadoop, HDFS | Low node-count |
2021
| Jetstream | 24 | Long running instances, root access | Limited storage |
2122
| Maverick | 20 | GPUs, high memory nodes | Deprecated software stack |
22-
| Chameleon | Variable | GPUs, bare metal VM, software defined networking | Difficult to configure |
23+
| Chameleon | Variable | GPUs, bare metal VM, software defined networking | Difficult to configure |
2324
| Catapult | 16 | FPGAs | Windows-only |
2425

2526
You can learn about all choices at the [TACC Systems Overview](https://www.tacc.utexas.edu/systems/overview). Detailed specifications can be found in the *User Guide* of each system.
2627

2728
If you have an application already configured on a non-tacc system, you can register that system to the SD2E agave tenant.
2829

29-
- [System Registration Guide](https://sd2e.github.io/api-user-guide/docs/create_systems.html)
30+
- [System Registration Guide](02.create_systems.html)
3031

3132
After registration, you can not only run applications, but access data as well. Just remember that applications will run as YOUR user when you share them with others.
3233

33-
## Containers @ TACC
34+
<br>
35+
#### Containers @ TACC
3436

3537
TACC supports containerized compute environments through [Singularity](http://singularity.lbl.gov/), which provides environment encapsulation without privilege escalation (root). Singularity provides the following functionality:
3638

@@ -46,7 +48,8 @@ TACC supports containerized compute environments through [Singularity](http://si
4648

4749
Since version 2.3, Singularity has supported the two following workflows
4850

49-
### Local Container Development
51+
<br>
52+
##### Local Container Development
5053

5154
Create a Singularity container from scratch.
5255

@@ -58,7 +61,8 @@ Create a Singularity container from scratch.
5861

5962
<http://singularity.lbl.gov/archive/docs/v2-3/bootstrap-image>
6063

61-
### Docker Import
64+
<br>
65+
##### Docker Import
6266

6367
Utilize your knowledge of Docker to create Singularity images.
6468

@@ -67,15 +71,17 @@ Utilize your knowledge of Docker to create Singularity images.
6771

6872
<http://singularity.lbl.gov/archive/docs/v2-3/docs-docker>
6973

70-
### Running the container
74+
<br>
75+
##### Running the container
7176

7277
These containers are run without root, so you simply
7378

7479
- run - Run the default functionality of the container, which takes in arguments
7580
- exec - Execute a specific command inside the container, and then exit
7681
- shell - Enter the container and interactively run commands
7782

78-
## GPU containers
83+
<br>
84+
#### GPU containers
7985

8086
Since Singularity supported docker containers, it has been fairly simple to utilize GPUs for machine learning code like [TensorFlow](https://www.tensorflow.org/). From Maverick, which is TACC's GPU system:
8187

@@ -86,7 +92,7 @@ idev -m 60
8692
module load tacc-singularity
8793
# Pull your image
8894
singularity pull docker://nvidia/caffe:latest
89-
#
95+
#
9096
singularity exec --nv caffe-latest.img caffe device_query -gpu 0
9197
```
9298

@@ -113,6 +119,11 @@ You probably noticed that we check out the models repository into your `$HOME` d
113119

114120
You may be thinking "what about overlayfs??". The Linux kernel on Maverick does not support overlayfs, so it had to be disabled in our singularity install.
115121

116-
## Build your APP
122+
<br>
123+
#### Build your APP
117124

118-
You can then use these methods in your [next Agave app](create_app.md).
125+
You can then use these methods in your [next Agave app](03.old_create_app.md).
126+
127+
128+
---
129+
Return to the [API Documentation Overview](../index.md)

index.md

+18-7
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ the SD2E platform. Documentation for getting started with the SD2E API is below.
4545

4646
&nbsp;&nbsp;**3 Agave Applications**
4747

48-
&nbsp;&nbsp;&nbsp;&nbsp;3.1 Create Custom Applications: Apps-Init (*coming soon*)
48+
&nbsp;&nbsp;&nbsp;&nbsp;3.1 [Create a Custom Application: Apps-Init](docs/03.apps_init.md)
4949

50-
&nbsp;&nbsp;&nbsp;&nbsp;3.2 Deploy Custom Applications: Apps-Deploy (*coming soon*)
50+
&nbsp;&nbsp;&nbsp;&nbsp;3.2 [Deploy a Custom Application: Apps-Deploy](docs/03.apps_deploy.md)
5151

5252
&nbsp;&nbsp;&nbsp;&nbsp;3.3 [Share an Application with Others](docs/03.share_app.md)
5353

5454
&nbsp;&nbsp;&nbsp;&nbsp;3.4 [Modify an Existing Application](docs/03.modify_app.md)
5555

56-
&nbsp;&nbsp;&nbsp;&nbsp;3.5 Continuous Integration with Jenkins (*coming soon*)
56+
&nbsp;&nbsp;&nbsp;&nbsp;3.5 [Continuous Integration with Jenkins](03.apps_ci_jenkins.md)
5757

5858
&nbsp;&nbsp;&nbsp;&nbsp;3.6 [Old App Building Process](docs/03.old_create_app.md) (*deprecated*)
5959

@@ -62,9 +62,9 @@ the SD2E platform. Documentation for getting started with the SD2E API is below.
6262

6363
&nbsp;&nbsp;&nbsp;&nbsp;4.1 Abaco CLI Basics (*coming soon*)
6464

65-
&nbsp;&nbsp;&nbsp;&nbsp;4.2 Create Custom Reactors: Abaco Init (*coming soon*)
65+
&nbsp;&nbsp;&nbsp;&nbsp;4.2 Create a Custom Reactor: Abaco Init (*coming soon*)
6666

67-
&nbsp;&nbsp;&nbsp;&nbsp;4.3 Deploy Custom Reactors: Abaco Deploy (*coming soon*)
67+
&nbsp;&nbsp;&nbsp;&nbsp;4.3 Deploy a Custom Reactor: Abaco Deploy (*coming soon*)
6868

6969
&nbsp;&nbsp;&nbsp;&nbsp;4.4 Share a Reactor with Others (*coming soon*)
7070

@@ -81,13 +81,24 @@ the SD2E platform. Documentation for getting started with the SD2E API is below.
8181

8282
&nbsp;&nbsp;&nbsp;&nbsp;5.3 Jupyter Notebooks (*coming soon*)
8383

84-
&nbsp;&nbsp;&nbsp;&nbsp;5.4 [Singularity GPGPU Containers](docs/singularity_gpu_01.md)
84+
&nbsp;&nbsp;&nbsp;&nbsp;5.4 [Run Containers on GPUs](docs/05.container_gpu.md)
8585

8686

87-
&nbsp;&nbsp;**6 Placeholder**
87+
&nbsp;&nbsp;**6 Other CLI Tools**
88+
89+
&nbsp;&nbsp;&nbsp;&nbsp;6.1 TACC Lab CLI (*coming soon*)
90+
91+
&nbsp;&nbsp;&nbsp;&nbsp;6.2 TACC Registry CLI (*coming soon*)
92+
8893

8994
&nbsp;&nbsp;**7 Reference Pages**
9095

96+
&nbsp;&nbsp;&nbsp;&nbsp;7.1 Base Images (*coming soon*)
97+
98+
&nbsp;&nbsp;&nbsp;&nbsp;7.2 Applications (*coming soon*)
99+
100+
&nbsp;&nbsp;&nbsp;&nbsp;7.3 Reactors (*coming soon*)
101+
91102

92103

93104
<br>

0 commit comments

Comments
 (0)