Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Clarifications #87

Merged
merged 2 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions docs/rest_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,25 +277,6 @@ Run the script for application "my app" using token
}
]

Container Images
================

For development and experimentation purposes a container image exists
at:

https://hub.docker.com/repository/docker/partio/ecflow-http

The image can be used for quick prototyping. It expects that ecFlow
server is found from localhost:3141, change address with ECF_HOST and
ECF_PORT if needed. Server does not have a SSL certificates defined, so it can only be used to query ecFlow server (not alter states etc).

Usage example:

.. code-block:: bash

podman run --rm -p 8080:8080 -it docker.io/partio/ecflow-http
curl -kv https://localhost:8080/v1/server/ping

API v1 Documentation
====================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ format **[h]h:mm** . Only numeric values are allowed. There can be
multiple time dependencies for a node, but overlapping times may cause
unexpected results.

.. note::

Long running Tasks might overrun the next execution slot, and when this happens the execution automatically skips
to the following slot.

To avoid overruning execution slots, instead of a :code:`time` dependency consider specifyting a time-based trigger.
See :ref:`tutorial-time-triggers` for details.


To define a series of times, specify the start time, end time and a time
increment.

Expand All @@ -34,11 +43,11 @@ times you can use two separate time commands.
time 15:00 # run at 15:00
time 19:00 # also run at 19:00

.. note::
.. warning::

You should take care with tasks using the time command to
cause the suite to cycle on fast systems. If the task takes less than a
minute to run then there is a possibility that the trigger will still be
valid once the suite has cycled. This can be avoided by making sure that
such tasks take longer than one minute to run, for example, by adding a
sleep command.
Beware that tasks using a :code:`time` dependency may cause the Suite to cycle on fast systems.

If a task takes less than a minute to run then there is a possibility that the trigger will still be
valid once the suite has cycled.

Avoid this by ensuring that such tasks take longer than one minute to run (e.g. using the :code:`sleep` command).
Loading