Skip to content

Update

Dieses Kapitel beschreibt das Standard-Update-Verfahren des CMI STS im IIS Betrieb. Das Verfahren gilt für Minor- und Patch-Updates innerhalb derselben Major-Version, bei denen keine Breaking Changes vorliegen.

Bei Major-Updates oder Updates mit Breaking Changes sind zusätzliche Schritte erforderlich. In solchen Fällen muss die jeweilige Migrationsanleitung konsultiert werden. Der Change-Log dokumentiert alle Änderungen pro Version und weist auf Breaking Changes hin.

Voraussetzungen

  • Zugriff auf den Server, auf dem der CMI STS betrieben wird.
  • Die Systemvoraussetzungen der Zielversion sind erfüllt. Insbesondere muss die korrekte Version des Hosting Bundles installiert sein.
  • Die neuen Programmdateien (Binaries) der Zielversion liegen bereit.

Standard-Update-Anleitung

  1. Backup erstellen: Ein Backup aller Konfigurations- und Programmdaten erstellen. Sollte ein Rollback erforderlich sein, können alle Daten wiederhergestellt werden, um den ursprünglichen Zustand wiederherzustellen.
  2. Change-Log prüfen: Den Change-Log der Zielversion auf Breaking Changes prüfen. Sind Breaking Changes aufgeführt, muss die entsprechende Migrationsanleitung herangezogen werden.
  3. CMI STS stoppen: Den CMI STS stoppen (z.B. den IIS Application Pool stoppen).
  4. Programmdateien austauschen: Die bestehenden Programmdateien durch die neuen Programmdateien der Zielversion ersetzen. Dabei dürfen folgende Dateien nicht überschrieben oder gelöscht werden:
  5. appsettings.json (und weitere Konfigurationsdateien wie appsettings.Production.json)
  6. web.config
  7. Mandanten-Konfigurationsdateien (sofern vorhanden, siehe Mandanten)
  8. Schlüsselmaterial (./keys Verzeichnis bzw. cert.pfx, sofern in Verwendung, siehe Token-Signierung)
  9. CMI STS starten: Den CMI STS starten (z.B. den IIS Application Pool starten).
  10. Verifikation: Das Update gemäss dem Abschnitt Verifikation prüfen.

Hinweis: Konfigurationsänderungen sind bei einem Standard-Update in der Regel nicht erforderlich. Der Change-Log gibt Auskunft darüber, ob neue Konfigurationsoptionen hinzugefügt wurden. Bestehende Optionen bleiben kompatibel.

Hinweis: Ein Rolling-Update skalierter CMI STS Instanzen ist möglich.

Verifikation

Nach dem Update sollte die korrekte Funktion des CMI STS überprüft werden:

  1. Health-Check: Der Health-Check-Endpunkt (/health) sollte den Status Healthy zurückgeben.
  2. Discovery-Dokument: Das Discovery-Dokument unter /<Mandant>/identity/.well-known/openid-configuration sollte erreichbar sein.
  3. Login testen: Ein Login über den Web Client oder Desktop Client durchführen, um sicherzustellen, dass die Authentifizierung funktioniert.
  4. Logdateien prüfen: Die Logdateien auf Fehler oder Warnungen prüfen.

Rollback

Sollte das Update fehlschlagen, kann der ursprüngliche Zustand wiederhergestellt werden:

  1. CMI STS stoppen.
  2. Die neuen Programmdateien durch die gesicherten Programmdateien aus dem Backup ersetzen.
  3. CMI STS starten.
  4. Verifikation gemäss dem Abschnitt Verifikation durchführen.

Migrationsanleitungen

Bei Major-Updates oder Updates mit Breaking Changes sind zusätzliche Schritte erforderlich. Die folgenden Migrationsanleitungen beschreiben die notwendigen Änderungen:

Von Auf Anleitung
STS 2 3.0 Migration vom CMI STS 2 auf 3
3.0 - 3.4 3.5 Migration von CMI STS 3.0-3.4 auf CMI STS 3.5
3.X 4.0 Migration von CMI STS 3.X auf CMI STS 4.0
4.0 - 4.2 4.3 Migration von CMI STS 4.0-4.2 auf CMI STS 4.3

Der vollständige Change-Log dokumentiert alle Änderungen und Breaking Changes pro Version.