Skip to content

Commit 0cd0941

Browse files
committed
wip
1 parent dc9ad3d commit 0cd0941

File tree

2 files changed

+33
-46
lines changed

2 files changed

+33
-46
lines changed

docs/alps/storage.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -45,45 +45,9 @@ All users on Alps get their own scratch path on Alps, `/capstor/scratch/cscs/$US
4545
[](){#ref-alps-capstor-store}
4646
### Store
4747

48-
The Store mount point on Capstor provides stable storage with [backups][ref-storage-backups] and no [cleaning policy][ref-storage-cleanup].
48+
The [Store][ref-storage-store] mount point on Capstor provides stable storage with [backups][ref-storage-backups] and no [cleaning policy][ref-storage-cleanup].
4949
It is mounted on clusters at the `/capstor/store` mount point, with folders created for each project.
5050

51-
To accomodate the different customers and projects on Alps, the directory structure is more complicated than the per-user paths on Scratch.
52-
Project paths are organised as follows:
53-
54-
```
55-
/capstor/store/<tenant>/<customer>/<group_id>
56-
```
57-
58-
!!! question "What are `tenant`, `customer` and `group_id` in this context?"
59-
60-
* **`tenant`**: there are currently two tenants, `cscs` and `mch`:
61-
* the vast majority of projects are hosted by the `cscs` tenant.
62-
* **`customer`**: refers to the contractual partner responsible for the project.
63-
Examples of customers include:
64-
* `userlab`: projects allocated in the CSCS User Lab through open calls. The majority of projects are hosted here, particularly on the [HPC platform][ref-platform-hpcp].
65-
* `swissai`: most projects allocated on the [Machine Learning Platform][ref-platform-mlp].
66-
* `2go`: projects allocated under the [CSCS2GO](https://2go.cscs.ch) scheme.
67-
* **`group_id`**: refers to the linux group created for the project.
68-
69-
Users often are part of multiple projects, and by extension their associated `groupd_id` groups.
70-
You can get a list of your groups using the `id` command in the terminal:
71-
```console
72-
$ id $USER
73-
uid=12345(bobsmith) gid=32819(g152) groups=32819(g152),33119(g174),32336(vasp6)
74-
```
75-
Here the user `bobsmith` is in three projects (`g152`, `g174` and `vasp6`), with the project `g152` being their **primary project**.
76-
77-
!!! example "How do I find my primary project?"
78-
In the terminal, use the following command to find your primary group:
79-
```console
80-
$ id -gn $USER
81-
g152
82-
```
83-
84-
!!! info "The `$STORE` environment variable"
85-
On some clusters, for example, [Eiger][ref-cluster-eiger] and [Daint][ref-cluster-daint], the project folder for your primary project can be accessed using the `$STORE` environment variable.
86-
8751
[](){#ref-alps-iopsstor}
8852
## Iopsstor
8953

docs/storage/filesystems.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,37 @@ Please ensure that you move important data to a file system with backups, for ex
125125
Store is a large, medium-performance, storage on the [Capstor][ref-alps-capstor] Lustre file system for sharing data within a project, and for medium term data storage.
126126

127127
Space on Store is allocated per-project, with a path created for each project.
128+
To accomodate the different customers and projects on Alps, the project paths are organised as follows:
129+
130+
```
131+
/capstor/store/<tenant>/<customer>/<group_id>
132+
```
133+
134+
* **`tenant`**: there are currently two tenants, `cscs` and `mch`:
135+
* the vast majority of projects are hosted by the `cscs` tenant.
136+
* **`customer`**: refers to the contractual partner responsible for the project.
137+
Examples of customers include:
138+
* `userlab`: projects allocated in the CSCS User Lab through open calls. The majority of projects are hosted here, particularly on the [HPC platform][ref-platform-hpcp].
139+
* `swissai`: most projects allocated on the [Machine Learning Platform][ref-platform-mlp].
140+
* `2go`: projects allocated under the [CSCS2GO](https://2go.cscs.ch) scheme.
141+
* **`group_id`**: refers to the linux group created for the project.
142+
143+
??? example "Which groups and projects am I a member of?"
144+
Users often are part of multiple projects, and by extension their associated `groupd_id` groups.
145+
You can get a list of your groups using the `id` command in the terminal:
146+
```console
147+
$ id $USER
148+
uid=12345(bobsmith) gid=32819(g152) groups=32819(g152),33119(g174),32336(vasp6)
149+
```
150+
Here the user `bobsmith` is in three projects (`g152`, `g174` and `vasp6`), with the project `g152` being their **primary project**.
151+
In the terminal, use the following command to find your **primary group**:
152+
```console
153+
$ id -gn $USER
154+
g152
155+
```
128156

129-
!!! info
130-
More information about how per-project paths are organised on Store is available on the [Capstor][ref-alps-capstor-store] documentation.
157+
!!! info "The `$STORE` environment variable"
158+
On some clusters, for example, [Eiger][ref-cluster-eiger] and [Daint][ref-cluster-daint], the project folder for your primary project can be accessed using the `$STORE` environment variable.
131159

132160
!!! warning "Avoid using Store for jobs"
133161
Store is tuned for storing results and shared datasets, specifically it has fewer meta data servers assigned to it.
@@ -140,13 +168,8 @@ There is no [cleanup policy][ref-storage-cleanup] on Store, and the contents are
140168

141169
### Quota
142170

143-
Space on Store is allocated per-project, with a path created for each project:
144-
145-
* the [quota][ref-storage-quota] limit is per-project, based on the initial resource request;
146-
* users have read and write access to the Store paths for each project that they are a member of.
147-
148-
!!! info
149-
You can check the quota on Store for all of your projects using the [`quota`][ref-storage-quota-cli] tool.
171+
Paths on Store is allocated per-project: a path is created for each project with a [quota][ref-storage-quota] based on the initial resource request.
172+
Users have read and write access to the Store paths for each project that they are a member of, and you can check the quota on Store for all of your projects using the [`quota`][ref-storage-quota-cli] tool.
150173

151174
### Backups
152175

0 commit comments

Comments
 (0)