summaryrefslogtreecommitdiffstats
path: root/docker
diff options
context:
space:
mode:
authorkshithijiyer <kshithij.ki@gmail.com>2019-06-27 17:54:55 +0530
committerBala Konda Reddy M <bmekala@redhat.com>2019-06-30 17:54:59 +0000
commitf5831a8cd7f6fe54cf6d3ec693b15301516570b8 (patch)
treebccd3a4731b4d7d88f1fa0bd56e6b861c42a8988 /docker
parentf54b94609a3b5fce1fd85f23c06b27bcdfc99b46 (diff)
Converting text files to markdown files.
It's better to use markdown files instead of text files for readme files. Hence converting readme files to readme.md files. Change-Id: I41c1b2f065895d885f4b1fabdc9b9e4051810e80 Signed-off-by: kshithijiyer <kshithij.ki@gmail.com>
Diffstat (limited to 'docker')
-rw-r--r--docker/README26
-rw-r--r--docker/README.md34
2 files changed, 34 insertions, 26 deletions
diff --git a/docker/README b/docker/README
deleted file mode 100644
index 3844e6d..0000000
--- a/docker/README
+++ /dev/null
@@ -1,26 +0,0 @@
-This Dockerfile adds Glusto and the Gluster glustolibs libraries on top of the Fedora container to provide the complete environment required to run Gluster QE tests under Glusto.
-This container is currently based on Fedora and also installs gdeploy as required by NFS Ganesha tests.
-
-This is currently a minimal implementation. More to come.
-
-To use the glusto-tests container, you can run tests using the pre-gen'd container or create a Dockerfile and customize to fit your own needs.
-
-To use the pre-gen'd image...
-
-1. Pull the docker image down to your local system.
-
- # docker pull gluster/glusto-tests
-
-2. Run the image with docker.
-
- # docker run -it --rm --privileged=true -v <local_dir_path>:<container_dir_path> docker.io/gluster/glusto-tests /bin/bash
-
- ... or for example to run a test directly...
-
- # docker run -it --rm --privileged=true \
- -v $WORKSPACE/:/workspace \
- docker.io/gluster/glusto-tests \
- /usr/bin/glusto -c /workspace/myservers.yml \
- --pytest="-vv /workspace/testdir/test_your_test_file.py"
-
-More robust docs and examples coming soon.
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..b2d8e09
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,34 @@
+# Glusto in docker
+This Dockerfile adds Glusto and the Gluster glustolibs libraries on top of the
+Fedora container to provide the complete environment required to run Gluster
+QE tests under Glusto. This container is currently based on Fedora and also
+installs gdeploy as required by NFS Ganesha tests.
+
+**This is currently a minimal implementation. More to come.**
+
+To use the glusto-tests container, you can run tests using the pre-gen'd
+container or create a Dockerfile and customize to fit your own needs.
+To use the pre-gen'd image...
+
+- Pull the docker image down to your local system.
+
+```
+$ docker pull gluster/glusto-tests
+```
+
+- Run the image with docker.
+
+```
+$ docker run -it --rm --privileged=true -v <local_dir_path>:<container_dir_path> docker.io/gluster/glusto-tests /bin/bash
+```
+or for example to run a test directly.
+
+```
+$ docker run -it --rm --privileged=true \
+ -v $WORKSPACE/:/workspace \
+ docker.io/gluster/glusto-tests \
+ /usr/bin/glusto -c /workspace/myservers.yml \
+ --pytest="-vv /workspace/testdir/test_your_test_file.py"
+```
+
+More robust docs and examples coming soon. \ No newline at end of file