Fix README files to include gosu (closes #88)

snowplow-archive · Aug 31, 2018 · b39c17b · b39c17b
1 parent 84ffb78
commit b39c17b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/piinguin-server/README.md b/piinguin-server/README.md
@@ -11,7 +11,7 @@ This folder contains
 
 The Piinguin Server runs under [dumb-init][dumb-init] which handles reaping zombie processes
 and forwards signals on to all processes running in the container. This image also uses
-[su-exec][su-exec], as a sudo replacement, to run the Piinguin Server as the non-root `snowplow` user.
+[su-exec][su-exec] or [gosu][gosu], as a sudo replacement, to run the Piinguin Server as the non-root `snowplow` user.
 
 The `-XX:+UnlockExperimentalVMOptions` and `-XX:+UseCGroupMemoryLimitForHeap` JVM options will be
 automatically provided when launching the server in order to make the JVM adhere to the memory
@@ -100,3 +100,4 @@ limitations under the License.
 [dumb-init]: https://github.com/Yelp/dumb-init
 [su-exec]: https://github.com/ncopa/su-exec
 [jvm-docker-article]: https://blogs.oracle.com/java-platform-group/java-se-support-for-docker-cpu-and-memory-limits
+[gosu]: https://github.com/tianon/gosu
diff --git a/scala-stream-collector/README.md b/scala-stream-collector/README.md
@@ -17,7 +17,7 @@ This image is based on [the base image][base-image] which leverages
 
 The Scala Stream Collector runs under [dumb-init][dumb-init] which handles reaping zombie processes
 and forwards signals on to all processes running in the container. This image also uses
-[su-exec][su-exec], as a sudo replacement, to run the collector as the non-root `snowplow` user.
+[su-exec][su-exec] or [gosu][gosu], as a sudo replacement, to run the collector as the non-root `snowplow` user.
 
 The container exposes the `/snowplow/config` volume to store the collector configuration. If this
 folder is bind mounted then ownership will be changed to the `snowplow` user.
@@ -92,6 +92,7 @@ limitations under the License.
 [ssc]: https://github.com/snowplow/snowplow/tree/master/2-collectors/scala-stream-collector
 [dumb-init]: https://github.com/Yelp/dumb-init
 [su-exec]: https://github.com/ncopa/su-exec
+[gosu]: https://github.com/tianon/gosu
 
 [jvm-docker-article]: https://blogs.oracle.com/java-platform-group/java-se-support-for-docker-cpu-and-memory-limits
 

diff --git a/stream-enrich/README.md b/stream-enrich/README.md
@@ -17,7 +17,7 @@ This image is based on [the base image][base-image] which leverages
 
 Stream Enrich runs under [dumb-init][dumb-init] which handles reaping zombie processes
 and forwards signals on to all processes running in the container. This image also uses
-[su-exec][su-exec], as a sudo replacement, to run Stream Enrich as the non-root `snowplow` user.
+[su-exec][su-exec] or [gosu][gosu], as a sudo replacement, to run Stream Enrich as the non-root `snowplow` user.
 
 The container exposes the `/snowplow/config` volume to store the enrich configuration. If this
 folder is bind mounted then ownership will be changed to the `snowplow` user.
@@ -100,6 +100,7 @@ limitations under the License.
 [stream-enrich]: https://github.com/snowplow/snowplow/tree/master/3-enrich/stream-enrich
 [dumb-init]: https://github.com/Yelp/dumb-init
 [su-exec]: https://github.com/ncopa/su-exec
+[gosu]: https://github.com/tianon/gosu
 
 [jvm-docker-article]: https://blogs.oracle.com/java-platform-group/java-se-support-for-docker-cpu-and-memory-limits