1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<!--[metadata]>
+++
title = "STARTX Docker Services Images : MEMCACHE"
description = "Docker container with memcache service based on latest fedora"
keywords = ["home, docker, startx, memcache, fedora, centos, repository, container, swarm, compose"]
weight=3
+++
<![end-metadata]-->
# Docker OS Images : MEMCACHE
Simple and lightweight (130Mo) container used to deliver distributed memory object caching system
Run [memcached daemon](https://httpd.memcached.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora)
| [](https://travis-ci.org/startxfr/docker-images) | [Dockerhub Registry](https://hub.docker.com/r/startx/sv-memcache/) | [Sources](https://github.com/startxfr/docker-images/Services/memcache) | [STARTX Profile](https://github.com/startxfr) |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------------|
## Available flavours
* `:latest` : Fedora core 23 + Memcached
* `:fc23` : Fedora core 23 + Memcached
* `:fc22` : Fedora core 22 + Memcached
* `:fc21` : Fedora core 21 + Memcached
* `:centos7` : CentOS 7 + Memcached
* `:centos6` : Centos 6 + Memcached
## Running from dockerhub registry
* with `docker` you can run `docker run -it --name="sv-memcache" startx/sv-memcache` from any docker host
* with `docker-compose` you can create a docker-compose.yml file with the following content
```
service:
image: startx/sv-memcache:latest
container_name: "sv-memcache"
environment:
CONTAINER_TYPE: "service"
CONTAINER_SERVICE: "memcache"
CONTAINER_INSTANCE: "service-memcache"
SERVER_NAME: "localhost"
DOC_ROOT: "/data/memcache"
volumes:
- "/tmp/container/logs/memcache:/data/logs/memcache"
- "/tmp/container/memcache:/data/memcache"
```
## Docker-compose in various situations
* sample docker-compose.yml linked to host port 1000
```
service:
image: startx/sv-memcache:latest
container_name: "sv-memcache"
environment:
CONTAINER_INSTANCE: "service-memcache"
ports:
- "1000:11211"
```
* sample docker-compose.yml with port exposed only to linked services
```
service:
image: startx/sv-memcache:latest
container_name: "sv-memcache"
environment:
CONTAINER_INSTANCE: "service-memcache"
expose:
- "11211"
```
## Using this image in your own container
You can use this Dockerfile template to start a new personalized container based on this container. Create a file named Dockerfile in your project directory and copy this content inside. See [docker guide](http://docs.docker.com/engine/reference/builder/) for instructions on how to use this file.
```
FROM startx/sv-memcache:latest
#... your container specifications
CMD ["/bin/run.sh"]
```
## Environment variable
| Variable | Type | Mandatory | Description |
|---------------------------|----------|-----------|--------------------------------------------------------------------------|
| CONTAINER_INSTANCE | `string` | `yes` | Container name. Should be uning to get fine grained log and application reporting
| CONTAINER_TYPE | `string` | `no` | Container family (os, service, application. could be enhanced
| CONTAINER_SERVICE | `string` | `no` | Define the type of service or application provided
| HOSTNAME | `auto` | `auto` | Container unique id automatically assigned by docker daemon at startup
| LOG_PATH | `auto` | `auto` | default set to /data/logs/memcache and used as a volume mountpoint
## Exposed port
| Port | Description |
|-------|--------------------------------------------------------------------------|
| 11211 | standard memcached network port used for key/value recovery
## Exposed volumes
| Container directory | Description |
|----------------------|--------------------------------------------------------------------------|
| /data/logs/memcache | log directory used to record container and memcache logs
| /data/memcache | data directory served by memcache. If empty will be filled with app on startup. In other case use content from mountpoint or data volumes
## Testing the service
access to the running memcached daemon with `telnet localhost 11211; stats`. Change port and hostname according to your current configuration
## For advanced users
You want to use this container and code to build and create locally this container, follow theses instructions.
This section will help you if you want to :
* Get latest version of this service container
* Enhance container content by adding instruction in Dockefile before build step
You must have a working environment with the source code of this repository. Read and follow [how to setup your working environment](https://github.com/startxfr/docker-images#setup-your-working-environment-mandatory) to get a working directory. The following instructions assume you are at the top level of your working directory.
### Build & run a container using `docker`
1. Jump into the container directory with `cd Services/memcache`
2. Build the container using `docker build -t sv-memcache .`
3. Run this container
1. Interactively with `docker run -p 11211:11211 -v /data/logs/memcache -it sv-memcache`. If you add a second parameter (like `/bin/bash`) to will run this command instead of the default entrypoint. Usefull to interact with this container (ex: `/bin/bash`, `/bin/ps -a`, `/bin/df -h`,...)
2. As a daemon with `docker run -p 11211:11211 -v /data/logs/memcache -d sv-memcache`
### Build & run a container using `docker-compose`
1. Jump into the container directory with `cd Services/memcache`
2. Run this container
1. Interactively with `docker-compose up` Startup logs appears and escaping this command stop the container
2. As a daemon with `docker-compose up -d`. Container startup logs can be read using `docker-compose logs`
If you experience trouble with port already used, edit docker-compose.yml file and change port mapping
|
