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

Changes in SUMA integration #186

Merged
merged 17 commits into from
Dec 6, 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 53 additions & 20 deletions trento/xml/article_sap_trento.xml
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
</listitem>
<listitem>
<para>
Summary of available patches and upgradable packages for each registered hosts via integration
with &suma;.
Information about available patches and upgradable packages for each registered hosts via integration with &suma;.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -783,7 +782,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
which deployment method was used to install &t.server;. </para>
</note>
<para>
User managers can enable and disable users. When a user
User managers can enable and disable users. When a user
logged in the console is disabled by a user admin, their session is
terminated immediately. </para>
</section>
Expand Down Expand Up @@ -866,7 +865,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
<para><parameter>facts-service-url</parameter>: the address of the AMQP RabbitMQ service used
for communication with the checks engine (wanda). The correct value of this parameter depends on
how &t.server; was deployed.</para>
<para> In a Kubernetes deployment, it is <uri>amqp://trento:trento@TRENTO_SERVER_HOSTNAME:5672/</uri>. If the default RabbitMQ username and password (trento) were updated using helm,
<para> In a Kubernetes deployment, it is <uri>amqp://trento:trento@TRENTO_SERVER_HOSTNAME:5672/</uri>. If the default RabbitMQ username and password (trento) were updated using helm,
the parameter must use the custom value. </para>
<para> In a systemd or containerized deployment, the correct value is <uri>amqp://TRENTO_USER:TRENTO_USER_PASSWORD@TRENTO_SERVER_HOSTNAME:5672/vhost</uri>. If <replaceable>TRENTO_USER</replaceable> and <replaceable>TRENTO_USER_PASSWORD</replaceable> were replaced with custom values, you can use them.
</para>
Expand Down Expand Up @@ -955,12 +954,12 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
<title>Activity Log</title>
<para> Trento collects system events and user actions in the Activity Log. It can be accessed from the left-hand side panel of the Trento console.</para>
<para> Each entry in the Activity Log includes the following:
- A timestamp: the day and time (server time, not browser time) the system event or the user action occurred
- A timestamp: the day and time (server time, not browser time) the system event or the user action occurred
- A message: type of the occurred event or user action.
- The user that triggered the event or performed the action. User system is used for events triggered by the system itself.</para>
<para>The right chevron icon in the activity log entry opens a modal with 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 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. When setting time based entries, keep in mind the time difference with the server time. -
The Activity Log also allows to filter out entries that are newer and/or older than an specific date and time. When setting time based entries, keep in mind the time difference with the 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.</para>
<para>Entries related to user management can only be displayed by users that have the all:all or all:users permissions. This includes:
Expand All @@ -970,7 +969,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off
- User deletions
- Profile updates.</para>
<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.</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
<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.</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).</para>
</section>
Expand Down Expand Up @@ -1895,13 +1894,12 @@ In the Trento dashboard, go to the overview corresponding to the object for whic
</section>
</section>


<section xml:id="sec-integration-with-SUSE-Manager">
<title>Integration with &suma;</title>
<para>Trento integrates with &suma; to provide the &sap; admin with
a summary of available patches and upgradable packages for any registered host
that is also managed by given instance of &suma;.</para>
<para>The user must enter the connection settings for the &suma; instance
<para>Trento integrates with &suma; to provide the &sap; administrator with
information about available patches and upgradable packages for any host
that is registered with both applications.</para>
<para>The user must enter the connection settings for &suma;
in the <guimenu>Settings</guimenu> view:</para>
<figure>
<title>&suma; settings</title>
Expand All @@ -1913,11 +1911,11 @@ In the Trento dashboard, go to the overview corresponding to the object for whic
</mediaobject>
</figure>
<para>
With the &suma; settings configured, the &sap; admin can test the connection
by clicking <guimenu>Test Connection</guimenu>.
If the connection is successful, the Host Details view displays a summary
of the available patches and the upgradable packages for each host
managed by &suma;:</para>
Once the &suma; settings are configured, the &sap; administrator can test the connection
by clicking the <guimenu>Test</guimenu> button.
If the connection is successful, the <guimenu>Host Details</guimenu> view of each host
managed by &suma; displays a summary
of available patches and upgradable packages:</para>
<figure>
<title><guimenu>Availale software updates in the Host Details view</guimenu></title>
<mediaobject>
Expand All @@ -1927,9 +1925,44 @@ In the Trento dashboard, go to the overview corresponding to the object for whic
</imageobject>
</mediaobject>
</figure>
<para>There are three types of available patches: security advisories, bug fixes and feature
enhancement. Security advisories are regarded as critical. If one is found,
the health of the host will be set to critical too. The others are to be seen as warnings.</para>
<para>Click on <guimenu>Relevant Patches</guimenu> to open the <guimenu>Relevant Patches</guimenu> overview containing a list of patches available for that particular host:</para>
<figure>
<title><guimenu>Available Patches overview</guimenu></title>
<mediaobject>
<imageobject>
<imagedata
fileref="trento-available-patches-overview.png" />
</imageobject>
</mediaobject>
</figure>
<para>Click <guimenu>Upgradable Packages</guimenu> to open the <guimenu>Upgradable Packages</guimenu> overview containing a list of packages that can be upgraded on that particular host:</para>
<figure>
<title><guimenu>Upgradable Packages overview</guimenu></title>
<mediaobject>
<imageobject>
<imagedata
fileref="trento-upgradable-packages-overview.png" />
</imageobject>
</mediaobject>
</figure>
<para>By clicking on an advisory or patch link, the user will access the corresponding details view,
with relevant information about it such us whether it requires a reboot or not, associated
vulnerabilities, or a list of affected hosts:</para>
<figure>
<title><guimenu>Advisory Details view</guimenu></title>
<mediaobject>
<imageobject>
<imagedata
fileref="trento-advisory-details-view.png" />
</imageobject>
</mediaobject>
</figure>
<para>There are three types of patches or advisories: security advisories, bug fixes and feature
enhancements. Security advisories are regarded as critical. If one is avaiable,
the health of the host will be set to critical. If there are available patches but none of them
is a security one, the health of the host will switch to warning. When a host cannot be found in
&suma; or there is a problem retrieving the data for it, its health is set as unknnown.
</para>
<para>
At any time, the user can clear the &suma; settings from the Settings view.
As a result, all information about available software updates disappears from the console and the status of the hosts is adjusted accordingly.</para>
Expand Down
Loading