From 98f04d22225d557944f610247570a0ed9b424099 Mon Sep 17 00:00:00 2001 From: startxfr Date: Sat, 5 Dec 2015 03:08:30 +0100 Subject: improving mongo README.md --- Services/mongo/README.md | 93 +++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 49 deletions(-) diff --git a/Services/mongo/README.md b/Services/mongo/README.md index 6d94d9c..e8dda4e 100644 --- a/Services/mongo/README.md +++ b/Services/mongo/README.md @@ -1,46 +1,44 @@ -# Docker OS Images : APACHE +# Docker OS Images : MONGO -Simple and lightweight (120Mo) container used to deliver static http content include all apache's modules but no external languages engines (like php). For dynamic content, you should use our [sv-php service container](https://hub.docker.com/r/startx/sv-php) -Run [apache httpd daemon](https://httpd.apache.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) +Simple and lightweight (120Mo) container used to deliver document-oriented database +Run [mongodb daemon](https://httpd.mongodb.org/) under a container based on [startx/fedora container](https://hub.docker.com/r/startx/fedora) -| [![Build Status](https://travis-ci.org/startxfr/docker-images.svg)](https://travis-ci.org/startxfr/docker-images) | [Dockerhub Registry](https://hub.docker.com/r/startx/sv-apache/) | [Sources](https://github.com/startxfr/docker-images/Services/apache) | [STARTX Profile](https://github.com/startxfr) | -|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------------------------------------------| +| [![Build Status](https://travis-ci.org/startxfr/docker-images.svg)](https://travis-ci.org/startxfr/docker-images) | [Dockerhub Registry](https://hub.docker.com/r/startx/sv-mongo/) | [Sources](https://github.com/startxfr/docker-images/Services/mongo) | [STARTX Profile](https://github.com/startxfr) | +|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|---------------------------------------------------------------------------------|-----------------------------------------------| ## Available flavours -* `:latest` : Fedora core 23 + Apache -* `:fc23` : Fedora core 23 + Apache -* `:fc22` : Fedora core 22 + Apache -* `:fc21` : Fedora core 21 + Apache -* `:centos7` : CentOS 7 + Apache -* `:centos6` : Centos 6 + Apache +* `:latest` : Fedora core 23 + Mongo +* `:fc23` : Fedora core 23 + Mongo +* `:fc22` : Fedora core 22 + Mongo +* `:fc21` : Fedora core 21 + Mongo +* `:centos7` : CentOS 7 + Mongo +* `:centos6` : Centos 6 + Mongo ## Running from dockerhub registry -* with `docker` you can run `docker run -it --name="sv-apache" startx/sv-apache` from any docker host +* with `docker` you can run `docker run -it --name="sv-mongo" startx/sv-mongo` from any docker host * with `docker-compose` you can create a docker-compose.yml file with the following content ``` service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-mongo:latest + container_name: "sv-mongo" environment: CONTAINER_TYPE: "service" - CONTAINER_SERVICE: "apache" - CONTAINER_INSTANCE: "service-apache" - SERVER_NAME: "localhost" - DOC_ROOT: "/data/apache" + CONTAINER_SERVICE: "mongo" + CONTAINER_INSTANCE: "service-mongo" volumes: - - "/tmp/container/logs/apache:/data/logs/apache" - - "/tmp/container/apache:/data/apache" + - "/tmp/container/logs/mongo:/data/logs/mongo" + - "/tmp/container/mongo:/data/mongo" ``` ## Docker-compose in various situations @@ -48,20 +46,20 @@ service: * sample docker-compose.yml linked to host port 1000 ``` service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-mongo:latest + container_name: "sv-mongo" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-mongo" ports: - "1000:27017" ``` * sample docker-compose.yml with port exposed only to linked services ``` service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-mongo:latest + container_name: "sv-mongo" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-mongo" expose: - "27017" ``` @@ -69,14 +67,14 @@ service: ``` data: image: startx/fedora:latest - container_name: "sv-apache-data" + container_name: "sv-mongo-data" environment: - CONTAINER_INSTANCE: "service-apache-data" + CONTAINER_INSTANCE: "service-mongo-data" service: - image: startx/sv-apache:latest - container_name: "sv-apache" + image: startx/sv-mongo:latest + container_name: "sv-mongo" environment: - CONTAINER_INSTANCE: "service-apache" + CONTAINER_INSTANCE: "service-mongo" volume_from: - data:rw ``` @@ -85,7 +83,7 @@ service: 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-apache:latest +FROM startx/sv-mongo:latest #... your container specifications CMD ["/bin/run.sh"] ``` @@ -97,29 +95,26 @@ CMD ["/bin/run.sh"] | 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 -| SERVER_NAME | `string` | `no` | Server name for this container. If no name localhost will be assigned | HOSTNAME | `auto` | `auto` | Container unique id automatically assigned by docker daemon at startup -| DOC_ROOT | `auto` | `auto` | document root, will use the $APP_PATH variable -| LOG_PATH | `auto` | `auto` | is set to /data/logs/apache and used as a volume mountpoint -| APP_PATH | `auto` | `auto` | is set to /data/apache and used as a volume mountpoint +| LOG_PATH | `auto` | `auto` | is set to /data/logs/mongo and used as a volume mountpoint +| DATA_PATH | `auto` | `auto` | is set to /data/mongo and used as a volume mountpoint ## Exposed port | Port | Description | |-------|--------------------------------------------------------------------------| -| 27017 | standard httpd network port used for non encrypted http traffic -| 443 | SSL enabeled http port used for encrypted traffic (certificate not actually implemented) +| 27017 | standard mongodb network port used for non encrypted traffic ## Exposed volumes | Container directory | Description | |----------------------|--------------------------------------------------------------------------| -| /data/logs/apache | log directory used to record container and apache logs -| /data/apache | data directory served by apache. If empty will be filled with app on startup. In other case use content from mountpoint or data volumes +| /data/logs/mongo | log directory used to record container and mongo logs +| /data/mongo | data directory served by mongo. 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 webserver with your favorites browser `firefox http://localhost:27017`. Change port and hostname according to your current configuration +access to the running webserver with your favorites browser `mongo localhost:27017`. Change port and hostname according to your current configuration ## For advanced users @@ -133,16 +128,16 @@ You must have a working environment with the source code of this repository. Rea ### Build & run a container using `docker` -1. Jump into the container directory with `cd Services/apache` -2. Build the container using `docker build -t sv-apache .` +1. Jump into the container directory with `cd Services/mongo` +2. Build the container using `docker build -t sv-mongo .` 3. Run this container - 1. Interactively with `docker run -p 27017:27017 -v /data/logs/apache -it sv-apache`. 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 27017:27017 -v /data/logs/apache -d sv-apache` + 1. Interactively with `docker run -p 27017:27017 -v /data/logs/mongo -it sv-mongo`. 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 27017:27017 -v /data/logs/mongo -d sv-mongo` ### Build & run a container using `docker-compose` -1. Jump into the container directory with `cd Services/apache` +1. Jump into the container directory with `cd Services/mongo` 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` -- cgit v1.2.3