Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

Commit c0dfa29

Browse files
authored
Merge pull request #107 from jdeathe/issue/101
CLOSES #101: Adds documentation / description improvements.
2 parents a800018 + e74f1bb commit c0dfa29

File tree

4 files changed

+41
-45
lines changed

4 files changed

+41
-45
lines changed

CHANGELOG.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Change Log
22

3-
## centos-7
3+
## 2 - centos-7
44

5-
Summary of release changes for Version 2.
5+
Summary of release changes.
66

7-
CentOS-7 7.5.1804 x86_64 - Memcached 1.4.
7+
### 2.3.0 - Unreleased
8+
9+
- Updates CHANGELOG.md to simplify maintenance.
10+
- Updates README.md to simplify contents and improve readability.
11+
- Updates README-short.txt to apply to all image variants.
12+
- Updates Dockerfile `org.deathe.description` metadata LABEL for consistency.
813

914
### 2.2.1 - 2019-03-20
1015

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jdeathe/centos-ssh-memcached:${RELEASE_VERSION} \
7777
org.deathe.license="MIT" \
7878
org.deathe.vendor="jdeathe" \
7979
org.deathe.url="https://github.com/jdeathe/centos-ssh-memcached" \
80-
org.deathe.description="CentOS-7 7.5.1804 x86_64 - Memcached 1.4."
80+
org.deathe.description="Memcached 1.4 - CentOS-7 7.5.1804 x86_64."
8181

8282
HEALTHCHECK \
8383
--interval=1s \

README-short.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
CentOS-7 7.5.1804 x86_64 - Memcached.
1+
Memcached - CentOS.

README.md

Lines changed: 31 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,20 @@
1-
centos-ssh-memcached
2-
====================
1+
## Tags and respective `Dockerfile` links
32

