From 213bf6102fae20f8af39a5c2830dc04c160509fc Mon Sep 17 00:00:00 2001 From: Dmitri Popov Date: Tue, 4 Feb 2025 09:50:30 +0100 Subject: [PATCH 1/3] Install agents include --- trento/xml/article_sap_trento.xml | 147 +-------------------- trento/xml/trento-install-agents.xml | 190 +++++++++++++++++++++++++++ 2 files changed, 191 insertions(+), 146 deletions(-) create mode 100644 trento/xml/trento-install-agents.xml diff --git a/trento/xml/article_sap_trento.xml b/trento/xml/article_sap_trento.xml index 6d445b79..19f3c4d6 100644 --- a/trento/xml/article_sap_trento.xml +++ b/trento/xml/article_sap_trento.xml @@ -83,152 +83,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off - -
- Installing &t.agent;s - - Expect changes in the installation procedure - - The product is under active development. Expect changes in the described - installation procedure. - - - - - Before you can install a &t.agent;, retrieve the API key of your &t.server;. - Proceed as follows: - - - - - Open the URL of the Trento Web console (http://TRENTO_SERVER_HOSTNAME). - It prompts you for a user name and password: - - - - - - - - - - - - Enter the credentials for the admin user - (established when installing &t.server;). - - - Click Login. As this is the first time you access the console, - you will be prompted to accept the license agreement. Click Accept to continue. - Otherwise, you cannot use Trento. - - - Once inside the console, go to Settings: - - - - - - - - - - - Click the Copy button to copy the key to your clipboard. - - - - To install the &t.agent; on an SAP host and register it - with the &t.server;, repeat the steps in : - - - Installing &t.agent;s - - - Install the package: - - &prompt.user;sudo zypper ref -&prompt.user;sudo zypper install trento-agent - - - - Open the configuration file /etc/trento/agent.yaml - and uncomment (use #) the entries for - facts-service-url, server-url and - api-key. Update the values appropriately: - - - - facts-service-url: 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. - In a Kubernetes deployment, it is amqp://trento:trento@TRENTO_SERVER_HOSTNAME:5672/. If the default RabbitMQ username and password (trento) were updated using helm, - the parameter must use the custom value. - In a systemd or containerized deployment, the correct value is amqp://TRENTO_USER:TRENTO_USER_PASSWORD@TRENTO_SERVER_HOSTNAME:5672/vhost. If TRENTO_USER and TRENTO_USER_PASSWORD were replaced with custom values, you must use them. - - - - server-url: URL for the Trento Server (http://TRENTO_SERVER_HOSTNAME) - - - - - api-key: the API key retrieved from the Web console - - - - - - - If SSL termination has been enabled on the server side, you can encrypt the - communication from the agent to the server as follows: - - - Provide an HTTPS URL instead of an HTTP one. - - - Import the certificate from the CA that has issued your - &t.server; SSL certificate into the &t.agent; host as follows: - - - Copy the CA certificate in PEM format to /etc/pki/trust/anchors/. - If your CA certificate is in CRT format, convert it to PEM using the openssl - command as follows: - - openssl x509 -in mycert.crt -out mycert.pem -outform PEM - - - Run the update-ca-certificates command. - - - - - - - - Start the &t.agent;: - - &prompt.user;sudo systemctl enable --now trento-agent - - - Check the status of the &t.agent;: - &prompt.user;sudo systemctl status trento-agent -● trento-agent.service - &t.agent; service - Loaded: loaded (/usr/lib/systemd/system/trento-agent.service; enabled; vendor preset: disabled) - Active: active (running) since Wed 2021-11-24 17:37:46 UTC; 4s ago - Main PID: 22055 (trento) - Tasks: 10 - CGroup: /system.slice/trento-agent.service - ├─22055 /usr/bin/trento agent start --consul-config-dir=/srv/consul/consul.d - └─22220 /usr/bin/ruby.ruby2.5 /usr/sbin/SUSEConnect -s - -[...] - - - Repeat this procedure in all SAP hosts that you want to monitor. - - -
+
User management diff --git a/trento/xml/trento-install-agents.xml b/trento/xml/trento-install-agents.xml new file mode 100644 index 00000000..d25eb620 --- /dev/null +++ b/trento/xml/trento-install-agents.xml @@ -0,0 +1,190 @@ + + + + %entities; +]> +
+ Installing &t.agent;s + + Expect changes in the installation procedure + + The product is under active development. Expect changes in the described + installation procedure. + + + + Before you can install a &t.agent;, retrieve the API key of your &t.server;. + Proceed as follows: + + + + + Open the URL of the Trento Web console + (http://TRENTO_SERVER_HOSTNAME). + It prompts you for a user name and password: + + + + + + + + + + + + + Enter the credentials for the admin user (established when installing + &t.server;). + + + + + Click Login. As this is the first time you access the + console, you will be prompted to accept the license agreement. Click + Accept to continue. Otherwise, you cannot use Trento. + + + + + Once inside the console, go to Settings: + + + + + + + + + + + + + Click the Copy button to copy the key to your clipboard. + + + + + To install the &t.agent; on an SAP host and register it with the &t.server;, + repeat the steps in : + + + Installing &t.agent;s + + + Install the package: + +&prompt.user;sudo zypper ref +&prompt.user;sudo zypper install trento-agent + + + + Open the configuration file /etc/trento/agent.yaml + and uncomment (use + #) the entries for facts-service-url, + server-url and api-key. + Update the values appropriately: + + + + + facts-service-url: 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. + + + In a Kubernetes deployment, it is + amqp://trento:trento@TRENTO_SERVER_HOSTNAME:5672/. If the + default RabbitMQ username and password (trento) were updated using + helm, the parameter must use the custom value. + + + In a systemd or containerized deployment, the correct value is + amqp://TRENTO_USER:TRENTO_USER_PASSWORD@TRENTO_SERVER_HOSTNAME:5672/vhost. + If TRENTO_USER and + TRENTO_USER_PASSWORD were replaced with + custom values, you must use them. + + + + + server-url: URL for the Trento Server + (http://TRENTO_SERVER_HOSTNAME) + + + + + api-key: the API key retrieved from the Web console + + + + + + + If SSL termination has been enabled on the server side, you can encrypt + the communication from the agent to the server as follows: + + + + + Provide an HTTPS URL instead of an HTTP one. + + + + + Import the certificate from the CA that has issued your &t.server; + SSL certificate into the &t.agent; host as follows: + + + + + Copy the CA certificate in PEM format to + /etc/pki/trust/anchors/. If your CA + certificate is in CRT format, convert it to PEM using the + openssl command as follows: + +openssl x509 -in mycert.crt -out mycert.pem -outform PEM + + + + Run the update-ca-certificates command. + + + + + + + + + Start the &t.agent;: + +&prompt.user;sudo systemctl enable --now trento-agent + + + + Check the status of the &t.agent;: + +&prompt.user;sudo systemctl status trento-agent +● trento-agent.service - &t.agent; service + Loaded: loaded (/usr/lib/systemd/system/trento-agent.service; enabled; vendor preset: disabled) + Active: active (running) since Wed 2021-11-24 17:37:46 UTC; 4s ago + Main PID: 22055 (trento) + Tasks: 10 + CGroup: /system.slice/trento-agent.service + ├─22055 /usr/bin/trento agent start --consul-config-dir=/srv/consul/consul.d + └─22220 /usr/bin/ruby.ruby2.5 /usr/sbin/SUSEConnect -s + +[...] + + + + Repeat this procedure in all SAP hosts that you want to monitor. + + + +
From fe6988140ee3e7a1837cc6f5fe82b5213cbff350 Mon Sep 17 00:00:00 2001 From: Dmitri Popov Date: Tue, 4 Feb 2025 09:58:21 +0100 Subject: [PATCH 2/3] Language review --- trento/xml/trento-install-agents.xml | 53 +++++++++++++--------------- 1 file changed, 24 insertions(+), 29 deletions(-) diff --git a/trento/xml/trento-install-agents.xml b/trento/xml/trento-install-agents.xml index d25eb620..b529746b 100644 --- a/trento/xml/trento-install-agents.xml +++ b/trento/xml/trento-install-agents.xml @@ -8,21 +8,14 @@ ]>
Installing &t.agent;s - - Expect changes in the installation procedure - - The product is under active development. Expect changes in the described - installation procedure. - - - Before you can install a &t.agent;, retrieve the API key of your &t.server;. + Before you can install a &t.agent;, you must obtain the API key of your &t.server;. Proceed as follows: - Open the URL of the Trento Web console + Open the URL of the Trento Web interface (http://TRENTO_SERVER_HOSTNAME). It prompts you for a user name and password: @@ -38,20 +31,20 @@ Enter the credentials for the admin user (established when installing + class="username">admin user (specified during installation of &t.server;). Click Login. As this is the first time you access the - console, you will be prompted to accept the license agreement. Click - Accept to continue. Otherwise, you cannot use Trento. + console, you are prompted to accept the license agreement. Click + Accept to continue. You cannot use Trento without accepting the license agreement. - Once inside the console, go to Settings: + When you are logged in, go to Settings: @@ -64,7 +57,7 @@ - Click the Copy button to copy the key to your clipboard. + Click the Copy button to copy the key to the clipboard. @@ -84,10 +77,10 @@ Open the configuration file /etc/trento/agent.yaml - and uncomment (use - #) the entries for facts-service-url, + and uncomment (remove the + # character) the entries for facts-service-url, server-url and api-key. - Update the values appropriately: + Update the values as necessary: @@ -98,17 +91,18 @@ &t.server; was deployed. - In a Kubernetes deployment, it is + In a &k8s; deployment, it is amqp://trento:trento@TRENTO_SERVER_HOSTNAME:5672/. If the - default RabbitMQ username and password (trento) were updated using - helm, the parameter must use the custom value. + default RabbitMQ username and password + (trento:trento) were updated using Helm, the + parameter must use a user-defined value. In a systemd or containerized deployment, the correct value is amqp://TRENTO_USER:TRENTO_USER_PASSWORD@TRENTO_SERVER_HOSTNAME:5672/vhost. If TRENTO_USER and - TRENTO_USER_PASSWORD were replaced with - custom values, you must use them. + TRENTO_USER_PASSWORD have been replaced + with custom values, you must use them. @@ -137,16 +131,17 @@ - Import the certificate from the CA that has issued your &t.server; - SSL certificate into the &t.agent; host as follows: + Import the certificate from the Certificate Authority that has + issued your &t.server; SSL certificate into the &t.agent; host as + follows: - Copy the CA certificate in PEM format to - /etc/pki/trust/anchors/. If your CA - certificate is in CRT format, convert it to PEM using the - openssl command as follows: + Copy the CA certificate in the PEM format to + /etc/pki/trust/anchors/. If the CA + certificate is in the CRT format, convert it to PEM using the + following openssl command: openssl x509 -in mycert.crt -out mycert.pem -outform PEM @@ -183,7 +178,7 @@ - Repeat this procedure in all SAP hosts that you want to monitor. + Repeat this procedure on all SAP hosts that you want to monitor. From 11237852170b390f51b7c05572a2c1cce07b3171 Mon Sep 17 00:00:00 2001 From: Dmitri Popov Date: Tue, 4 Feb 2025 11:16:11 +0100 Subject: [PATCH 3/3] Address feedback --- trento/xml/trento-install-agents.xml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/trento/xml/trento-install-agents.xml b/trento/xml/trento-install-agents.xml index b529746b..4585b909 100644 --- a/trento/xml/trento-install-agents.xml +++ b/trento/xml/trento-install-agents.xml @@ -37,9 +37,7 @@ - Click Login. As this is the first time you access the - console, you are prompted to accept the license agreement. Click - Accept to continue. You cannot use Trento without accepting the license agreement. + Click Login.