Skip to content

Commit 245a2d0

Browse files
review comments
Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
1 parent 025caa3 commit 245a2d0

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/guides/user-interactions/readme.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A user may include one or more Data Workflow directives in their job script to r
1111

1212
Once the job is running on compute nodes, the application can find access to Rabbit specific resources through a set of environment variables that provide mount and network access information.
1313

14-
## Directives
14+
## Commands
1515

1616
### jobdw
1717

@@ -23,8 +23,8 @@ The `jobdw` directive command tells the Rabbit software to create a file system
2323
| `type` | Yes | `raw`, `xfs`, `gfs2`, `lustre` | Type defines how the storage should be formatted. For Lustre file systems, a single file system is created that is mounted by all computes in the job. For raw, xfs, and GFS2 storage, a separate file system is allocated for each compute node. |
2424
| `capacity` | Yes | Allocation size with units. `1TiB`, `100GB`, etc. | Capacity interpretation varies by storage type. For Lustre file systems, capacity is the aggregate OST capacity. For raw, xfs, and GFS2 storage, capacity is the capacity of the file system for a single compute node. Capacity suffixes are: `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB` |
2525
| `name` | Yes | String including numbers and '-' | This is a name for the storage allocation that is unique within a job |
26-
| `profile` | No | Profile name | This specifies which profile to use when allocating storage. Profiles include `mkfs` and `mount` arguments, file system layout, and many other options. Profiles are created by admins. When no profile is specified, the default profile is used. |
27-
| `requires` | No | `copy-offload` | Using this option results in the copy offload daemon running on the compute nodes. This is for users that want to initiate data movement to or from the Rabbit storage from within their application |
26+
| `profile` | No | Profile name | This specifies which profile to use when allocating storage. Profiles include `mkfs` and `mount` arguments, file system layout, and many other options. Profiles are created by admins. When no profile is specified, the default profile is used. More information about storage profiles can be found in the [Storage Profiles](../storage-profiles/readme.md) guide. |
27+
| `requires` | No | `copy-offload` | Using this option results in the copy offload daemon running on the compute nodes. This is for users that want to initiate data movement to or from the Rabbit storage from within their application. See the [Required Daemons](../directive-breakdown/readme.md#requireddaemons) section of the [Directive Breakdown](../directive-breakdown/readme.md) guide for a description of how the user may request the daemon, in the case where the WLM will run it only on demand. |
2828

2929
#### Examples
3030

@@ -44,19 +44,19 @@ This directive results in a single 1TB Lustre file system being created that can
4444
#DW jobdw type=gfs2 capacity=50GB name=checkpoint requires=copy-offload
4545
```
4646

47-
This directive results in a 50GB GFS2 file system created for each compute node in the job using the default storage profile. The copy-offload daemon is started on the compute node to allow the application to request the Rabbit to move data from the GFS2 file system to another file system while the application is running.
47+
This directive results in a 50GB GFS2 file system created for each compute node in the job using the default storage profile. The copy-offload daemon is started on the compute node to allow the application to request the Rabbit to move data from the GFS2 file system to another file system while the application is running using the Copy Offload API.
4848

4949
### create_persistent
5050

51-
The `create_persistent` command results in a storage allocation on the Rabbit nodes that lasts beyond the lifetime of the job. This is useful for creating a file system that can share data between jobs. Only a single `create_persistent` directive is allowed in a job, and it cannot be in the same job as a `destroy_persistent` directive.
51+
The `create_persistent` command results in a storage allocation on the Rabbit nodes that lasts beyond the lifetime of the job. This is useful for creating a file system that can share data between jobs. Only a single `create_persistent` directive is allowed in a job, and it cannot be in the same job as a `destroy_persistent` directive. See [persistentdw](readme.md#persistentdw) to utilize the storage in a job.
5252

5353
#### Command Arguments
5454
| Argument | Required | Value | Notes |
5555
|----------|----------|-------|-------|
5656
| `type` | Yes | `raw`, `xfs`, `gfs2`, `lustre` | Type defines how the storage should be formatted. For Lustre file systems, a single file system is created. For raw, xfs, and GFS2 storage, a separate file system is allocated for each compute node in the job. |
5757
| `capacity` | Yes | Allocation size with units. `1TiB`, `100GB`, etc. | Capacity interpretation varies by storage type. For Lustre file systems, capacity is the aggregate OST capacity. For raw, xfs, and GFS2 storage, capacity is the capacity of the file system for a single compute node. Capacity suffixes are: `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB` |
58-
| `name` | Yes | String including numbers and '-' | This is a name for the storage allocation that is unique within the system |
59-
| `profile` | No | Profile name | This specifies which profile to use when allocating storage. Profiles include `mkfs` and `mount` arguments, file system layout, and many other options. Profiles are created by admins. When no profile is specified, the default profile is used. The profile used when creating the persistent storage allocation is the same profile used by jobs that use the persistent storage. |
58+
| `name` | Yes | Lowercase string including numbers and '-' | This is a name for the storage allocation that is unique within the system |
59+
| `profile` | No | Profile name | This specifies which profile to use when allocating storage. Profiles include `mkfs` and `mount` arguments, file system layout, and many other options. Profiles are created by admins. When no profile is specified, the default profile is used. The profile used when creating the persistent storage allocation is the same profile used by jobs that use the persistent storage. More information about storage profiles can be found in the [Storage Profiles](../storage-profiles/readme.md) guide.|
6060

6161
#### Examples
6262

@@ -78,7 +78,7 @@ The `destroy_persistent` command will delete persistent storage that was allocat
7878
#### Command Arguments
7979
| Argument | Required | Value | Notes |
8080
|----------|----------|-------|-------|
81-
| `name` | Yes | String including numbers and '-' | This is a name for the persistent storage allocation that will be destroyed |
81+
| `name` | Yes | Lowercase string including numbers and '-' | This is a name for the persistent storage allocation that will be destroyed |
8282

8383
#### Examples
8484

@@ -96,8 +96,8 @@ Persistent Lustre file systems can be accessed from any compute nodes in the sys
9696
#### Command Arguments
9797
| Argument | Required | Value | Notes |
9898
|----------|----------|-------|-------|
99-
| `name` | Yes | String including numbers and '-' | This is a name for the persistent storage that will be accessed |
100-
| `requires` | No | `copy-offload` | Using this option results in the copy offload daemon running on the compute nodes. This is for users that want to initiate data movement to or from the Rabbit storage from within their application |
99+
| `name` | Yes | Lowercase string including numbers and '-' | This is a name for the persistent storage that will be accessed |
100+
| `requires` | No | `copy-offload` | Using this option results in the copy offload daemon running on the compute nodes. This is for users that want to initiate data movement to or from the Rabbit storage from within their application. See the [Required Daemons](../directive-breakdown/readme.md#requireddaemons) section of the [Directive Breakdown](../directive-breakdown/readme.md) guide for a description of how the user may request the daemon, in the case where the WLM will run it only on demand. |
101101

102102
#### Examples
103103

@@ -135,7 +135,7 @@ This set of directives creates an xfs file system on the Rabbits for each comput
135135
#DW copy_out source=$DW_PERSISTENT_shared_data1/b destination=$DW_PERSISTENT_shared_data2/b profile=no-xattr
136136
```
137137

138-
This set of directives copies two directories from one persistent storage allocation to another persistent storage allocation using the `no-xattr` profile to avoid copying xattrs. This data movement occurs after the job application exits on the compute nodes, and the two copies do not occur in a guaranteed order.
138+
This set of directives copies two directories from one persistent storage allocation to another persistent storage allocation using the `no-xattr` profile to avoid copying xattrs. This data movement occurs after the job application exits on the compute nodes, and the two copies do not occur in a deterministic order.
139139

140140
```
141141
#DW persistentdw name=shared-data
@@ -147,7 +147,7 @@ This set of directives copies two directories from one persistent storage alloca
147147
#DW copy_out source=$DW_JOB_fast_storage/data destination=/lus/backup/johndoe/very_important_data profile=no-xattr
148148
```
149149

150-
This set of directives makes use of a persistent storage allocation and a job storage allocation. There are two `copy_in` directives, one that copies data from the global lustre file system to the job allocation, and another that copies data from the persistent allocation to the job allocation. These copies do not occur in a guaranteed order. The `copy_out` directive occurs after the application has exited, and copies data from the Rabbit job storage to a global lustre file system.
150+
This set of directives makes use of a persistent storage allocation and a job storage allocation. There are two `copy_in` directives, one that copies data from the global lustre file system to the job allocation, and another that copies data from the persistent allocation to the job allocation. These copies do not occur in a deterministic order. The `copy_out` directive occurs after the application has exited, and copies data from the Rabbit job storage to a global lustre file system.
151151

152152
### container
153153

@@ -156,7 +156,7 @@ The `container` directive is used to launch user containers on the Rabbit nodes.
156156
#### Command Arguments
157157
| Argument | Required | Value | Notes |
158158
|----------|----------|-------|-------|
159-
| `name` | Yes | String including numbers and '-' | This is a name for the container instance that is unique within a job |
159+
| `name` | Yes | Lowercase string including numbers and '-' | This is a name for the container instance that is unique within a job |
160160
| `profile` | Yes | Profile name | This specifies which container profile to use. The container profile contains information about which container to run, which file system types to expect, which network ports are needed, and many other options. An admin is responsible for creating the container profiles. |
161161
| `DW_JOB_[expected]` | No | `jobdw` storage allocation `name` | The container profile will list `jobdw` file systems that the container requires. `[expected]` is the name as specified in the container profile |
162162
| `DW_PERSISTENT_[expected]` | No | `persistentdw` storage allocation `name` | The container profile will list `persistentdw` file systems that the container requires. `[expected]` is the name as specified in the container profile |

0 commit comments

Comments
 (0)