summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md42
1 files changed, 25 insertions, 17 deletions
diff --git a/README.md b/README.md
index 64540c4..6b0467e 100644
--- a/README.md
+++ b/README.md
@@ -63,36 +63,44 @@ This section is usefull if you want :
* Ehance container content by adding instruction into container(s) Dockefile before the build process
* Use this set of container and flavour to benchmark application performance
-### Setup your working environment
+### Setup your working environment (mandatory)
1. **Install docker and docker-compose on you environment**
- a. Check if you have a running docker daemon using `docker --version` If not try to run it using `sudo docker --daemon`. If docker is not installed, follow [docker installation guidelines](https://docs.docker.com/v1.8/installation/)
- b. Check if you have docker compose installed using `docker-compose --version`. If docker-compose is not installed, follow [docker-compose installation guidelines](https://docs.docker.com/compose/install/)
+ 1. Check if you have a running docker daemon using `docker --version` If not try to run it using `sudo docker --daemon`. If docker is not installed, follow [docker installation guidelines](https://docs.docker.com/v1.8/installation/)
+ 2. Check if you have docker compose installed using `docker-compose --version`. If docker-compose is not installed, follow [docker-compose installation guidelines](https://docs.docker.com/compose/install/)
2. **Copy repository source locally**
- a. Setup a working directory with `mkdir startx-docker-images; cd startx-docker-images;`
- b. Clone source repository with `git clone https://github.com/startxfr/docker-images.git .`
+ 1. Setup a working directory with `mkdir startx-docker-images; cd startx-docker-images;`
+ 2. Clone source repository with `git clone https://github.com/startxfr/docker-images.git .`
### Build all containers (using docker-compose)
+
If you want to build and run locally all the images provided in this repository, you can follow this instructions
-3. Run a complete set of container
- a. Choose your flavour with `git checkout ≤flavour_name>`. You can use every flavour available in this repository. Default is set to master branch related to the `:latest` flavour
- b. Create host directory to store container content with `mkdir /tmp/container`.
- c. Start building all containers with `docker-compose build`. You should be on top of your working directory to run this command. It will use the docker-compose.yml file located into this directory.
- d. Wait... (could take some time as you are building the complete list of services
- e. Run your multi-container with `docker-compose up -d`
- f. Look at your containers startup with `docker-compose logs`. You can add a service name to get logs about this specific container. You can also monitor /tmp/container/logs to see logs comming from all containers
- g. Monitor containers with `docker-compose ps`.
+1. Choose your flavour with `git checkout ≤flavour_name>`. You can use every flavour available in this repository. Default is set to master branch related to the `:latest` flavour
+2. Create host directory to store container content with `mkdir /tmp/container`.
+3. Start building all containers with `docker-compose build`. You should be on top of your working directory to run this command. It will use the docker-compose.yml file located into this directory.
+4. Wait... (could take some time as you are building the complete list of services
+5. Run your multi-container with `docker-compose up -d`
+6. Look at your containers startup with `docker-compose logs`. You can add a service name to get logs about this specific container. You can also monitor /tmp/container/logs to see logs comming from all containers
+7. Monitor containers with `docker-compose ps`.
-### Build a single container
+### Run a single container
-### Build a container using `docker`
+### Build & run a container using `docker`
1. Build the container using `docker build -t <image_name> <path_to_Dockerfile>` where *image_name* is the name of your future local image and *path_to_Dockerfile* should point to the targeted service or application directory, not including the Dockefile filename
2. Run this container
- a. Interactively with `docker run -it <image_name>` where *image_name* is the name of your previously created image name. If you add a second parameter, you can run a particular command instead of the default entrypoint. Could be usefull when you add ` /bin/bash` to get a shell running into the container
- b. As a deamon with `docker run -d <image_name>` where *image_name* is the name of your previously created image name.
+ 1. Interactively with `docker run -it <image_name>` where *image_name* is the name of your previously created image name. If you add a second parameter, you can run a particular command instead of the default entrypoint. Could be usefull when you add ` /bin/bash` to get a shell running into the container
+ 2. As a daemon with `docker run -d <image_name>` where *image_name* is the name of your previously created image name.
+
+
+### Build & run a container using `docker-compose`
+
+1. Jump into the container directory you wan to build with `cd <path_to_service>` where *path_to_service* is the targeted service or application directory, not including the docker-compose.yml filename
+2. Run this container
+ 1. Interactively with `docker-compose up`You should see container startup logs and escaping this command will stop the container
+ 2. As a daemon with `docker-compose up -d`. You can look at your container startup and behaviour with `docker-compose logs`