diff --git a/README.rst b/README.rst index 3e8bc09a45b08e731852fbc74b2f673db2887481..052f082aa76f463652c3d20396057b61e75a24b8 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,10 @@ experiment logic is made **reusable** by the following EnOSlib building blocks: run your experiment on different environments (locally with Vagrant, Grid'5000, Chameleon and more) - **Reusable software provisioning**: In order to configure your nodes, EnOSlib - exposes different APIs with different level of expressivity + exposes different APIs with different level of expressivity. + For instance EnOSlib's modules let you run remote atomic actions safely on remote + hosts while EnOSlib's services can deploy complex software stacks with few lines + of code. - **Reusable experiment facilities**: Tasks help you to organize your experimentation workflow. diff --git a/docs/tutorials/ansible-integration.rst b/docs/tutorials/ansible-integration.rst index b2b9a8129c75ea0c25c3fe9cc1ed9d056f3e65a9..82f7e85910ab097fda7d43249d7a04ff6d5eb289 100644 --- a/docs/tutorials/ansible-integration.rst +++ b/docs/tutorials/ansible-integration.rst @@ -28,7 +28,7 @@ Let's consider the following script : .. literalinclude:: ansible-integration/run_command.py :language: python :linenos: - :emphasize-lines: 32 + :emphasize-lines: 32-34 - :py:func:`~enoslib.api.run_command` takes at least 3 parameters : @@ -68,7 +68,7 @@ Let's consider the following script: .. literalinclude:: ansible-integration/flent_on.py :language: python :linenos: - :emphasize-lines: 24-40 + :emphasize-lines: 43-49 In this example each ``play_on`` block run a playbook generated from the ansible module calls made. @@ -76,7 +76,6 @@ Any ansible module can be called here, the exact keyword arguments to pass depend on each module and you'll need to refer to the ansible modules documentation (e.g https://docs.ansible.com/ansible/latest/modules/apt_module.html). -Currently, top-level keywords (e.g register, loop aren't supported). Using a yaml playbook diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst index fb49e0761a98da045a94143dc43fee07683e9478..495e982f3d24984b47d4e4b8cc51bc9ed5befd18 100644 --- a/docs/tutorials/index.rst +++ b/docs/tutorials/index.rst @@ -1,8 +1,3 @@ -.. enoslib documentation master file, created by - sphinx-quickstart on Thu Sep 21 21:45:39 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - ********* Tutorials ********* diff --git a/docs/tutorials/vagrant.rst b/docs/tutorials/vagrant.rst index 47e1e684f40df3d3d1b0cfa2daee6c6bcbc8438d..c52df1ab7e77f2a71e5b9d0f365d7ea90a56a2da 100644 --- a/docs/tutorials/vagrant.rst +++ b/docs/tutorials/vagrant.rst @@ -1,5 +1,6 @@ +****************** Provider::Vagrant -================= +****************** .. contents:: :depth: 2