Skip to content

Commit

Permalink
Removing nbsp and adding new liens
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Baker <[email protected]>
  • Loading branch information
PeterBaker0 committed Sep 6, 2024
1 parent dade7c6 commit 5c67848
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ input/
output/
.git*
assets/
docs/
docs/
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ JuliaSysimage.dll

docs/build/
input/
output/
output/
22 changes: 1 addition & 21 deletions docs/src/development/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ You can also opt to specify some custom [build arguments](https://docs.docker.co

See the [docker-compose.yaml](./docker-compose.yaml) file for an example of how to specify build arguments in docker compose.

&nbsp;

### Running `adria-base` with a non-interactive Julia command

e.g. to list the packages installed in the `@adria` shared environment:
Expand All @@ -93,8 +91,6 @@ docker compose run --rm adria-base --project=@adria -e 'using Pkg; Pkg.status()'
docker run --rm ADRIA.jl/adria-base:latest --project=@adria -e 'using Pkg; Pkg.status()'
```

&nbsp;

### Running `adria-base` as an interactive Julia shell

To launch an interactive Julia shell:
Expand All @@ -109,8 +105,6 @@ docker run --rm --interactive --tty ADRIA.jl/adria-base:latest

In both cases, type `CTRL-d` to exit the shell and stop the container.

&nbsp;

### Running `adria-base` with a non-Julia entrypoint

If you want to use this image to run something _other_ than a Julia command, you can specify an alternate entrypoint at runtime as well as an alternate command. e.g. to launch an interactive `bash` shell in the container for checking filesystem permissions or similar:
Expand All @@ -123,8 +117,6 @@ docker compose run --rm --entrypoint /bin/bash adria-base
docker run --rm --interactive --tty --entrypoint /bin/bash ADRIA.jl/adria-base:latest
```

&nbsp;

### Deriving an image from `adria-base`

To make a derived ADRIA application:
Expand All @@ -134,8 +126,6 @@ To make a derived ADRIA application:

The section of the [Dockerfile](./Dockerfile) that defines the `adria-sandbox` target described below might be useful inspiration.

&nbsp;

---

## adria-dev
Expand All @@ -162,8 +152,6 @@ docker build --target "adria-dev" --tag ADRIA.jl/adria-dev:latest .

The same `JULIA_VERSION` build argument that works with `adria-base` will also work with `adria-dev`.

&nbsp;

### Running `adria-dev` as an interactive Julia shell

Very useful for running commands to update Package manifests and similar!
Expand All @@ -182,8 +170,6 @@ docker run --rm --interactive --tty \

In both cases, type `CTRL-d` to exit the shell and stop the container.

&nbsp;

---

### Running ADRIA tests with `adria-dev`
Expand All @@ -202,8 +188,6 @@ docker run --rm ADRIA.jl/adria-dev:latest --project=. -e 'using Pkg; Pkg.test();

This method of running tests is suitable to use in a containerised continuous integration pipeline.

&nbsp;

---

## adria-sandbox
Expand All @@ -228,8 +212,6 @@ docker compose build adria-sandbox
docker build --build-arg SANDBOX_FROM=adria-dev --target "adria-sandbox" --tag ADRIA.jl/adria-sandbox:latest .
```

&nbsp;

### Running `adria-sandbox`

The `adria-sandbox` image is configured to automatically run the `dev.jl` script when a container
Expand Down Expand Up @@ -259,8 +241,6 @@ docker run --rm \
The `dev.jl` script should run with any files you have provided in your input volume, and will
create and output files in your output volume. The container will be removed once the script completes.

&nbsp;

### Interacting with `adria-sandbox`

If you prefer to work with the sandbox code from an interactive shell, then you will need to override the default entrypoint and command combination to make the container launch your preferred shell at startup.
Expand Down Expand Up @@ -291,4 +271,4 @@ julia --project=@. dev.jl
```

**Warning:** For `julia` commands, you will probably need to use the `--project=@.` argument. This tells Julia that it's working environment is based in a parent directory of the one the sandbox source code is installed to, which is where the build
configured all the precompiled dependencies. If you omit this, the pre-installed packages may not all be available.
configured all the precompiled dependencies. If you omit this, the pre-installed packages may not all be available.

0 comments on commit 5c67848

Please sign in to comment.