Browse Source

Run update.sh

Docker Library Bot 9 years ago
parent
commit
b146f2651c
1 changed files with 18 additions and 2 deletions
  1. 18 2
      sonarqube/README.md

+ 18 - 2
sonarqube/README.md

@@ -1,9 +1,9 @@
 # Supported tags and respective `Dockerfile` links
 
 -	[`latest`, `lts`, `5.6.1` (*5.6.1/Dockerfile*)](https://github.com/SonarSource/docker-sonarqube/blob/06fcdc6ef062f43a5513bd327a79e7c5011fb0a3/5.6.1/Dockerfile)
--	[`lts-alpine`, `5.6.1-alpine` (*5.6.1-alpine/Dockerfile*)](https://github.com/SonarSource/docker-sonarqube/blob/06fcdc6ef062f43a5513bd327a79e7c5011fb0a3/5.6.1-alpine/Dockerfile)
+-	[`alpine`, `lts-alpine`, `5.6.1-alpine` (*5.6.1-alpine/Dockerfile*)](https://github.com/SonarSource/docker-sonarqube/blob/06fcdc6ef062f43a5513bd327a79e7c5011fb0a3/5.6.1-alpine/Dockerfile)
 
-[![](https://badge.imagelayers.io/sonarqube:latest.svg)](https://imagelayers.io/?images=sonarqube:latest,sonarqube:lts-alpine)
+[![](https://badge.imagelayers.io/sonarqube:latest.svg)](https://imagelayers.io/?images=sonarqube:latest,sonarqube:alpine)
 
 For more information about this image and its history, please see [the relevant manifest file (`library/sonarqube`)](https://github.com/docker-library/official-images/blob/master/library/sonarqube). This image is updated via [pull requests to the `docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fsonarqube).
 
@@ -58,6 +58,22 @@ More recipes can be found [here](https://github.com/SonarSource/docker-sonarqube
 
 The administration guide can be found [here](http://docs.sonarqube.org/display/SONAR/Administration+Guide).
 
+# Image Variants
+
+The `sonarqube` images come in many flavors, each designed for a specific use case.
+
+## `sonarqube:<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.
+
+## `sonarqube:alpine`
+
+This image is based on the popular [Alpine Linux project](http://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 highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. 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](http://www.gnu.org/licenses/lgpl.txt) for the software contained in this image.