Skip to content

Add FAQ document #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ohtanim wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add FAQ document #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8b020d
Add FAQ document
ohtanim Oct 14, 2025
8b8dd28
add minor changes
ohtanim Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This is repository with Slurm Spank plugins for Quantum resources and jobs suppo
1. [How to Cite This Work](#how-to-cite-this-work)
1. [Contribution Guidelines](#contribution-guidelines)
1. [References and Acknowledgements](#references-and-acknowledgements)
1. [FAQ](./docs/FAQ.md)


----------------------------------------------------------------------------------------------------
Expand Down
15 changes: 15 additions & 0 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# FAQ

## How to override environment variable values defined in qrmi_config.json

When a user submits a Slurm job, they can override the environment variable values defined in `qrmi_config.json`.

Set the value of the environment variable by prefixing its name with the resource ID, as shown below. These environment variables will be propagated by Slurm to the SPANK plugin runtime (e.g., `slurmstepd`) and to the job runtime when executing this Slurm job.

Example: Overriding `QRMI_IBM_QRS_IAM_APIKEY` and `QRMI_IBM_QRS_SERVICE_CRN` to allow a user to access ibm_brussels.

```bash
$ export ibm_brussels_QRMI_IBM_QRS_IAM_APIKEY=<api-key>
$ export ibm_brussels_QRMI_IBM_QRS_SERVICE_CRN=<crn>
$ sbatch <your job script>
```