diff --git a/varnish/README.md b/varnish/README.md index 20e24f5b0dc7..064060f25d43 100644 --- a/varnish/README.md +++ b/varnish/README.md @@ -230,22 +230,6 @@ Varnish uses [memory-mapped files](https://docs.varnish-software.com/varnish-ent - mount the working directory as `tmpfs` to make sure disk I/O isn't a bottleneck; that's what the `--tmpfs` switch does - allow Varnish to lock those memory-mapped files so they aren't paged out by the kernel; hence the `--ulimit` switch -# Image Variants - -The `varnish` images come in many flavors, each designed for a specific use case. - -## `varnish:` - -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. - -## `varnish:-alpine` - -This image is based on the popular [Alpine Linux project](https://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general. - -This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use [musl libc](https://musl.libc.org) instead of [glibc and friends](https://www.etalabs.net/compare_libcs.html), so software will often run into issues depending on the depth of their libc requirements/assumptions. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images. - -To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar). - # License View [license information](https://github.com/varnishcache/varnish-cache/blob/master/LICENSE) for the software contained in this image. diff --git a/varnish/content.md b/varnish/content.md index 2239c0789b72..6282af223501 100644 --- a/varnish/content.md +++ b/varnish/content.md @@ -168,7 +168,11 @@ This can notably be used to extract logs using [varnishncsa or varnishlog](https ## Vmods -The docker image is built with a collection of "`VCL` modules" or "vmods" that extend Varnish capability. We've already covered `vmod-fileserver` (file backend) and `vmod-reqwest` (dynamic backends), but more are available and can be used in your custom `VCL` with `import `. Please refer to the documentation of each vmod for more information. +The docker image is built with a collection of "`VCL` modules" or "vmods" that extend Varnish capability. + +We've already covered `vmod-fileserver` (file backend) and `vmod-reqwest` (dynamic backends), but more are available and can be used in your custom `VCL` with `import `. Please refer to the documentation of each vmod for more information. + +The full list can be found on the [varnish/pkg-varnish-cache repository on github](https://github.com/varnish/pkg-varnish-cache). # ulimit and tmpfs notes