From 11b17487eaf97923aee5ff67bb3eafb605cb6905 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Heidbu=CC=88chel?= <j.heidbuechel@fz-juelich.de> Date: Fri, 5 Jul 2019 11:17:58 +0200 Subject: [PATCH 1/5] Update README --- README.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.rst b/README.rst index 1f0625f..8d4d823 100644 --- a/README.rst +++ b/README.rst @@ -2,3 +2,36 @@ Run ansible playbooks ===================== This docker image can be used to run ansible playbooks with gitlab-ci. + +Update cycle +------------ + +The image gets updated every sunday in the early morning and is available with +the image name `jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible`. + +Interactive usage +----------------- + +The image can also be used to run interactively. + +``` +$ docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible ansible-playbook playbook.yml +``` + +will run `playbook.yml` in the current working directory. For simplification +this command can be added as a function to the resource file of the used shell: + +``` +docker-ansible() { + docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible $@ +} +``` + +With that the following usage is possible: + +``` +$ docker-ansible ansible-playbook playbook.yml +``` + +Aliases or of no use because `$(pwd)` gets evaluated at shell startup and will +be the same for the complete life cycle of the shell. -- GitLab From 624b67dd7e6a300cbc86d86d149a8fbcc5a7cd79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Heidbu=CC=88chel?= <j.heidbuechel@fz-juelich.de> Date: Fri, 5 Jul 2019 11:55:00 +0200 Subject: [PATCH 2/5] Fix code-blocks --- README.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 8d4d823..ee6e232 100644 --- a/README.rst +++ b/README.rst @@ -14,24 +14,24 @@ Interactive usage The image can also be used to run interactively. -``` -$ docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible ansible-playbook playbook.yml -``` +.. code-block:: bash + + $ docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible ansible-playbook playbook.yml will run `playbook.yml` in the current working directory. For simplification this command can be added as a function to the resource file of the used shell: -``` -docker-ansible() { - docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible $@ -} -``` +.. code-block:: bash + + docker-ansible() { + docker run --rm -v $(pwd):/data -w /data jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible $@ + } With that the following usage is possible: -``` -$ docker-ansible ansible-playbook playbook.yml -``` +.. code-block:: bash + + $ docker-ansible ansible-playbook playbook.yml Aliases or of no use because `$(pwd)` gets evaluated at shell startup and will be the same for the complete life cycle of the shell. -- GitLab From 1d1d851facf323b0b38b5bf820faab62a1f3b7a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Heidbu=CC=88chel?= <j.heidbuechel@fz-juelich.de> Date: Fri, 5 Jul 2019 11:57:48 +0200 Subject: [PATCH 3/5] Fix typos --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ee6e232..bae7654 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,8 @@ Run ansible playbooks ===================== -This docker image can be used to run ansible playbooks with gitlab-ci. +This docker image can be used interactively or to run ansible playbooks with +gitlab-ci. Update cycle ------------ @@ -33,5 +34,5 @@ With that the following usage is possible: $ docker-ansible ansible-playbook playbook.yml -Aliases or of no use because `$(pwd)` gets evaluated at shell startup and will +Aliases are of no use because `$(pwd)` gets evaluated at shell startup and will be the same for the complete life cycle of the shell. -- GitLab From df149974cebd24b28d5c70c904efa588ad02e952 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Heidbu=CC=88chel?= <j.heidbuechel@fz-juelich.de> Date: Fri, 5 Jul 2019 11:59:06 +0200 Subject: [PATCH 4/5] Fix typos #2 --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index bae7654..46fae2e 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Run ansible playbooks ===================== -This docker image can be used interactively or to run ansible playbooks with +This docker image can be used to run ansible playbooks interactively or with gitlab-ci. Update cycle -- GitLab From c5a57b5de2fc0022127b025dccc89993dfef04c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jens=20Heidbu=CC=88chel?= <j.heidbuechel@fz-juelich.de> Date: Fri, 5 Jul 2019 12:47:57 +0200 Subject: [PATCH 5/5] Fix grammar --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 46fae2e..51b4f4c 100644 --- a/README.rst +++ b/README.rst @@ -7,7 +7,7 @@ gitlab-ci. Update cycle ------------ -The image gets updated every sunday in the early morning and is available with +The image gets updated every sunday in the early morning and is available by the image name `jugit-registry.fz-juelich.de/docker-images/gitlabci-ansible`. Interactive usage -- GitLab