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..9be6d2af --- /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 +```