From f8b020d1b5a2e849c5f3b5a3355f0e571b573e8d Mon Sep 17 00:00:00 2001 From: Munetaka Ohtani Date: Tue, 14 Oct 2025 20:50:17 +0900 Subject: [PATCH 1/2] Add FAQ document --- README.md | 1 + docs/FAQ.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/FAQ.md diff --git a/README.md b/README.md index c691e0ef..ffae87f3 100644 --- a/README.md +++ b/README.md @@ -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) ---------------------------------------------------------------------------------------------------- diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 00000000..759b0e39 --- /dev/null +++ b/docs/FAQ.md @@ -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= +$ export ibm_brussels_QRMI_IBM_QRS_SERVICE_CRN= +$ sbatch +``` From 8b8dd28b6809f012c80332c4fc0b246fb7ab4031 Mon Sep 17 00:00:00 2001 From: Munetaka Ohtani Date: Tue, 14 Oct 2025 20:56:07 +0900 Subject: [PATCH 2/2] add minor changes --- docs/FAQ.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 759b0e39..9be6d2af 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -2,11 +2,11 @@ ## 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. +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. +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. +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=