From 7a69b5d46969c0f17a4840d89723e72b3706dc43 Mon Sep 17 00:00:00 2001 From: Alberto Bravo Date: Thu, 10 Aug 2023 10:38:52 +0200 Subject: [PATCH] Review of installation, update and uninstallation procedures (#86) General improvements to installation and update procedures. Co-authored-by: Tom Schraitle --- trento/xml/article_sap_trento.xml | 184 +++++++++++++----------------- 1 file changed, 78 insertions(+), 106 deletions(-) diff --git a/trento/xml/article_sap_trento.xml b/trento/xml/article_sap_trento.xml index f927c13d..527a1546 100644 --- a/trento/xml/article_sap_trento.xml +++ b/trento/xml/article_sap_trento.xml @@ -175,21 +175,22 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off - If you already use a CNCF-certified &k8s;, + If you already use a CNCF-certified &k8s; cluster, you can run the &t.server; in it. - If you have no &k8s; and want enterprise + If you have no &k8s; cluster and want enterprise support, &suse; recommends &suse; Rancher with &rancher.k8s.engine; (RKE) version 1 or 2. - If you do not have &k8s; enterprise solution and you would - like to test Trento, an easy option could be &suse;'s K3s - project which provides a single node &k8s; cluster. Note, this - is not a recommended solution for a stable Trento production, - but a viable way to get started. + If you do not have a &k8s; enterprise solution and you would + like to test &trentopremium;, &suse; Rancher's K3s could be an easy + way to get started. Keep in mind that K3s default installation process + deploys a single node &k8s; cluster, which is not a recommended + setup for a stable Trento production instance. + @@ -215,9 +216,7 @@ As agreed on https://confluence.suse.com/x/DAEcN on our Trento doc kick off While the &t.server; supports various usage scenarios, depending on the existing infrastructure, it is designed to be - cloud native and OS agnostic. As such, the default installation - method provisions a minimal, single node, K3S &k8s; cluster for - running its components in Linux containers. The &t.server; can + cloud native and OS agnostic. It can be installed on the following services:
Updating &t.server; - To update the &t.server;, do the following: - - - Ensure the &t.server; is running. - - - - Ensure that credentials for &kube; are set up correctly. - For example, if you installed K3s, export the KUBECONFIG - environment variable for the same user that performed the - installation: - - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - - - - With the same user, start the update of the &t.server; running the following command: - - HELM_EXPERIMENTAL_OCI=1 helm upgrade \ + The procedure to update the &t.server; depends on how it was installed. + If it was installed manually, then it must be updated manually using the latest versions + of the container images available in the SUSE public registry. If it was installed using + Helm chart, it can be updated using the same Helm command as for the installation: + helm upgrade \ --install trento-server oci://registry.suse.com/trento/trento-server \ - --set trento-web.adminUser.password=ADMIN_PASSWORD \ - --set rabbitmq.auth.erlangCookie=$(openssl rand -hex 16) + --set trento-web.adminUser.password=ADMIN_PASSWORD - - Note that the experimental flag is not needed as of Helm version 3.8.0. - - - If email alerting is enabled in the environment, then the update command - should include the corresponding options: - - HELM_EXPERIMENTAL_OCI=1 helm upgrade \ + A few things to consider: + + + Remember to set the helm experimental flag if you are using a version of Helm lower than 3.8.0. + + + + When updating from a Trento version lower than 2.0.0 to version 2.0.0 or higher, an additional flag + must be set in the Helm command: + helm upgrade \ --install trento-server oci://registry.suse.com/trento/trento-server \ --set trento-web.adminUser.password=ADMIN_PASSWORD \ - --set rabbitmq.auth.erlangCookie=$(openssl rand -hex 16) \ - --set trento-web.alerting.enabled=true \ - --set trento-web.alerting.smtpServer=SMTP_SERVER \ - --set trento-web.alerting.smtpPort=SMTP_PORT \ - --set trento-web.alerting.smtpUser=SMTP_USER \ - --set trento-web.alerting.smtpPassword=SMTP_PASSWORD \ - --set trento-web.alerting.recipient=ALERTING_RECIPIENT - - - Watch the &t.server; processes until they are all in ready/running status: - watch kubectl get pods - - - Open the &t.web; URL - http://TRENTO_SERVER_HOSTNAME. - - - - To check the new version, hover the mouse pointer over - the info button in the lower-left corner. - - + --set rabbitmq.auth.erlangCookie=$(openssl rand -hex 16) + + + + If email alerting has been enabled, then the corresponding trento-web.alerting parameters + should be set in the Helm command as well. + + +
@@ -2142,7 +2128,7 @@ In the Trento dashboard, go to the overview corresponding to the object for whic - Install the package: + Install the new package: &prompt.user;sudo zypper ref &prompt.user;sudo zypper install trento-agent @@ -2173,9 +2159,9 @@ In the Trento dashboard, go to the overview corresponding to the object for whic - Restart the &t.agent;: + Start the &t.agent;: - &prompt.user;sudo systemctl restart trento-agent + &prompt.user;sudo systemctl start trento-agent Check the status of the &t.agent;: @@ -2192,7 +2178,7 @@ In the Trento dashboard, go to the overview corresponding to the object for whic [...] - Check the version on the &t.web; (URL + Check the version in the Hosts overview of the &t.web; (URL http://TRENTO_SERVER_HOSTNAME). @@ -2204,23 +2190,9 @@ In the Trento dashboard, go to the overview corresponding to the object for whic
Uninstalling &t.server; - To uninstall &t.server;, perform the following steps: - - - - Ensure that credentials for &kube; are set up correctly. - For example, if you installed K3s, set the KUBECONFIG - environment variable for the user that performed the installation: - - export KUBECONFIG=/etc/rancher/k3s/k3s.yaml - - - - With the same user, run the following command: - - helm uninstall trento-server - - + If &t.server; was deployed manually, then you need to uninstall it manually. + If &t.server; was deployed using the Helm chart, use Helm to uninstall it as follows: + helm uninstall trento-server