Skip to content

Commit

Permalink
update scheduling docs p2
Browse files Browse the repository at this point in the history
  • Loading branch information
afourmy committed Dec 5, 2019
1 parent fe6a18a commit 36db240
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 23 deletions.
34 changes: 20 additions & 14 deletions docs/automation/services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,11 @@ edit, duplicate, delete, and run existing ones.
Service Panel
-------------

General
*******
Section ``General``
*******************

Main Parameters
"""""""""""""""

- ``Name`` (**mandatory**) Must be unique.
- ``Description`` / ``Vendor`` / ``Operating System`` Useful for filtering services in the table.
Expand All @@ -42,16 +45,8 @@ to run on 3 devices D1, D2, and D3 with 2 "retries". If it fails on D2 and D3 wh
eNMS will run the service again for D2 and D3 at the first retry. If D2 succeeds and D3 fails, the second and last
retry will run on D3 only.

Specific
********

This section contains all parameters that are specific to the service type. For the "Netmiko Configuration"
service that uses Netmiko to push a configuration, you will find Netmiko parameters (delay factor,
timeout, etc) and a field to enter the configuration that you want to push.
The content of this section is described for each service in the ``Default Services`` section of the docs.

Workflow
********
Workflow Parameters
"""""""""""""""""""

This section contains the parameters that apply **when the service runs inside a workflow only**.

Expand All @@ -61,8 +56,19 @@ This section contains the parameters that apply **when the service runs inside a
- ``Maximum number of runs`` (default: ``1``) Number of time a service is allowed to run in a workflow (de
- ``Waiting time (in seconds)`` (default: ``0``) Number of seconds to wait after the service is done running.

Section ``Specific``
********************

This section contains all parameters that are specific to the service type. For the "Netmiko Configuration"
service that uses Netmiko to push a configuration, you will find Netmiko parameters (delay factor,
timeout, etc) and a field to enter the configuration that you want to push.
The content of this section is described for each service in the ``Default Services`` section of the docs.

Section ``Targets``
*******************

Devices
*******
"""""""

Most services are designed to run on devices from the inventory. There are three properties for selecting devices.
The list of targets will be the union of all devices coming from these properties.
Expand All @@ -79,7 +85,7 @@ The list of targets will be the union of all devices coming from these propertie
- ``Maximum Number of Processes`` (default: ``5``)

Iteration
*********
"""""""""

Validation
**********
Expand Down
67 changes: 58 additions & 9 deletions eNMS/templates/forms/service_form.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@
role="tablist"
aria-multiselectable="true"
>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="inventory/web_connection.html#port-allocation"
href="automation/services.html#main-parameters"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
Expand Down Expand Up @@ -160,7 +160,14 @@ <h4 class="panel-title" style="color:#000;">Main Parameters</h4>
</div>
</div>
</div>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#workflow-parameters"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -230,7 +237,14 @@ <h4 class="panel-title" style="color:#000;">
{% for group_name, group in groups.items() %} {% set group_id =
range(10000) | random %} {% set position = "in" if group.default ==
"expanded" else "" %}
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#section-specific"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -297,7 +311,14 @@ <h4 class="panel-title" style="color:#000;">{{ group_name }}</h4>
role="tablist"
aria-multiselectable="true"
>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#devices"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -362,7 +383,14 @@ <h4 class="panel-title" style="color:#000;">Devices</h4>
</div>
</div>
</div>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#iteration"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -419,7 +447,14 @@ <h4 class="panel-title" style="color:#000;">
role="tablist"
aria-multiselectable="true"
>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#python-postprocessing"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -448,7 +483,14 @@ <h4 class="panel-title" style="color:#000;">
</div>
</div>
</div>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#validation"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down Expand Up @@ -529,7 +571,14 @@ <h4 class="panel-title" style="color:#000;">
</div>
</div>
</div>
<div class="panel" style="border-color: #000">
<div class="panel" style="border-color: #000; position: relative">
<a
class="doc-link"
style="position: absolute; top: 10px; right: 10px"
href="automation/services.html#notification"
target="_blank"
><i class="glyphicon glyphicon-info-sign fa-2x" style="cursor: pointer"></i
></a>
<a
class="panel-heading collapsed"
style="background-color:#ddd;"
Expand Down

0 comments on commit 36db240

Please sign in to comment.