Conversation
(HMAC). Edited for clarity.
- Added Slurm Docker Cluster SLURM_TAG explanation and PRIOR_TO_V24_05_5_1 explanation - Added patch explanation - Added list of IBM Quantum Platform systems - Added instructions for API key and CRN - Edited for clarity
yoonho
requested review from
OkuyanBoga,
awennersteen and
ohtanim
as code owners
|
Yoonho Park seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
| cd slurm-docker-cluster | ||
| ``` | ||
|
|
||
| Slurm Docker Cluster v0.9.0 uses SLURM_TAG defined in slurm-docker-cluster/.env to specify the Slurm version. Currently, SLURM_TAG is set to slurm-25-05-3-1. This corresponds to a tag in Slurm's major release 25.05 from May 2025. Using a Slurm release prior to slurm-24-05-5-1 requires rebuilding the SPANK plugin with -DPRIOR_TO_V24_05_5_1 due to interface changes in slurm-24-05-5-1. |
There was a problem hiding this comment.
I believe this description may lead to misunderstandings. It feels odd that the section titled “Cloning the Slurm Docker Cluster git repository” includes an explanation of the build option(-DPRIOR_TO_V24_05_5_1) for our SPANK plugin. This build option should be moved to the section that explains how to build the SPANK plugin itself. In this part, we should describe only how to change the version of Slurm being used.
Additionally, the file slurm-docker-cluster/.env is created only after applying our patch file, which is described later. Since it does not exist in the original cloned repository, it is likely to confuse users.
| ``` | ||
|
|
||
| 2. Creating python virtual env under shared volume | ||
| 2. Creating python virtual env under shared volume **on c1** |
There was a problem hiding this comment.
I don't think you need to describe "on c1" because we're working under shared volume, not specific to the node filesystem.
| Then, create a file under `/etc/slurm` or another location accessible to the Slurm daemons. | ||
| Modify [this example](https://github.com/qiskit-community/spank-plugins/blob/main/plugins/spank_qrmi/qrmi_config.json.example) to fit your environment and add it to `/etc/slurm` or another location accessible to the Slurm daemons on each compute node you intend to use. | ||
|
|
||
| IBM Quantum Platform (IQP) provides limited, free access to IBM Quantum systems. After registering with IBM Cloud and IQP, the list of accessible IBM Quantum systems can be found [here](https://quantum.cloud.ibm.com/computers). The qrmi_config.json file will require an API key and a CRN for each IQP system. API key instructions can be found [here](https://cloud.ibm.com/iam/apikeys). The CRN for each IQP system can be found [here](https://quantum.cloud.ibm.com/computers). For example, click on "ibm_torino" then open the “Instance access” section for the "ibm_torino" CRN. |
There was a problem hiding this comment.
I think the term “free access” may cause confusion with IQP’s “open plan access.” I also don’t understand why "limited" and "free access" are listed together in the first place. Furthermore, I’m not sure whether it is appropriate for this document to include information that is specific to IBM IQP. Considering that more quantum vendors may appear in the future, I would suggest to create a separate file to store vendor‑specific information.
If you intend to include information about IQP "open plan access" here, it would be helpful to also describe the necessary workaround. Open plan access does not work out of the box in this setup.
| ## How to obtain the AWS Access Key ID and Secret Access Key | ||
|
|
||
| `IBM Cloud -> Infrastructure -> Storage -> Objective Storage` in order to navigate IBM Cloud website. | ||
| To create your credentials, navigate to the `Service credentials` tab in your instance's web page. All instances can be found in the [IBM Cloud Instances web page](https://cloud.ibm.com/objectstorage/instances). Click on `New Credential` in the `Service credential` tab to create your HMAC (Hash-based Message Authentication Code) credentials. |
There was a problem hiding this comment.
In our previous discussion, I suggested to not describe IBM Cloud UI labels or UI operations directly in our documentation as practice. The IBM Cloud UI changes frequently, and we would have to constantly monitor those changes and update our files each time. To address this issue, I thought you proposed using the IBM Cloud API—which changes far less frequently—to achieve the same purpose and you did in below. I expected to remove UI labels and operations as well.
There was a problem hiding this comment.
Alternatively, you could write that
The operations described here for the IBM Cloud Web UI may differ from the actual interface. For details, please refer to the IBM Cloud documentation —
especially if these UI operation instructions are truly necessary.
3 participants
Description of Change
Address documentation issues encountered while trying to set up a local development environment for IQP and DA systems (IBM)
Checklist ✅
Ticket