When contributing to this repository, please first discuss the change you wish to make via issue,
When contributing to this repository, please first discuss the change you wish to make via issues,
email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
## Creating a new runner
To create a new runner you must create a folder named after it that contains a `Dockerfile` and a `docker_init.sh` file. You can use the `r_dev` folder as an example.
Once your container, with all the necessary tools, is built with the `docker_init.sh` script`s (with executable rights). You need to register an account on the [Docker store](https://store.docker.com).
You can now execute the following command to upload your image to the [Docker store](https://store.docker.com). Where `<image_name>` is the name of the image you just built from your `Dockerfile` and `<docker_login>` is the login of your account on the [Docker store](https://store.docker.com).
```sh
docker login
docker tag <image_name> <docker_login>/<image_name>
docker push <docker_login>/<image_name>
```
You then need to create a `\*_runner_register.sh` script similar to the `r_dev_runner_register.sh` script with executable rights. You will need to edit the following arguments:
- `--docker-image <docker_login>/<image_name>`
- `--description "docker runner for <image_name>"`
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
...
...
@@ -13,8 +36,7 @@ Please note we have a code of conduct, please follow it in all your interactions
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
## Code of Conduct
...
...
@@ -65,7 +87,7 @@ threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
representing a project or community includes using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This repository contains scripts to launch GitLab Runners for your group.
Once configured, GitLab runners are called by the GitLab server to perform computations (package, building, test, etc) on you code, after each commit. Runners are not executed on the server but on remote computer accessible by the network.
Once configured, GitLab runners are called by the GitLab server to perform computations (package, building, test, etc) on your code, after each commit. Runners are not executed on the server but on remote computer accessible by the network.
This repository contains various scripts to initialise a GitLab Runner, to register it for your group with the GitLab server, and to launch it.
## Getting Started
...
...
@@ -11,7 +11,7 @@ These instructions will get you a copy of the project up and running on your loc
### Prerequisites
You need the registration token for your group from the GitLab server.
For this go to your group page, **settings**, **CI/CD** and **Runners settings**. For the LBMC group, this correspond to the following url :
For this go to your group page, **settings**, **CI/CD** and **Runners settings**. For the LBMC group, this corresponds to the following url :
This will build the `gitlab_runner` container with the certificate of the [gitlab.biologie.ens-lyon.fr](https://gitlab.biologie.ens-lyon.fr/) website installed.
This container, will be the process that register and manage the GitLab runners on your computer.
This container will be the process that register and manage the GitLab runners on your computer.
To run safely the runners themselves, we are going to instantiate new container, for each runners.
For example to have a runner for `R` development `r_dev/Dockerfile`. Those container must be available from the [Docker store](https://store.docker.com/community/images/lmodolo/r_dev/tags).
To run the runners safely themselves, we are going to instantiate new containers, for each runner.
For example, to have a runner for `R` development `r_dev/Dockerfile`. Those containers must be available from the [Docker store](https://store.docker.com/community/images/lmodolo/r_dev/tags).
The `gitlab_runner` container will be able to pull them and launch them (within the `r_dev:3.5.1` container for the `r_dev` eample)
The `gitlab_runner` container will be able to pull them and launch them (within the `r_dev:3.5.1` container for the `r_dev` example)
## Registering a Runner
...
...
@@ -77,7 +77,7 @@ To stop your runners, execute the following command:
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process of submitting pull requests to us.
## Versioning
...
...
@@ -91,5 +91,5 @@ See also the list of [contributors](https://gitlab.biologie.ens-lyon.fr/pipeline
## License
This project is licensed under the CeCiLL License- see the [LICENSE](LICENSE) file for details
This project is licensed under the CeCiLL License- see the [LICENSE](LICENSE) file for details.
