Commit c3151636 authored by Eric Timmons's avatar Eric Timmons

Parameterize image name in hub description

parent 01a3f7bf
......@@ -61,4 +61,4 @@ for sharedTag in "${!sharedTags[@]}"; do
done
done
awk -v r="$simpleTagSection" '{gsub(/INSERT-SIMPLE-TAGS/,r)}1' hub-description-template.md | awk -v r="$sharedTagSection" '{gsub(/INSERT-SHARED-TAGS/,r)}1'
awk -v r="$simpleTagSection" '{gsub(/INSERT-SIMPLE-TAGS/,r)}1' hub-description-template.md | awk -v r="$sharedTagSection" '{gsub(/INSERT-SHARED-TAGS/,r)}1' | sed -e "s,%%IMAGE%%,$1,g"
- [Supported Tags](#orgb6038d1)
- [Simple Tags](#org3ed66e5)
- [Shared Tags](#orga5a4c7e)
- [Quick Reference](#org33050be)
- [What is ABCL?](#org2c21a0c)
- [How to use this iamge](#org0c93268)
- [Create a `Dockerfile` in your ABCL project](#org5e2c353)
- [Run a single Common Lisp script](#orge3a1ae4)
- [Developing using SLIME](#org57abc30)
- [Image variants](#org6244e31)
- [`clfoundation/abcl:<version>`](#org87740a4)
- [`clfoundation/abcl:<version>-slim`](#org5224a51)
- [`clfoundation/abcl:<version>-windowsservercore`](#org80ff69f)
- [License](#orga22aee5)
- [Supported Tags](#orgef301ae)
- [Simple Tags](#org060c6b9)
- [Shared Tags](#org1085d12)
- [Quick Reference](#orgc2fa4fb)
- [What is ABCL?](#orgc5cbc4c)
- [How to use this iamge](#org84c2895)
- [Create a `Dockerfile` in your ABCL project](#orgb45ff03)
- [Run a single Common Lisp script](#org8ec9d53)
- [Developing using SLIME](#org98391d6)
- [Image variants](#orga3a9ef4)
- [`%%IMAGE%%:<version>`](#org50a7673)
- [`%%IMAGE%%:<version>-slim`](#org96159d5)
- [`%%IMAGE%%:<version>-windowsservercore`](#org103d076)
- [License](#org76aa2e1)
<a id="orgb6038d1"></a>
<a id="orgef301ae"></a>
# Supported Tags
<a id="org3ed66e5"></a>
<a id="org060c6b9"></a>
## Simple Tags
INSERT-SIMPLE-TAGS
<a id="orga5a4c7e"></a>
<a id="org1085d12"></a>
## Shared Tags
INSERT-SHARED-TAGS
<a id="org33050be"></a>
<a id="orgc2fa4fb"></a>
# Quick Reference
......@@ -45,7 +45,7 @@ INSERT-SHARED-TAGS
- **Supported platforms:** `linux/amd64`, `linux/arm64/v8`, `windows/amd64`
<a id="org2c21a0c"></a>
<a id="orgc5cbc4c"></a>
# What is ABCL?
......@@ -54,12 +54,12 @@ From [ABCL's Home Page](https://abcl.org)
> Armed Bear Common Lisp (ABCL) is a full implementation of the Common Lisp language featuring both an interpreter and a compiler, running in the JVM. Originally started to be a scripting language for the J editor, it now supports JSR-223 (Java scripting API): it can be a scripting engine in any Java application. Additionally, it can be used to implement (parts of) the application using Java to Lisp integration APIs.
<a id="org0c93268"></a>
<a id="org84c2895"></a>
# How to use this iamge
<a id="org5e2c353"></a>
<a id="orgb45ff03"></a>
## Create a `Dockerfile` in your ABCL project
......@@ -78,25 +78,25 @@ $ docker run -it --rm --name my-running-app my-abcl-app
```
<a id="orge3a1ae4"></a>
<a id="org8ec9d53"></a>
## Run a single Common Lisp script
For many simple, single file projects, you may find it inconvenient to write a complete \`Dockerfile\`. In such cases, you can run a Lisp script by using the ABCL Docker image directly:
```console
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load ./your-daemon-or-script.lisp
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest abcl --load ./your-daemon-or-script.lisp
```
<a id="org57abc30"></a>
<a id="org98391d6"></a>
## Developing using SLIME
[SLIME](https://common-lisp.net/project/slime/) provides a convenient and fun environment for hacking on Common Lisp. To develop using SLIME, first start the Swank server in a container:
```console
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
```
Then, in an Emacs instance with slime loaded, type:
......@@ -106,16 +106,16 @@ M-x slime-connect RET RET RET
```
<a id="org6244e31"></a>
<a id="orga3a9ef4"></a>
# Image variants
This image comes in several variant, each designed for a specific use case.
<a id="org87740a4"></a>
<a id="org50a7673"></a>
## `clfoundation/abcl:<version>`
## `%%IMAGE%%:<version>`
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
......@@ -124,16 +124,16 @@ Some of these tags may have names like buster or stretch in them. These are the
This tag attempts to replicate the base environment provided by buildpack-deps. It, by design, has a large number of extremely common Debian packages.
<a id="org5224a51"></a>
<a id="org96159d5"></a>
## `clfoundation/abcl:<version>-slim`
## `%%IMAGE%%:<version>-slim`
This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run ABCL. Unless you are working in an environment where only this image will be deployed and you have space constraints, we highly recommend using the default image of this repository.
<a id="org80ff69f"></a>
<a id="org103d076"></a>
## `clfoundation/abcl:<version>-windowsservercore`
## `%%IMAGE%%:<version>-windowsservercore`
This image is based on [Windows Server Core (`microsoft/windowsservercore`)](https://hub.docker.com/_/microsoft-windows-servercore). As such, it only works in places which that image does, such as Windows 10 Professional/Enterprise (Anniversary Edition) or Windows Server 2016.
......@@ -143,7 +143,7 @@ For information about how to get Docker running on Windows, please see the relev
- [Windows 10 Quick Start](https://msdn.microsoft.com/en-us/virtualization/windowscontainers/quick_start/quick_start_windows_10)
<a id="orga22aee5"></a>
<a id="org76aa2e1"></a>
# License
......
......@@ -57,7 +57,7 @@
the ABCL Docker image directly:
#+begin_src console
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load ./your-daemon-or-script.lisp
$ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest abcl --load ./your-daemon-or-script.lisp
#+end_src
** Developing using SLIME
......@@ -66,7 +66,7 @@
Lisp. To develop using SLIME, first start the Swank server in a container:
#+begin_src console
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app clfoundation/abcl:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
$ docker run -it --rm --name abcl-slime -p 127.0.0.1:4005:4005 -v /path/to/slime:/usr/src/slime -v "$PWD":/usr/src/app -w /usr/src/app %%IMAGE%%:latest abcl --load /usr/src/slime/swank-loader.lisp --eval '(swank-loader:init)' --eval '(swank:create-server :dont-close t :interface "0.0.0.0")'
#+end_src
Then, in an Emacs instance with slime loaded, type:
......@@ -79,7 +79,7 @@
This image comes in several variant, each designed for a specific use case.
** =clfoundation/abcl:<version>=
** =%%IMAGE%%:<version>=
This is the defacto image. If you are unsure about what your needs are, you
probably want to use this one. It is designed to be used both as a throw
......@@ -96,7 +96,7 @@
buildpack-deps. It, by design, has a large number of extremely common Debian
packages.
** =clfoundation/abcl:<version>-slim=
** =%%IMAGE%%:<version>-slim=
This image does not contain the common packages contained in the default tag
and only contains the minimal packages needed to run ABCL. Unless you are
......@@ -104,7 +104,7 @@
have space constraints, we highly recommend using the default image of this
repository.
** =clfoundation/abcl:<version>-windowsservercore=
** =%%IMAGE%%:<version>-windowsservercore=
This image is based on [[https://hub.docker.com/_/microsoft-windows-servercore][Windows Server Core
(=microsoft/windowsservercore=)]]. As such, it only works in places which that
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment