Skip to content

Commit 16865fa

Browse files
committed
added information on how to perform a downgrade
1 parent f7d8d56 commit 16865fa

File tree

3 files changed

+53
-34
lines changed

3 files changed

+53
-34
lines changed

images/update_downgrade_ce_se.png

36.2 KB
Loading

src/common/de/update.asciidoc

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Das Update von {CMK} auf eine neue Version läuft etwas anders als bei anderer S
1919
Warum?
2020

2121
Grund ist, dass {CMK} nicht nur mehrere unabhängige *Instanzen* (_sites_) auf einem Server erlaubt,
22-
sondern auch mehrere gleichzeitig installierte xref:cmk_versions#[Software-Versionen.]
22+
sondern auch mehrere gleichzeitig installierte xref:cmk_versions#[Software-Versionen.]
2323
Dabei ist jede Instanz einer installierten Version zugeordnet.
2424
Nehmen Sie als Beispiel folgende Situation auf einem fiktiven Server:
2525

@@ -87,17 +87,17 @@ Daher raten wir von diesem Vorgehen dringend ab – und können auch bei einem U
8787
[#incompatible_mkps]
8888
=== Inkompatible und obsolete MKPs
8989

90-
Über die xref:glossar#mkp[{CMK}-Erweiterungspakete (MKPs)] lässt sich Ihr Monitoring-System recht einfach und bequem erweitern.
91-
Auf der einen Seite kommt es dabei vor, dass solche MKPs nicht weiter gepflegt werden und dann ggf. mit neuen Versionen von {CMK} nicht mehr kompatibel sind.
92-
Auf der anderen Seite nehmen wir immer wieder neue Plugins und Funktionserweiterungen in {CMK} auf, weshalb MKPs mitunter obsolet werden.
90+
Über die xref:glossar#mkp[{CMK}-Erweiterungspakete (MKPs)] lässt sich Ihr Monitoring-System recht einfach und bequem erweitern.
91+
Auf der einen Seite kommt es dabei vor, dass solche MKPs nicht weiter gepflegt werden und dann ggf. mit neuen Versionen von {CMK} nicht mehr kompatibel sind.
92+
Auf der anderen Seite nehmen wir immer wieder neue Plugins und Funktionserweiterungen in {CMK} auf, weshalb MKPs mitunter obsolet werden.
9393
Ihre Funktionalität wird schlicht von {CMK} selbst sichergestellt.
9494

95-
Falls Sie MKPs installiert haben, ist aus diesem Grund eine Prüfung dieser MKPs dringend geboten.
95+
Falls Sie MKPs installiert haben, ist aus diesem Grund eine Prüfung dieser MKPs dringend geboten.
9696
So verhindern Sie, dass inkompatible Pakete das Update behindern oder im Anschluss an das Update doppelte oder zumindest sehr ähnliche Services entstehen.
9797

98-
Prüfen Sie hierzu Ihre installierten MKPs gegen unseren link:https://checkmk.com/de/integrations[Katalog der Check-Plugins^] und entfernen Sie Pakete, welche inzwischen nativ von {CMK} bereitgestellt werden.
99-
Bei dieser Gelegenheit können Sie auch MKPs entfernen, die eventuell nur mal für einen Probelauf installiert worden sind.
100-
Eine Auflistung finden Sie im [.guihint]#Setup#-Menü unter [.guihint]#Maintenance > Extension packages#.
98+
Prüfen Sie hierzu Ihre installierten MKPs gegen unseren link:https://checkmk.com/de/integrations[Katalog der Check-Plugins^] und entfernen Sie Pakete, welche inzwischen nativ von {CMK} bereitgestellt werden.
99+
Bei dieser Gelegenheit können Sie auch MKPs entfernen, die eventuell nur mal für einen Probelauf installiert worden sind.
100+
Eine Auflistung finden Sie im [.guihint]#Setup#-Menü unter [.guihint]#Maintenance > Extension packages#.
101101
Auf der Kommandozeile können Sie sich installierte Erweiterungen mit dem Befehl `mkp list` anzeigen lassen.
102102
Überprüfen Sie die Ausgabe dieses Befehls auf Erweiterungen, die nicht mehr benötigt werden oder die Sie gar nicht mehr zuordnen können.
103103

@@ -107,16 +107,16 @@ Details erklärt der xref:mkps#[Artikel zur Verwendung von MKPs].
107107

108108
*Achtung:*
109109
Wenn Sie an Dateien, die ursprünglich MKPs entstammen, lokal Änderungen vorgenommen haben, packen Sie das MKP nach Erhöhung der Versionsnummer neu.
110-
Während des Updates werden sonst geänderte Dateien durch die im MKP enthaltenen überschrieben.
110+
Während des Updates werden sonst geänderte Dateien durch die im MKP enthaltenen überschrieben.
111111

112112
// MFS: Sollte hier nicht besser der Verweis auf mkp find und die Empfehlung, vor dem Update MKPs zu erstellen, hin?
113113
//SP: Nein, das wird ja im folgenden Abschnitt aufgeführt.
114114

115115
[#local_files]
116116
=== Lokale Dateien
117117

118-
Mit lokalen Dateien können Sie die von {CMK} bereitgestellte Funktionalität anpassen und erweitern.
119-
Diese Dateien befinden sich im lokalen Teil der Instanzverzeichnisstruktur, d. h. in `~/local`.
118+
Mit lokalen Dateien können Sie die von {CMK} bereitgestellte Funktionalität anpassen und erweitern.
119+
Diese Dateien befinden sich im lokalen Teil der Instanzverzeichnisstruktur, d. h. in `~/local`.
120120
Lokale Dateien können bei einem Update Probleme bereiten, da sie eventuell nicht mehr zur neuen {CMK}-Version passen.
121121

122122
Da es für {CMK} bei einem Update nicht möglich ist, die lokalen Anpassungen und jede von einem Drittanbieter hergestellte Erweiterung abzufangen und zu behandeln, sollten Sie Ihre {CMK}-Instanz vor einem Update daraufhin überprüfen, ob lokale Dateien bei Ihnen verwendet werden und gegebenenfalls welche.
@@ -135,11 +135,11 @@ Im Idealfall sind lokale Dateien bereits vollständig in xref:#incompatible_mkps
135135
Verwenden Sie `mkp find` um unpaketierte Dateien zu identifizieren.
136136
Die weitere Vorgehensweise der Erstellung von Paketen zeigt unser xref:mkps#developers[Artikel zu {CMK}-Erweiterungspaketen.]
137137
Einmal zu einem Paket zusammengefasst, kann eine Erweiterung als ganzes deaktiviert oder erneut aktiviert werden.
138-
138+
139139
[#backup]
140140
=== Backup und Probelauf
141141

142-
Die Selbstverständlichkeit, ein Backup unmittelbar vor dem Update zu erstellen, um im Falle eines Fehlschlags nicht allzu viel Ihrer Monitoring-Historie zu verlieren, müssen wir Ihnen nicht erklären.
142+
Die Selbstverständlichkeit, ein Backup unmittelbar vor dem Update zu erstellen, um im Falle eines Fehlschlags nicht allzu viel Ihrer Monitoring-Historie zu verlieren, müssen wir Ihnen nicht erklären.
143143
An dieser Stelle relevant ist, dass ein reguläres Backup auch gute Dienste für den Probelauf eines Updates leisten kann.
144144
So können Sie das Backup unter einem anderen Namen wiederherstellen – und anschließend mit der Instanz `newsite` das Update testen:
145145

@@ -497,7 +497,7 @@ omd -f -V $VERSION update --conflict=install $SITE && omd start $SITE
497497

498498
Es gibt zwei unterschiedliche Vorgehensweisen, um das Update aller in einem xref:distributed_monitoring#[verteilten Monitoring] beteiligten Instanzen – d.h. der Zentralinstanz und der Remote-Instanzen – durchzuführen.
499499

500-
*Wichtig:*
500+
*Wichtig:*
501501
Für welches Vorgehen Sie sich auch entscheiden:
502502
Sie sollten auch in diesem Szenario vorher xref:backup#[Backups] aller Instanzen anlegen.
503503

@@ -511,7 +511,7 @@ Ist dies nicht möglich – beispielsweise, weil die Umgebung auf Instanzen in v
511511
Der Versionsunterschied darf bei Major-Updates exakt eine Version betragen und setzt immer ein bestimmtes Patchlevel der Ausgangsversion voraus.
512512

513513
Diese Reihenfolge muss dafür unbedingt eingehalten werden: Zunächst nehmen Sie die Aktualisierung aller Remote-Instanzen vor, erst als letztes führen Sie das Update der Zentralinstanz durch.
514-
So ist sichergestellt, dass zu keinem Zeitpunkt eine von einer neueren {CMK}-Version erzeugte Konfiguration bei einer älteren {CMK}-Version landet.
514+
So ist sichergestellt, dass zu keinem Zeitpunkt eine von einer neueren {CMK}-Version erzeugte Konfiguration bei einer älteren {CMK}-Version landet.
515515

516516
Die folgende Tabelle zeigt die möglichen Kombinationen beim Update von {v21} zur {v22}:
517517

@@ -719,17 +719,26 @@ Daraus resultiert folgende Reihenfolge für das Upgrade:
719719
. Hinterlegen Sie in der Zentralinstanz noch unter der {SE} die Subskriptionsdaten für die {CE}
720720
. Führen Sie als letztes das Upgrade der Zentralinstanz auf {CE} durch.
721721

722-
Soll ein Upgrade direkt von der {RE} auf {CE} erfolgen, müssen Sie auf der Zentralinstanz als Zwischenschritt auf die {SE} hieven: Zuerst führen Sie das Upgrade der
723-
Zentralinstanz von {RE} nach {SE} durch, es folgt das Upgrade der Remote-Instanzen direkt von {RE} nach {CE}. Zuletzt führen Sie noch das Upgrader der Zentralinstanz von {SE} nach {CE} durch.
722+
Soll ein Upgrade direkt von der {RE} auf {CE} erfolgen, müssen Sie auf der Zentralinstanz als Zwischenschritt auf die {SE} hieven: Zuerst führen Sie das Upgrade der
723+
Zentralinstanz von {RE} nach {SE} durch, es folgt das Upgrade der Remote-Instanzen direkt von {RE} nach {CE}. Zuletzt führen Sie noch das Upgrade der Zentralinstanz von {SE} nach {CE} durch.
724724

725725
[#down2cee]
726-
== Downgrades
726+
== Downgrades
727727

728728
=== Einleitung
729729

730730
Auch Downgrades zwischen den Editionen sind vorgesehen.
731-
Ein Downgrade ist eine komplexere und damit zeitaufwändigere Aktion, da einige Funktionen in der Zielversion möglicherweise nicht funktionieren
732-
und manuell deaktiviert und durch eine möglicherweise weniger effiziente oder weniger komfortable Alternative ersetzt werden müssen.
731+
Ein Downgrade ist eine komplexere und damit zeitaufwändigere Aktion, da einige Funktionen in der Zielversion möglicherweise nicht funktionieren und manuell deaktiviert und durch eine möglicherweise weniger effiziente oder weniger komfortable Alternative ersetzt werden müssen.
732+
733+
Das eigentliche Downgrade *muss* - genau wie beim Update oder Upgrade - mit dem Befehl `omd update` durchgeführt werden.
734+
Die Details dazu finden Sie im im Abschnitt xref:update#execute[Durchführen des Updates.]
735+
736+
Wenn Sie nun beispielsweise von der {CE} auf die {SE} downgraden wollen, überzeugt sich {CMK}, ob das tatsächlich Ihre Intention ist:
737+
738+
image::update_downgrade_ce_se.png[width=30%]
739+
740+
Sobald Sie diese Abfrage mit [.guihint]#yes# bestätigen, geht das Downgrade unmittelbar los.
741+
Informieren Sie sich im Folgenden unbedingt, was *vor* diesem Downgrade zu erledigen ist.
733742

734743

735744
[#cce2cee]

src/common/en/update.asciidoc

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ xref:cmc_migration#[Migration to the CMC]
1818
Updating {CMK} is a bit different than most other software packages that you may be familiar with.
1919
Why is that?
2020

21-
The reason is that {CMK} not only allows multiple independent *sites* to run on a single server,
21+
The reason is that {CMK} not only allows multiple independent *sites* to run on a single server,
2222
but it also allows multiple xref:cmk_versions#[software versions] to be installed simultaneously.
2323
With this system each site is assigned to an installed version of the software.
2424
To illustrate, we can take the following situation on a fictional server:
@@ -73,17 +73,17 @@ We therefore strongly advise against such a procedure -- and will also no longer
7373
[#incompatible_mkps]
7474
=== Incompatible and obsolete MKPs
7575

76-
Your monitoring system can be extended quite easily and conveniently using the xref:glossar#mkp[{CMK} extension packages (MKPs)].
77-
On the one hand, it is possible that some older MKPs are no longer being maintained and thus may no longer be compatible with newer versions of {CMK}.
78-
On the other hand, we keep adding new plug-ins and functional extensions to {CMK}, which is why MKPs sometimes become obsolete.
76+
Your monitoring system can be extended quite easily and conveniently using the xref:glossar#mkp[{CMK} extension packages (MKPs)].
77+
On the one hand, it is possible that some older MKPs are no longer being maintained and thus may no longer be compatible with newer versions of {CMK}.
78+
On the other hand, we keep adding new plug-ins and functional extensions to {CMK}, which is why MKPs sometimes become obsolete.
7979
The functionality of those plug-ins and extensions is simply provided by {CMK} itself as standard.
8080

81-
If you have any MKPs installed, a check of these MKPs is strongly recommended for this reason.
81+
If you have any MKPs installed, a check of these MKPs is strongly recommended for this reason.
8282
This will prevent incompatible packages from interfering with the update, or resulting in duplicate or at least very similar services following the update.
8383

84-
To do this, check your installed MKPs against our link:https://checkmk.com/integrations[Catalog of Check Plug-ins^] and remove any packages containing functions that are now provided natively by {CMK}.
85-
You can also use this opportunity to remove MKPs that may have only been installed for a test run.
86-
A list can be found in the [.guihint]#Setup# menu under [.guihint]#Maintenance > Extension packages#.
84+
To do this, check your installed MKPs against our link:https://checkmk.com/integrations[Catalog of Check Plug-ins^] and remove any packages containing functions that are now provided natively by {CMK}.
85+
You can also use this opportunity to remove MKPs that may have only been installed for a test run.
86+
A list can be found in the [.guihint]#Setup# menu under [.guihint]#Maintenance > Extension packages#.
8787
On the command line, you can display the installed extensions with the `mkp list` command.
8888
Check the output of this command for extensions that are no longer needed or that you cannot even identify.
8989

@@ -99,8 +99,8 @@ During the update, otherwise modified files will be overwritten by those contain
9999
[#local_files]
100100
=== Local files
101101

102-
Local files allow you to customize and extend the functionality provided by {CMK}.
103-
These files are located in the local part of the site directory structure, i.e. in `~/local`.
102+
Local files allow you to customize and extend the functionality provided by {CMK}.
103+
These files are located in the local part of the site directory structure, i.e. in `~/local`.
104104
Local files can cause problems when updating, as they may no longer match the new {CMK} version.
105105

106106
Since it is not possible for {CMK} to intercept and handle local customizations and any third-party extension during an update, you should check your {CMK} site before an update to see if and which local files you are using.
@@ -124,7 +124,7 @@ Once packaged, each extension can be deactivated or reactivated as a complete el
124124
[#backup]
125125
=== Backup and test run
126126

127-
We don't need to remind you of the importance of creating a backup immediately before any update, so that you don't risk losing too much of your monitoring history in the event of a failure.
127+
We don't need to remind you of the importance of creating a backup immediately before any update, so that you don't risk losing too much of your monitoring history in the event of a failure.
128128
What is relevant at this point is that a regular backup can also serve you well for test runs of a pending update.
129129
This practice enables you to restore the backup under an alternative name -- and then use the `newsite` site to test the update before it goes live:
130130

@@ -477,7 +477,7 @@ omd -f -V $VERSION update --conflict=install $SITE && omd start $SITE
477477

478478
There are two different procedures for performing the update of all sites included in a xref:distributed_monitoring#[distributed monitoring] -- i.e. the central site and any remote sites controlled by it.
479479

480-
*Important:*
480+
*Important:*
481481
Whichever approach you choose, as the very first step you should create xref:backup#[backups] of all sites in the environment.
482482

483483
The preferred, safest procedure is to _update in one go_, in which you perform the following steps:
@@ -697,14 +697,24 @@ If you want to upgrade directly from {RE} to {CE}, you must upgrade the central
697697

698698

699699
[#down2cee]
700-
== Downgrades
700+
== Downgrades
701701

702702
=== Introduction
703703

704704
Downgrades between editions are also possible.
705705
A downgrade is a more complex and thus time-consuming action, since some features may not work in the target edition,
706706
and will need to be manually deactivated and replaced by a possibly less efficient or less convenient alternative.
707707

708+
The actual downgrade *must* be carried out with the command `omd update` - just like an update or upgrade.
709+
The details can be found in the section xref:update#execute[Performing the update].
710+
711+
If you try to downgrade from {CE} to {SE}, for example, {CMK} will verify whether this is actually your intention:
712+
713+
image::update_downgrade_ce_se.png[width=30%]
714+
715+
As soon as you confirm this dialog with [.guihint]#yes#, the downgrade starts immediately.
716+
Please find out below what you need to do *before* this downgrade.
717+
708718

709719
[#cce2cee]
710720
=== Downgrading from the {CE} to the {SE}
@@ -834,7 +844,7 @@ As always, paths that do not begin with `/` apply after the site's home director
834844

835845
[cols="25,~"]
836846
|===
837-
|File path |Function
847+
|File path |Function
838848

839849
|`~/version` |Symbolic link to the installation of the {CMK} version used by this site.
840850
|`/omd/versions` |In this directory a subdirectory exists for every installed {CMK} version. The files belonging to `root` and are never changed.

0 commit comments

Comments
 (0)