From 2660c0fe20093456a462db437a9e894429d2d42a Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Wed, 31 Dec 2014 15:06:45 -0800 Subject: [PATCH 1/3] Add memcached docs --- memcached/README-short.txt | 1 + memcached/README.md | 73 ++++++++++++++++++++++++++++++++++++++ memcached/content.md | 29 +++++++++++++++ memcached/license.md | 3 ++ 4 files changed, 106 insertions(+) create mode 100644 memcached/README-short.txt create mode 100644 memcached/README.md create mode 100644 memcached/content.md create mode 100644 memcached/license.md diff --git a/memcached/README-short.txt b/memcached/README-short.txt new file mode 100644 index 00000000..88dd8d6b --- /dev/null +++ b/memcached/README-short.txt @@ -0,0 +1 @@ +Free & open source, high-performance, distributed memory object caching system. diff --git a/memcached/README.md b/memcached/README.md new file mode 100644 index 00000000..a9ea351e --- /dev/null +++ b/memcached/README.md @@ -0,0 +1,73 @@ +# Supported tags and respective `Dockerfile` links + + + +For more information about this image and its history, please see the [relevant +manifest file +(`library/memcached`)](https://github.com/docker-library/official-images/blob/master/library/memcached) +in the [`docker-library/official-images` GitHub +repo](https://github.com/docker-library/official-images). + +# What is Memcached? + +Memcached is a general-purpose distributed memory caching system. It is often +used to speed up dynamic database-driven websites by caching data and objects in +RAM to reduce the number of times an external data source (such as a database or +API) must be read. + +Memcached's APIs provide a very large hash table distributed across multiple +machines. When the table is full, subsequent inserts cause older data to be +purged in least recently used order. Applications using Memcached typically +layer requests and additions into RAM before falling back on a slower backing +store, such as a database. + +> [wikipedia.org/wiki/Memcached](https://en.wikipedia.org/wiki/Memcached) + +# How to use this image + + docker run -it --rm --name my-memcache memcached + +Start your memcached container with the above command and then you can connect +you app to it with standard linking: + + docker run -it --link my-memcache:memcache my-app-image + +The memcached server information would then be available through the ENV +variables generated by the link as well as through DNS as `memcache` from +`/etc/hosts`. + +For infomation on configuring your memcached server, see the extensive [wiki](https://code.google.com/p/memcached/wiki/NewStart). + +# License + +View [license +information](https://github.com/memcached/memcached/blob/master/LICENSE) for the +software contained in this image. + +# Supported Docker versions + +This image is officially supported on Docker version 1.4.1. + +Support for older versions (down to 1.0) is provided on a best-effort basis. + +# User Feedback + +## Issues + +If you have any problems with or questions about this image, please contact us + through a [GitHub issue](https://github.com/docker-library/memcached/issues). + +You can also reach many of the official image maintainers via the +`#docker-library` IRC channel on [Freenode](https://freenode.net). + +## Contributing + +You are invited to contribute new features, fixes, or updates, large or small; +we are always thrilled to receive pull requests, and do our best to process them +as fast as we can. + +Before you start to code, we recommend discussing your plans +through a [GitHub issue](https://github.com/docker-library/memcached/issues), especially for more ambitious +contributions. This gives other contributors a chance to point you in the right +direction, give you feedback on your design, and help you find out if someone +else is working on the same thing. diff --git a/memcached/content.md b/memcached/content.md new file mode 100644 index 00000000..66b0c27e --- /dev/null +++ b/memcached/content.md @@ -0,0 +1,29 @@ +# What is Memcached? + +Memcached is a general-purpose distributed memory caching system. It is often +used to speed up dynamic database-driven websites by caching data and objects in +RAM to reduce the number of times an external data source (such as a database or +API) must be read. + +Memcached's APIs provide a very large hash table distributed across multiple +machines. When the table is full, subsequent inserts cause older data to be +purged in least recently used order. Applications using Memcached typically +layer requests and additions into RAM before falling back on a slower backing +store, such as a database. + +> [wikipedia.org/wiki/Memcached](https://en.wikipedia.org/wiki/Memcached) + +# How to use this image + + docker run -it --rm --name my-memcache memcached + +Start your memcached container with the above command and then you can connect +you app to it with standard linking: + + docker run -it --link my-memcache:memcache my-app-image + +The memcached server information would then be available through the ENV +variables generated by the link as well as through DNS as `memcache` from +`/etc/hosts`. + +For infomation on configuring your memcached server, see the extensive [wiki](https://code.google.com/p/memcached/wiki/NewStart). diff --git a/memcached/license.md b/memcached/license.md new file mode 100644 index 00000000..6b85e1a8 --- /dev/null +++ b/memcached/license.md @@ -0,0 +1,3 @@ +View [license +information](https://github.com/memcached/memcached/blob/master/LICENSE) for the +software contained in this image. From 8f37a500fc6315162d82a1d4d9fd1bdfb99f3d3a Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Wed, 31 Dec 2014 15:51:01 -0800 Subject: [PATCH 2/3] Add note about memcached SIGTERM --- memcached/README.md | 10 +++++++++- memcached/content.md | 8 ++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/memcached/README.md b/memcached/README.md index a9ea351e..b37e969c 100644 --- a/memcached/README.md +++ b/memcached/README.md @@ -1,6 +1,6 @@ # Supported tags and respective `Dockerfile` links - +- [`1.4.21`, `1.4`, `1`, `latest` (*Dockerfile*)](https://github.com/docker-library/memcached/blob/2abd5c1e975313238af4291264902812a04a1815/Dockerfile) For more information about this image and its history, please see the [relevant manifest file @@ -38,6 +38,14 @@ variables generated by the link as well as through DNS as `memcache` from For infomation on configuring your memcached server, see the extensive [wiki](https://code.google.com/p/memcached/wiki/NewStart). +# Known Issues + +As of 1.4.21, memcached does not handle `SIGTERM`, so a standard `docker stop` +will not stop it gracefully, but will resort to `SIGKILL` after the 10 second +timeout. Use `docker kill -s INT` to do a clean stop of the memcached +container. There is [a PR](https://github.com/memcached/memcached/pull/88) to +change this behavior upstream. + # License View [license diff --git a/memcached/content.md b/memcached/content.md index 66b0c27e..549e4a9c 100644 --- a/memcached/content.md +++ b/memcached/content.md @@ -27,3 +27,11 @@ variables generated by the link as well as through DNS as `memcache` from `/etc/hosts`. For infomation on configuring your memcached server, see the extensive [wiki](https://code.google.com/p/memcached/wiki/NewStart). + +# Known Issues + +As of 1.4.21, memcached does not handle `SIGTERM`, so a standard `docker stop` +will not stop it gracefully, but will resort to `SIGKILL` after the 10 second +timeout. Use `docker kill -s INT` to do a clean stop of the memcached +container. There is [a PR](https://github.com/memcached/memcached/pull/88) to +change this behavior upstream. From b83821676445552c3ac9ae5aaf1410799c97de63 Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Wed, 31 Dec 2014 16:01:01 -0800 Subject: [PATCH 3/3] Swap memcached docker run flags --- memcached/README.md | 4 ++-- memcached/content.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/memcached/README.md b/memcached/README.md index b37e969c..b9fa7419 100644 --- a/memcached/README.md +++ b/memcached/README.md @@ -25,12 +25,12 @@ store, such as a database. # How to use this image - docker run -it --rm --name my-memcache memcached + docker run --name my-memcache -d memcached Start your memcached container with the above command and then you can connect you app to it with standard linking: - docker run -it --link my-memcache:memcache my-app-image + docker run --link my-memcache:memcache -d my-app-image The memcached server information would then be available through the ENV variables generated by the link as well as through DNS as `memcache` from diff --git a/memcached/content.md b/memcached/content.md index 549e4a9c..9515f002 100644 --- a/memcached/content.md +++ b/memcached/content.md @@ -15,12 +15,12 @@ store, such as a database. # How to use this image - docker run -it --rm --name my-memcache memcached + docker run --name my-memcache -d memcached Start your memcached container with the above command and then you can connect you app to it with standard linking: - docker run -it --link my-memcache:memcache my-app-image + docker run --link my-memcache:memcache -d my-app-image The memcached server information would then be available through the ENV variables generated by the link as well as through DNS as `memcache` from