-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,22 +35,22 @@ | |
</listitem> | ||
</itemizedlist> | ||
<para> | ||
The right chevron icon in the activity log entry opens a modal with the activity metadata. | ||
Clicking on the chevron icon in the activity log entry opens a modal window containing the activity metadata. | ||
</para> | ||
<para> | ||
The Activity Log allows to filter by the type of event or user action, | ||
commonly refered to as resource type, and by the user that triggered the | ||
The Activity Log allows to filter by the type of event or user action | ||
(commonly referred to as resource type) and by the user that triggered the | ||
event or performed the action. Only active users are available for | ||
filtering. The Activity Log also allows to filter out entries that are newer | ||
and/or older than an specific date and time (server time). | ||
filtering. The Activity Log also allows you to filter out entries that are | ||
newer and/or older than an specific date and time (server time). | ||
</para> | ||
<para> | ||
Once a filter has been set, the user must click Apply to filter out the | ||
undesired entries and Reset to remove all the filters. | ||
Once a filter has been set, click <guimenu>Apply</guimenu> to filter out the | ||
undesired entries and <guimenu>Reset</guimenu> to remove all the filters. | ||
</para> | ||
<para> | ||
Entries related to user management can only be displayed by users that have | ||
the all:all or all:users permissions. This includes: | ||
the <constant>all:all</constant> or <constant>all:users</constant> permissions. This includes the following: | ||
</para> | ||
<itemizedlist> | ||
<listitem> | ||
|
@@ -75,26 +75,25 @@ | |
</listitem> | ||
<listitem> | ||
<para> | ||
Profile updates. | ||
Profile updates | ||
</para> | ||
</listitem> | ||
</itemizedlist> | ||
<para> | ||
Entries in the Activity Log are sorted from newer to older. By clicking | ||
Refresh, the user can update the Activity Log view with entries generated | ||
since they accessed the view, or after the last refresh. | ||
Entries in the Activity Log are sorted from newer to older. Click | ||
<guimenu>Refresh</guimenu> to update the Activity Log view with entries | ||
generated since they accessed the view or after the last refresh | ||
</para> | ||
<para> | ||
The pagination features at the bottom of the Activity Log allow the user to | ||
specify the number of entries to display in a page, scroll back and forth | ||
through the different pages of the view, and jump directly to the last page | ||
and back to first one. | ||
The pagination features at the bottom of the Activity Log allow you to | ||
specify the number of entries to display in a page, go the next or | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. |
||
previous page of the view, and jump to the last page and back to first one. | ||
</para> | ||
<para> | ||
The default retention time for entries in the Activity Log is one month. | ||
This can be changed in the Activity Log section under Settings. Changing the | ||
retention time requires the all:settings permissions. Entries expired after | ||
the specified retention time are deleted every day at midnight (server | ||
time). | ||
This can be changed in the Activity Log section under | ||
<guimenu>Settings</guimenu>. Changing the retention time requires the | ||
<constant>all:settings</constant> permissions. Entries expired after the | ||
This comment has been minimized.
Sorry, something went wrong.
abravosuse
Collaborator
|
||
specified retention time are deleted every day at midnight (server time). | ||
</para> | ||
</section> |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,28 +9,25 @@ | |
|
||
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="sec-trento-checks"> | ||
<title>Performing configuration checks</title> | ||
<remark>toms 2024-04-18 (change#8): First saptune related configuration checks (host and cluster specific) -> update</remark> | ||
<para> | ||
One of Trento's main features is to provide configuration checks that ensure your infrastructure setup adheres to our Best Practices, | ||
or other vendor's Best Practices, and does not drift away in time. Configuration checks ara available for | ||
&trento; provides configuration checks that ensure your infrastructure setup adheres to our or other vendor's Best Practices, and it does not diverge with time. Configuration checks ara available for | ||
This comment has been minimized.
Sorry, something went wrong. |
||
HANA clusters, ASCS/ERS clusters and hosts. The following procedure is specific to a HANA cluster. The procedure for an ASCS/ERS cluster | ||
or a host would be exactly the same, only starting from the corresponding Details view: | ||
or a host would be exactly the same, except it starts from the corresponding Details view. | ||
</para> | ||
<procedure xml:id="pro-trento-checks"> | ||
<title>Performing configuration checks on a HANA Cluster</title> | ||
<step> | ||
<para>Log in to Trento</para> | ||
<para>Log in to &trento;</para> | ||
</step> | ||
<step> | ||
<para>In the left panel, click <guimenu>Cluster</guimenu>.</para> | ||
</step> | ||
<step> | ||
<para>In the list, search for an &hana; cluster.</para> | ||
<para>In the list, search for a &hana; cluster.</para> | ||
</step> | ||
<step> | ||
<para>Click the respective cluster name in the <guimenu>Name</guimenu> column. | ||
The <guimenu>Details</guimenu> view opens.</para> | ||
<remark>tom 2023-01-16: screenshot</remark> | ||
<figure> | ||
<title>&pace; cluster details</title> | ||
<mediaobject> | ||
|
@@ -42,7 +39,7 @@ | |
</step> | ||
<step xml:id="st-trento-checks-settings"> | ||
<para>Click the <guimenu>Settings</guimenu> button to change the cluster settings of the respective cluster. | ||
For checks to be executed, a checks selection must be made. Select the checks to be executed and click the button <guimenu>Select Checks for Execution</guimenu>. | ||
For checks to be executed, a checks selection must be made. Select the checks to be executed and click <guimenu>Select Checks for Execution</guimenu>. | ||
See <xref linkend="fig-pacemaker-clustersettings-checks"/>: | ||
</para> | ||
<figure xml:id="fig-pacemaker-clustersettings-checks"> | ||
|
@@ -57,16 +54,17 @@ | |
</step> | ||
<step> | ||
<para> | ||
At this moment, you can either wait for Trento to execute the selected checks or trigger an execution | ||
immediately by clicking the button that has appeared in the Checks Selection tab. | ||
<remark>tom 2023-01-16: Why is this a two-step process?</remark> | ||
You can then either wait for &trento; to execute the selected checks or trigger an execution | ||
immediately by clicking the button that has appeared in the <guimenu>Checks Selection</guimenu> tab. | ||
</para> | ||
</step> | ||
<step> | ||
<para> | ||
Investigate the result in the Checks Results view. Each row in this view shows you a check ID, | ||
a short description of the check and the check execution result. By clicking on a row, a section will open | ||
providing information about the execution on each node of the cluster. See <xref linkend="fig-pacemaker-checkresult"/>: | ||
Investigate the result in the <guimenu>Checks Results</guimenu> view. | ||
Each row in the view displays a check ID, a short description of the | ||
check and the check execution result. C on a row to open a section | ||
This comment has been minimized.
Sorry, something went wrong. |
||
that provides information about the execution on each node of the | ||
cluster. See <xref linkend="fig-pacemaker-checkresult"/>: | ||
</para> | ||
<figure xml:id="fig-pacemaker-checkresult"> | ||
<title>Check results for a cluster</title> | ||
|
@@ -77,7 +75,7 @@ | |
</mediaobject> | ||
</figure> | ||
<para> | ||
The result of a check execution can be passing, warning or critical: | ||
The result of a check execution can be passing, warning, critical: | ||
</para> | ||
<itemizedlist> | ||
<listitem> | ||
|
@@ -90,25 +88,24 @@ | |
cluster.</para> | ||
</listitem> | ||
<listitem> | ||
<para><emphasis>Critical</emphasis> means that either the execution itself errored (for | ||
<para><emphasis>Critical</emphasis> means that either the execution itself failed (for | ||
example, a timeout) or the recommendation is not met and is | ||
critical for the well-being of the cluster.</para> | ||
</listitem> | ||
</itemizedlist> | ||
<para> | ||
Use the filter to reduce the list to only show, for example, critical results. | ||
Use the filter to narrow the list to specific results (for example, critical). | ||
</para> | ||
</step> | ||
<step> | ||
<para> | ||
Click a check's link to open the <guimenu>Details</guimenu> view of this check. This shows you | ||
an abstract and how to remedy the problem. The <guimenu>References</guimenu> section contains links to the documentation | ||
of the different vendors to provide more context when necessary. | ||
Close the view with the <keycap function="escape"/> key or click outside of the view. | ||
Click a check's link to open the <guimenu>Details</guimenu> view of the check. This displays an abstract and a possible solution to the problem. The <guimenu>References</guimenu> section contains links to the documentation | ||
This comment has been minimized.
Sorry, something went wrong.
abravosuse
Collaborator
|
||
from the different vendors for more context when necessary. | ||
Close the view by pressing the <keycap function="escape"/> key or click outside of the view. | ||
This comment has been minimized.
Sorry, something went wrong.
abravosuse
Collaborator
|
||
</para> | ||
<para> | ||
For each not-met expectation, there will be a detailed view providing information about it: what facts were gathered, | ||
what values were expected and what was the result of the evaluation. This will help users understand better why a | ||
For each non-met expectation, there is a detailed view with information about it: what facts were gathered, | ||
This comment has been minimized.
Sorry, something went wrong.
abravosuse
Collaborator
|
||
what values were expected, and what was the result of the evaluation. This helps to understand why a | ||
certain configuration check is failing: | ||
</para> | ||
<figure xml:id="fig-non-met-expectation-detail"> | ||
|
@@ -122,8 +119,8 @@ | |
</step> | ||
</procedure> | ||
<para> | ||
Once a check selection for a given cluster has been made, Trento executes them | ||
automatically every five minutes, and results are updated accordingly. A check | ||
execution result icon spinning means that an execution is running. | ||
When checks for a given cluster have been selected, &trento; executes them | ||
automatically every five minutes, updating the results. A spinning check | ||
execution result icon means that an execution is running. | ||
</para> | ||
</section> |
4 comments
on commit def0a22
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
File trento-activity-log.xml reviewed. Two more to go.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
trento-checks.xml also reviewed. One more to go.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, review done @dmpop . Your review brought up stuff that didn't make sense at all or were very poorly redacted. Thank you! If any of the requested changes/suggestions are not clear, let's huddle to clarify them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @dmpop thank you for taking care!
Found some typos and left some comments.
Nothing much to add besides @abravosuse comments.
"go the next" > "go to the next"