Skip to content

Commit

Permalink
Add more information
Browse files Browse the repository at this point in the history
  • Loading branch information
EMaksy committed Jan 24, 2025
1 parent 43332aa commit 6ee1f3f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
9 changes: 6 additions & 3 deletions trento/adoc/helm_event_pruning.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ The following configurations are available:

`+pruneEventsOlderThan+`::
The number of days registered events are stored in the database. The
default value is *10*.
default value is *10*. _Beware that `+pruneEventsOlderThan+` can be
set to *0* but that would mean that all events are deleted every time
the cron job runs, making it impossible to analyze/troubleshoot any
issue with the application_
`+pruneEventsCronjobSchedule+`::
The frequency of the cron job that deletes expired events. The default
value is *"0 0 * * *"*, which runs daily at midnight.
Expand All @@ -35,8 +38,8 @@ Replace the placeholders with the desired values:
`+ADMIN_PASSWORD+`::
The password for the admin user.

Example command to retain events for 30 days and schedule pruning daily
at 3 AM:
*Example* command to retain events for 30 days and schedule pruning
daily at 3 AM:

[source,bash]
----
Expand Down
4 changes: 3 additions & 1 deletion trento/xml/article_sap_trento.xml
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
</step>
</procedure>
</section>
<xi:include href="helm_event_pruning.xml"/>

<section xml:id="sec-trento-install-trentoserver-on-k3s">
<title>Installing &t.server; on K3s</title>
<para> If you do not have a &k8s; cluster or have one but do not want to use
Expand Down Expand Up @@ -562,6 +562,8 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
--set trento-runner.nodeSelector.<replaceable>LABEL</replaceable>=<replaceable>VALUE</replaceable></screen>
</section>

<xi:include href="helm_event_pruning.xml"/>

<section xml:id="sec-trento-enabling-email-alerts">
<title>Enabling email alerts</title>
<para>
Expand Down
8 changes: 6 additions & 2 deletions trento/xml/helm_event_pruning.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@
<variablelist>
<varlistentry>
<term><literal>pruneEventsOlderThan</literal></term>
<listitem>
<listitem>
<para>
The number of days registered events are stored in the database.
The default value is <emphasis role="bold">10</emphasis>.
<emphasis>Beware that <literal>pruneEventsOlderThan</literal> can be set to <emphasis role="bold">0</emphasis>
but that would mean that all events are deleted every time
the cron job runs, making it impossible to analyze/troubleshoot
any issue with the application</emphasis>
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -65,7 +69,7 @@
</varlistentry>
</variablelist>
<para>
Example command to retain events for 30 days and schedule pruning daily at 3 AM:
<emphasis role="bold">Example</emphasis> command to retain events for 30 days and schedule pruning daily at 3 AM:
</para>
<programlisting language="bash">helm install trento-server . \
--set trento-web.pruneEventsOlderThan=30 \
Expand Down

0 comments on commit 6ee1f3f

Please sign in to comment.