startx/sv-memcache repository overview

⁠Docker OS Images : MEMCACHE

Startx memcache is a base container used for distributed cache published in Dockerhub registry⁠. This container contain :

• fedora system envelope
• core OS rpm (kernel, libs) updated every week
• fundamentals tools (ex: pwgen, tar, zip) updated every week
• Memcache SQL server and fundamentals modules (memcache release depend on the flavour you use, read down for more information)
• usefull tools (psmisc, procps, coreutils, findutils, wget, curl, vi, bash-completion) only for the :latest and :devel flavour.

You can use Startx Memcache image in many ways :

• Build container based image cache node with s2i builder technology⁠
• Build container based image cache node with openshift builder image capacity⁠
• Build personalized base image with docker tools⁠
• Run as simple and lightweiht cache node with docker daemon⁠
• Run a minimal container cache node with docker-compose⁠
• Enrich you openshift service catalog with flavoured images streams⁠
• Add to your openshift service catalog a cache node builder template⁠
• Add to your openshift service catalog a cache node deployement template⁠

See more cache nodes builders and sample on startx docker images repository⁠

⁠Container flavours

⁠Running this image

If you want to be guided on setting-up and installing various containers engines (docker⁠, podman⁠, s2i⁠, dockerEE⁠, kubernetes⁠, openshift⁠) you can read ours containers engines guidelines⁠.

⁠Running using docker

docker run -it -p 9278:11211 --name="example-memcache" startx/sv-memcache

• Connect to your local cache node

echo -e 'stats\r' | nc localhost 11211

⁠Running using docker-compose

• Create a docker-compose.yml file with the following content

memcache:
  image: startx/sv-memcache:latest
  container_name: "example-memcache"

• Connect to your local cache node

mysql -h localhost -P 9278

• Execute the following command

docker-compose up -d
docker-compose logs

⁠Using this image as Openshift Build image

⁠Openshift images streams

Openshift cluster administrator can offer this image and all its flavour to all consumers. You can import our openshift images stream⁠ in your openshift project.

You must be cluster-admin to add this image to the openshift project. If not, you can add it to your own project (skip the oc project openshift command in the next script)

# swith to the openshift project
oc project openshift
# Add image streams to the service catalog (project or cluster-wide scope)
oc create -f https://raw.githubusercontent.com/startxfr/docker-images/master/Services/memcache/openshift-imageStreams.yml

⁠Openshift builder template

Openshift cluster administrator can add 2 build and deploy template to their consumers. As an administrator, you can import our openshift ephemeral builder template⁠ as well as our openshift persistent builder template⁠ in your openshift project.

You must be cluster-admin to add this image to the openshift project. If not, you can add it to your own project (skip the oc project openshift command in the next script)

# swith to the openshift project
oc project openshift
# Add this ephemeral template to the service catalog (project or cluster-wide scope)
oc create -f https://raw.githubusercontent.com/startxfr/docker-images/master/Services/memcache/openshift-template-build.yml

You can then build a cache node

# create an example project
oc new-project example
# start a new ephemeral cache node
oc process -f startx-memcache-build-template \
    -p APP_NAME=mycache-e \
| oc create -f -

⁠Openshift deploy template

Openshift cluster administrator can add a deploy template to their consumers. As an administrator, you can import our openshift deploy template⁠ in your openshift project.

You must be cluster-admin to add this image to the openshift project. If not, you can add it to your own project (skip the oc project openshift command in the next script)

# swith to the openshift project
oc project openshift
# Add this ephemeral template to the service catalog (project or cluster-wide scope)
oc create -f https://raw.githubusercontent.com/startxfr/docker-images/master/Services/memcache/openshift-template-deploy.yml

You can then deploy a cache node

# create a example project
oc new-project example
# start a new ephemeral cache node
oc process -f startx-memcache-deploy-template \
    -p APP_NAME=mycache-e \
| oc create -f -

⁠Using this image as S2I builder

Then you can use this image as an s2i builder image

# With your current directory cache node code
s2i build . startx/sv-memcache:latest startx-memcache-mycache
docker run --rm -d -p 9278:11211 startx-memcache-mycache
# With startx cache node sample code repository
s2i build https://github.com/startxfr/docker-images-example-memcache startx/sv-memcache startx-memcache-sample
docker run --rm -d -p 9278:11211 startx-memcache-sample

⁠Using this image as base 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⁠ for instructions on how to use this file.

FROM startx/sv-memcache:latest
#... your container specifications

⁠Environment variable

⁠For advanced users

You can contribute or start this container initiative locally. Follow theses instructions⁠ to setup a working environment.

This section will help you if you want to :

• Get latest version of this container Service source code
• Enhance and share your container improvement by adding instruction in Dockefile

⁠Build & run a container using docker

1. Jump into the container directory with cd Services/memcache
2. Build the container using docker build -t startx-memcache .
3. Run this container
   • Interactively with docker run -it startx-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,...)
   • As a daemon with docker run -d -p 9278:11211 startx-memcache

⁠Build & run a container using docker-compose

1. Jump into the container directory with cd Services/memcache
2. Run this container
   • Interactively with docker-compose up Startup logs appears and escaping this command stop the container
   • As a daemon with docker-compose up -d. Container startup logs can be read using docker-compose logs