4-
Docker Image including:
3+
- `centos-7`,`centos-7-2.2.1`,[`2.2.1`](https://github.com/jdeathe/centos-ssh-memcached/releases/tag/2.2.1) [(centos-7/Dockerfile)](https://github.com/jdeathe/centos-ssh-memcached/blob/centos-7/Dockerfile)
4+
- `centos-6`,`centos-6-1.3.1`,[`1.3.1`](https://github.com/jdeathe/centos-ssh-memcached/releases/tag/1.3.1) [(centos-6/Dockerfile)](https://github.com/jdeathe/centos-ssh-memcached/blob/centos-6/Dockerfile)
55

6-
- CentOS-6 6.10 x86_64 and Memcached 1.4.
7-
- CentOS-7 7.5.1804 x86_64 and Memcached 1.4.
6+
## Overview
87

9-
## Overview & links
8+
This build uses the base image [jdeathe/centos-ssh](https://github.com/jdeathe/centos-ssh) so inherits it's features but with `sshd` disabled by default. [Supervisor](http://supervisord.org/) is used to start the [`memcached`](https://github.com/memcached/memcached/wiki) daemon when a docker container based on this image is run.
109

11-
The latest CentOS-6 / CentOS-7 based releases can be pulled from the `centos-6` / `centos-7` Docker tags respectively. For production use it is recommended to select a specific release tag - the convention is `centos-6-1.3.1` OR `1.3.1` for the [1.3.1](https://github.com/jdeathe/centos-ssh-memcached/tree/1.3.1) release tag and `centos-7-2.2.1` OR `2.2.1` for the [2.2.1](https://github.com/jdeathe/centos-ssh/tree/2.2.1) release tag.
10+
### Image variants
1211

13-
### Tags and respective `Dockerfile` links
12+
- [Memcached 1.4 - CentOS-7]((https://github.com/jdeathe/centos-ssh-memcached/tree/centos-7))
13+
- [Memcached 1.4 - CentOS-6](https://github.com/jdeathe/centos-ssh-memcached/tree/centos-6)
1414

15-
- `centos-7`,`centos-7-2.2.1`,`2.2.1` [(centos-7/Dockerfile)](https://github.com/jdeathe/centos-ssh-memcached/blob/centos-7/Dockerfile)
16-
- `centos-6`,`centos-6-1.3.1`,`1.3.1` [(centos-6/Dockerfile)](https://github.com/jdeathe/centos-ssh-memcached/blob/centos-6/Dockerfile)
15+
## Quick start
1716

18-
Included in the build are the [SCL](https://www.softwarecollections.org/), [EPEL](http://fedoraproject.org/wiki/EPEL) and [IUS](https://ius.io) repositories. Installed packages include [OpenSSH](http://www.openssh.com/portable.html) secure shell, [vim-minimal](http://www.vim.org/), are installed along with python-setuptools, [supervisor](http://supervisord.org/) and [supervisor-stdout](https://github.com/coderanger/supervisor-stdout).
19-
20-
Supervisor is used to start the memcached (and optionally the sshd) daemon when a docker container based on this image is run. To enable simple viewing of stdout for the service's subprocess, supervisor-stdout is included. This allows you to see output from the supervisord controlled subprocesses with `docker logs {docker-container-name}`.
21-
22-
If enabling and configuring SSH access, it is by public key authentication and, by default, the [Vagrant](http://www.vagrantup.com/) [insecure private key](https://github.com/mitchellh/vagrant/blob/master/keys/vagrant) is required.
23-
24-
### SSH Alternatives
25-
26-
SSH is not required in order to access a terminal for the running container. The simplest method is to use the docker exec command to run bash (or sh) as follows:
27-
28-
```
29-
$ docker exec -it {docker-name-or-id} bash
30-
```
31-
32-
For cases where access to docker exec is not possible the preferred method is to use Command Keys and the nsenter command.
33-
34-
## Quick Example
17+
> For production use, it is recommended to select a specific release tag as shown in the examples.
3518
3619
Run up a container named `memcached.1` from the docker image `jdeathe/centos-ssh-memcached` on port 11211 of your docker host.
3720

@@ -43,13 +26,20 @@ $ docker run -d \
4326
jdeathe/centos-ssh-memcached:2.2.1
4427
```
4528

46-
Now you can verify it is initialised and running successfully by inspecting the container's logs.
29+
Verify the named container's process status and health.
30+
31+
```
32+
$ docker ps -a \
33+
-f "name=memcached.1"
34+
```
35+
36+
Verify successful initiallisation of the named container.
4737

4838
```
4939
$ docker logs memcached.1
5040
```
5141

52-
To verify the Memcached service status:
42+
Verify the status of the `memcached` service that's running in the named container.
5343

5444
```
5545
$ docker exec -it \
@@ -61,18 +51,19 @@ $ docker exec -it \
6151

6252
### Running
6353

64-
To run the a docker container from this image you can use the standard docker commands. Alternatively, if you have a checkout of the [source repository](https://github.com/jdeathe/centos-ssh-memcached), and have make installed the Makefile provides targets to build, install, start, stop etc. where environment variables can be used to configure the container options and set custom docker run parameters.
54+
To run the a docker container from this image you can use the standard docker commands as shown in the example below. Alternatively, there's a [docker-compose](https://github.com/jdeathe/centos-ssh-memcached/blob/centos-7/docker-compose.yml) example.
6555

66-
In the following example the memcached service is bound to port 11211 of the docker host. Also, the environment variable `MEMCACHED_CACHESIZE` has been used to set up a 32M memory based storage instead of the default 64M.
56+
For production use, it is recommended to select a specific release tag as shown in the examples.
6757

6858
#### Using environment variables
6959

60+
In the following example the `memcached` service is bound to port `11211` of the docker host. Also, the environment variable `MEMCACHED_CACHESIZE` has been used to set up a 32M memory based storage instead of the default 64M.
61+
7062
```
7163
$ docker stop memcached.1 && \
72-
docker rm memcached.1
73-
$ docker run \
64+
docker rm memcached.1 && \
65+
docker run \
7466
--detach \
75-
--tty \
7667
--name memcached.1 \
7768
--publish 11211:11211/tcp \
7869
--sysctl "net.core.somaxconn=1024" \
@@ -82,22 +73,22 @@ $ docker run \
8273
jdeathe/centos-ssh-memcached:2.2.1
8374
```
8475

85-
#### Environment Variables
76+
### Environment variables
8677

87-
There are environmental variables available which allows the operator to customise the running container.
78+
Environment variables are available, as detailed below, to allow the operator to configure a container on run. Environment variable values cannot be changed after running the container; it's a one-shot type setting. If you need to change a value you have to terminate, (i.e stop and remove), and replace the running container.
8879

89-
##### MEMCACHED_AUTOSTART_MEMCACHED_WRAPPER
80+
#### MEMCACHED_AUTOSTART_MEMCACHED_WRAPPER
9081

9182
It may be desirable to prevent the startup of the memcached-wrapper script. For example, when using an image built from this Dockerfile as the source for another Dockerfile you could disable memcached from startup by setting `MEMCACHED_AUTOSTART_MEMCACHED_WRAPPER` to `false`. The benefit of this is to reduce the number of running processes in the final container. Another use for this would be to make use of the packages installed in the image such as `memcached-tool` or the libmemcached tools `memcp`, `memcat`, `memrm` and `memflush`; effectively making the container a Memcached client.
9283

93-
##### MEMCACHED_CACHESIZE
84+
#### MEMCACHED_CACHESIZE
9485

9586
Use `MEMCACHED_CACHESIZE` MB memory max to use for object storage; the default is 64 megabytes.
9687

97-
##### MEMCACHED_MAXCONN
88+
#### MEMCACHED_MAXCONN
9889

9990
Use `MEMCACHED_MAXCONN` max simultaneous connections; the default is 1024.
10091

101-
##### MEMCACHED_OPTIONS
92+
#### MEMCACHED_OPTIONS
10293

10394
Use `MEMCACHED_OPTIONS` to set other memcached options. The default is `-U 0` which disables UDP.

0 commit comments

Comments
 (0)