Skip to content

Commit f0dba22

Browse files
committed
update to include microk8s and fix formatting
1 parent 2d0ae94 commit f0dba22

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/safe-haven-services/tre-container-user-guide/development-workflow.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -337,23 +337,34 @@ Note: `<gitlab_user>` is a GitHub user name, `<ghcr_token>` is a GitHub access t
337337

338338
Note: The `<github_user>` and `<ghcr_token>` arguments to `ces-pull` are mandatory.
339339

340-
If a runtime is not specified then podman is used as the default.
340+
The three container engines available are:
341341

342-
The container can then be run with `ces-run`:
342+
- `Podman`, configured in rootless mode,
343+
- `Kubernetes` (or `k8s`), using a local single-node Microk8s cluster,
344+
- `Apptainer`
345+
346+
Docker is not currently available.
347+
348+
!!! note "Podman is the default container engine"
349+
`ces-pull` defaults to Podman if no container engine is specified.
350+
351+
To run a container, use:
343352

344353
```sh
345354
ces-run [<runtime>] ghcr.io/<namespace>/<container_name>:<container_tag>
346355
```
347356

348-
`ces-run` supports the following optional arguments under most runtimes:
357+
Most container engines support the following arguments to `ces-run`:
349358

350359
- Use `--opt-file=<file>` to specify a file containing additional options to be passed to the runtime
351360
- Use `--arg-file=<file>` to specify a file containing arguments to pass to the container command or entrypoint
352361
- Use `--env-file=<file>` to specify a file containing environment variables which will be set inside the container
353362

354-
Containers that require a GPU can be run by adding the `--gpu` option. See `ces-run [<runtime>] --help` for all available options.
363+
The Kubernetes engine does not support `--opt-file`. Containers that require a GPU can be run adding the `--gpu` option. See `ces-run --help`, and `ces-run <container-engine> --help` for all available options.
364+
365+
The `--dry-run` option can be useful when working with kubernetes, as it will print the generated job spec. This can then be saved and edited if configuration is needed, and manually applied with `kubectl apply -f <file>` as normal.
355366

356-
We recommend to test containers without network connection to best mimick their functionality inside the TRE, where the container will not be able to access the internet. With Podman, for example, this can be achieved by passing the option `--network=none` through the `opt-file`.
367+
We recommend that containers are tested without network connection to best mimick their functionality inside the TRE, where the container will not be able to access the internet. With Podman, for example, this can be achieved by passing the option `--network=none` through the `opt-file`.
357368

358369
Once the container runs successfully in the test environment, it is ready to be used inside the TRE.
359370

0 commit comments

Comments
 (0)