[LUDOC-210] Clarify Jobstats documentation and add ALPS environment variable

• Status: Closed
• Project: Lustre Documentation
• Type: Improvement
• Priority: Minor
• Reporter: Ryan Haasken
• Assignee: Richard Henwood (Inactive)
• Resolution: Fixed

Description

Cray's Application Level Placement Scheduler (ALPS) now sets an environment variable identifying the running application. That environment variable is ALPS_APP_ID. This needs to be documented in section 12.1.1 of the Lustre Manual. A row for ALPS should be added to the table in that section.

In addition, the table and its description are somewhat misleading. It sounds like the value of jobid_var can only be one of the values listed in the table, which is not true. The table just contains special values for the jobid_var and examples of the environment variables set by some job schedulers.

The table should be split into two tables, and the columns should be swapped. The first table should have a correspondence between job schedulers and environment variables. The second table should contain the two special values: procname_uid, and disable.

The description preceding the first table should read something like this:

"The following table shows the environment variables which are set by various job schedulers. Set jobid_var to the value for your job scheduler to collect statistics per job."

The description preceding the second table should be something like this:

"This table shows two special values for jobid_var and their effects."

Comments

[Ryan Haasken]

Here is my proposed patch:

http://review.whamcloud.com/#/c/8577/

[Ryan Haasken]

Patch has landed, and this issue can be resolved.

[Jessica A. Popp (Inactive)]

Richard, please review the above and close the ticket if appropriate.

-Jessica

[Richard Henwood (Inactive)]

Ryan's patch fixed this issue.