|
|
|
---
|
|
|
|
title: Configuring a standard experiment for NIC5
|
|
|
|
---
|
|
|
|
Thanks to GitLab CI/CD features and thanks to [Jacamar CI](https://ecp-ci.gitlab.io/docs/admin/jacamar/introduction.html), you can configure a standard experiment for BAMHBI to run on the NIC5 cluster which you will be able to kickstart from ULiège GitLab with a simple click.
|
|
|
|
|
|
|
|
This tutorial details the requirements you should meet beforehand, for both security and storage concerns, then how you can write a suitable CI/CD configuration to create your experiment.
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
### Requirements to satisfy CÉCI (cluster administrators)
|
|
|
|
|
|
|
|
The CÉCI (Consortium des Équipements de Calcul Intensif) expects us to make reasonable use of their computing resources. I.e., the experiments we run through CI/CD should not compromise their security, in addition to having (as much as possible) a small footprint in terms of disk space. This is why pre-configured experiments written as CI/CD jobs on GitLab will only be possible if the following conditions are met.
|
|
|
|
|
|
|
|
In the next lines, the repository where the BAMHBI code you want to use is located is called the **target repository**.
|
|
|
|
|
|
|
|
1) The **target repository must be private**, i.e., restricted to selected users, such as MAST members.
|
|
|
|
|
|
|
|
2) The contributors to the target repository who want to perform CI/CD through NIC5 **must have a CÉCI account**.
|
|
|
|
|
|
|
|
3) The **target repository must have a _custom runner_ for NIC5**. You can check if a such a runner exists by browsing **Settings > CI/CD > Runners** while in the target repository. It should be listed under _Assigned project runners_.
|
|
|
|
|
|
|
|
* If such a runner does not exist yet, you will have to contact me (@Jean-Francois.Grailet) first so that I can reach the CÉCI to create the runner and interface it with NIC5 through [Jacamar CI](https://ecp-ci.gitlab.io/docs/admin/jacamar/introduction.html).
|
|
|
|
|
|
|
|
4) Finally, **you must advertise me whether you want to use the NIC5 runner** of the target repository.
|
|
|
|
|
|
|
|
* Contact me (@Jean-Francois.Grailet) by e-mail for this purpose.
|
|
|
|
* This additional requirement is again motivated by security concerns at CÉCI's side, as they have to be able to map a GitLab user to a CÉCI account (hence requirement 2).
|
|
|
|
|
|
|
|
### Requirements to satisfy SEGI (ULiège IT management)
|
|
|
|
|
|
|
|
The SEGI (SErvice Général d'Informatique), who manages the ULiège network and its services, including GitLab, also expects us to make good use of their resources. Hopefully, they worry mostly about the disk space used by GitLab projects, so their requirements are not as strict as CÉCI's, but should be taken into consideration too.
|
|
|
|
|
|
|
|
**Coming soon** |
|
|
\ No newline at end of file |
