Skip to content

Commit 68ca76c

Browse files
committed
Update README
1 parent f9fa7b6 commit 68ca76c

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Use cases include:
1010

1111
- having a consistent set of images to build other images from
1212
- providing base images for CI usage and testing as well as local development
13+
- providing service images for integration with testing suites
1314
- providing minimal app images using various frameworks for CI testing (integration, system tests), issue reproduction, support engineers, pentesters...
1415
- making CI runtime environment reproducinble locally
1516
- hastening image building and fetching by mutualising commonality
@@ -19,19 +20,22 @@ Use cases include:
1920

2021
### Ruby engines
2122

23+
Directory: `src/engines`
24+
2225
Supported engines include:
2326

2427
- `ruby`: MRI a.k.a CRuby.
2528
- `jruby`: These are based on Eclise Temurin JDK builds.
2629
- `truffleruby`: Due to the nature and state of TruffleRuby these are experimental and may or may not work as expected.
2730

28-
### Apps
31+
Tag naming acts as a contract and conveys intended usage:
32+
33+
- If you expect a compiler use `-gcc` or `-clang` tags; images withotu this do not guarantee presence of a compiler.
34+
- If you expect a certain libc (variant or version), use the appropriate `-musl`, -gnu` (glibc), or `-centos` (old glibc) tags.
35+
- "Naked" version tags give you that specific runtime, but assume no specific Linux distribution, libc version or variant, and no compiler.
2936

30-
#### minimal-rack
37+
### Services
3138

32-
These images provide a set of minimal rack-based applications covering a range of frameworks and versions:
39+
Directory: `src/services`
3340

34-
- `rack` 1.3 to 3 and up
35-
- `rails` 3.2 to 7 and up
36-
- `sinatra` 1.0 to 4 and up
37-
- `grape` 1.2 to 4 and up
41+
Service images are intended to provide known, fixed behaviour for test suites.

0 commit comments

Comments
 (0)