From 8de3c3caede22d31af8adddfd297594df28d0cd3 Mon Sep 17 00:00:00 2001 From: ZhongbaoShi Date: Tue, 27 Aug 2019 22:49:28 +0800 Subject: [PATCH] Update README.md --- memcached/README.md | 122 +++++++++++++++++++++++++++++++++----------- 1 file changed, 93 insertions(+), 29 deletions(-) diff --git a/memcached/README.md b/memcached/README.md index e10bbbb..5204981 100644 --- a/memcached/README.md +++ b/memcached/README.md @@ -1,36 +1,100 @@ -memcached -========== -This provides a Clear Linux* memcached instance. +# Clear Linux* OS `memcached` container image -Build ------ -``` -docker build -t clearlinux/memcached . -``` + +## What is this image? -Or just pull it from Dockerhub ---------------------------- -``` -docker pull clearlinux/memcached -``` +`clearlinux/memcached` is a Docker image with `memcached` running on top of the +[official clearlinux base image](https://hub.docker.com/_/clearlinux). -Start a memcached server ------------------------ -``` -docker run --network somenetwork --name memcached-server -d clearlinux/memcached -``` + +> [memcached](https://memcached.org/) is a free & open source, high-performance, distributed memory object caching system, +> generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load. -Benchmark test using memtier benchmark ---------------------- -Please refer to the [page](https://github.com/RedisLabs/memtier_benchmark) for details. +For other Clear Linux* OS +based container images, see: https://hub.docker.com/u/clearlinux -``` -docker pull redislabs/memtier_benchmark -docker run --rm --network somenetwork redislabs/memtier_benchmark ./memtier_benchmark --server=memcached-server -p 11211 -P memcache_text -``` +## Why use a clearlinux based image? -Extra Build ARGs ----------------- -- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags + +> [Clear Linux* OS](https://clearlinux.org/) is an open source, rolling release +> Linux distribution optimized for performance and security, from the Cloud to +> the Edge, designed for customization, and manageability. -Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg +Clear Linux* OS based container images use: +* Optimized libraries that are compiled with latest compiler versions and + flags. +* Software packages that follow upstream source closely and update frequently. +* An aggressive security model and best practices for CVE patching. +* A multi-staged build approach to keep a reduced container image size. +* The same container syntax as the official images to make getting started + easy. + +To learn more about Clear Linux* OS, visit: https://clearlinux.org. + + +## Deployment: + +### Deploy with Docker +The easiest way to get started with this image is by simply pulling it from +Docker Hub. + +*Note: This container uses the same syntax as the [official memcached +image](https://hub.docker.com/_/memcached). + +1. Pull the image from Docker Hub: + ``` + docker pull clearlinux/memcached + ``` +2. Start a memcached server + ``` + docker run --network somenetwork --name memcached-server -d clearlinux/memcached + ``` + + +## Build and modify: + +The Dockerfiles for all Clear Linux* OS based container images are available at +https://github.com/clearlinux/dockerfiles. These can be used to build and +modify the container images. + +1. Clone the clearlinux/dockerfiles repository. + ``` + git clone https://github.com/clearlinux/dockerfiles.git + ``` + +2. Change to the directory of the application: + ``` + cd memcached/ + ``` + +3. Build the container image: + ``` + docker build -t clearlinux/memcached . + ``` + + Refer to the Docker documentation for [default build + arguments](https://docs.docker.com/engine/reference/builder/#arg). + Additionally: + + - `swupd_args` - specifies arguments to pass to the Clear Linux* OS software + manager. See the [swupd man + pages](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) + for more information. + + +## Benchmark test: +[memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark) is a high throughput benchmarking tool for memcache protocols +1. Pull the benchmark from redislabs: + ``` + docker pull redislabs/memtier_benchmark + ``` +2. Run memtier benchmark test: + ``` + docker run --rm --network somenetwork redislabs/memtier_benchmark ./memtier_benchmark --server=memcached-server -p 11211 -P memcache_text + ``` + + +## Licenses + +All licenses for the Clear Linux* Project and distributed software can be found +at https://clearlinux.org/terms-and-policies \ No newline at end of file