Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dometto committed Nov 18, 2024
1 parent d83029c commit 80622ea
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,13 @@ Should you use Docker or Podman? In order to make it possible to use `sytemd` se

1. First determine which test image you want to use. Have a look at the options [here](https://github.com/UtrechtUniversity/SRC-test-workspace#src-test-workspace).
1. In order to be able to pull the test image, login to the GitHub container registry:
* `podman login ghcr.io`
* Note: you will need to have a GitHub personal access token configured to login
1. Start a test container with the flavour you have picked (e.g. `ubuntu_jammy`):
* `podman run -d --name src_component_test -v $(pwd):/etc/rsc/my_component ghcr.io/utrechtuniversity/src-test-workspace:ubuntu_jammy /sbin/init`
* `-d`: run in the background
* `--name src_component_test`: give your container a name
* `-v $(pwd):/etc/rsc/my_component`: make your component directory available on the container
* start with `/sbin/init` to allow testing of `systemd` services
* `podman login ghcr.io`
* Note: you will need to have a GitHub personal access token configured to login
1. Start a test container with the image you have picked: `podman run -d --name src_component_test -v $(pwd):/etc/rsc/my_component ghcr.io/utrechtuniversity/src-test-workspace:ubuntu_jammy /sbin/init`
* `-d`: run in the background
* `--name src_component_test`: give your container a name
* `-v $(pwd):/etc/rsc/my_component`: make your component directory available on the container
* start with `/sbin/init` to allow testing of `systemd` services
1. If your component expects variables to be defined in the ResearchCloud portal, mock these variables by defining them in the file `component_vars.yml`.
1. Execute your component on the container using the provided `run_component` script:
* `podman exec src_component_test run_component.sh /etc/rsc/my_component/playbook.yml`
Expand Down

0 comments on commit 80622ea

Please sign in to comment.