Skip to content

Documentation for purging tokens #1139

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.

Sign up for GitHub

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

Merged
cognifloyd merged 1 commit into from
Jul 21, 2022
Merged

Documentation for purging tokens #1139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 19 additions & 0 deletions docs/source/troubleshooting/purging_old_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ as shown below:
rule_enforcements_ttl = 25
workflow_executions_ttl = 18
task_executions_ttl = 19
tokens_ttl = 21

In this case, the following objects will be automatically deleted:

Expand All @@ -41,6 +42,7 @@ In this case, the following objects will be automatically deleted:
* rule enforcement objects older than 25 days
* workflow execution objects older than 18 days
* workflow task execution objects older than 19 days
* token objects whose expiry was older than 21 days

The lowest supported TTL is 7 days. If you need to delete old data more frequently, check the
manual purge scripts below.
Expand Down Expand Up @@ -190,3 +192,20 @@ inside a screen/tmux session. For example:
.. code-block:: bash

screen -d -m -S purge-instances /opt/stackstorm/st2/bin/st2-purge-task-executions --config-file /etc/st2/st2.conf --timestamp="2015-11-25T21:45:00.000000Z"

Purging Token Instances whose Expiry is Older than Some Timestamp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: bash

/opt/stackstorm/st2/bin/st2-purge-tokens --config-file /etc/st2/st2.conf --timestamp="2015-11-25T21:45:00.000000Z"

Again, the timestamp provided is interpreted as a UTC timestamp. Please perform all necessary
timezone conversions and specify time in UTC.

This script may take some time to complete, depending on data volumes. We recommend running it
inside a screen/tmux session. For example:

.. code-block:: bash

screen -d -m -S purge-instances /opt/stackstorm/st2/bin/st2-purge-tokens --config-file /etc/st2/st2.conf --timestamp="2015-11-25T21:45:00.000000Z"