Skip to content

Commit 36de30a

Browse files
committed
Add alpine image pulling docs, add image descriptions
1 parent aa32e26 commit 36de30a

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

templates/pull_containers.md

+30-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
### Full
1+
### Using the Full Image
22
{% set short_repository = repository.split("/")[1] -%}
33

4+
The Full Images use the base Python Docker images as their parent. These images are based off of Ubuntu and contain a variety of build tools.
5+
46
To pull the latest full version:
57

68
```bash
@@ -13,7 +15,9 @@ To include it in the dockerfile instead:
1315
FROM ghcr.io/{{ organization }}/{{ short_repository }}:py{{ python_versions|last }}-LATEST
1416
```
1517

16-
### Slim
18+
### Using the Slim Image
19+
20+
The Slim Images use the base Python Slim Docker images as their parent. These images are very similar to the Full images, but without the build tools. These images are much smaller than their counter parts but are more difficult to compile wheels on.
1721

1822
To pull the latest slim version:
1923

@@ -26,3 +30,27 @@ To include it in the dockerfile instead:
2630
```dockerfile
2731
FROM ghcr.io/{{ organization }}/{{ short_repository }}:py{{ python_versions|last }}-slim-LATEST
2832
```
33+
34+
35+
{% if "alpine" in variants %}
36+
### Using the Alpine Image
37+
38+
The Alpine Images use the base Python Alpine Docker images as their parent. These images use Alpine as their operating system, with musl instead of glibc.
39+
40+
In theory these images are smaller than even the slim images, but this amounts to less than 30mb difference. Additional Python libraries tend not to be super well tested on Alpine. These images should be used with care and testing until this ecosystem matures.
41+
42+
43+
To pull the latest alpine version:
44+
45+
```bash
46+
docker pull ghcr.io/{{ organization }}/{{ short_repository }}:py{{ python_versions|last }}-alpine-LATEST
47+
```
48+
49+
To include it in the dockerfile instead:
50+
51+
```dockerfile
52+
FROM ghcr.io/{{ organization }}/{{ short_repository }}:py{{ python_versions|last }}-alpine-LATEST
53+
```
54+
55+
{% endif %}
56+

0 commit comments

Comments
 (0)