Infrastructure Manager REST-API-Konfiguration

Dieses Thema beschreibt die Parameter, die verwendet werden, um das Infrastructure ManagerREST-API zu konfigurieren.

• info.app.name

  Der Anwendungsname.

  Beispiel: Infrastructure Manager REST-API

  Hinweis: Diese Informationen können vom /api/v2/management/info-Endpunkt abgerufen werden.

• info.app.description

  Kurzbeschreibung der Anwendung.

  Beispiel: Die Infrastructure Manager-API ist auf HTTP und JSON aufgebaut. Aus diesem Grund kann jeder Standard-HTTP-Mandant Anforderungen an es senden und die Antworten analysieren. Es ermöglicht die Bereitstellung einer vollständigen Stack-Umgebung.

  Hinweis: Diese Informationen können vom /api/v2/management/info-Endpunkt abgerufen werden.

• info.app.version

  Anwendungsversion.

  Beispiel: 1.0.0

  Hinweis: Diese Informationen können vom /api/v2/management/info-Endpunkt abgerufen werden.

• info.app.build

  Anwendungs-Build-Nummer.

  Beispiel: 1500

  Hinweis: Diese Informationen können vom /api/v2/management/info-Endpunkt abgerufen werden.

• server.port

  Port des Servers.

  Beispiel: 9000

• server.servlet.context-path

  Kontextpfad zur Anwendung.

  Beispiel: /provisioning

• server.ssl.key-store

  Speicherort der SSL-Key-Store-Datei, um TLS zu aktivieren.

  Wichtig! Löschen Sie diese Konfiguration, wenn Sie TLS nicht aktivieren möchten.

  Beispiel: C:\Program Files\InfrastructureManager\im_keystore.p12

• server.ssl.key-store-password

  Das Passwort der Key-Store-Datei.

  Beispiel: '{cipher}303d64ee49308ec9dd906491aa035de73c781a16b2ff79bdecde0e46a30d83ac'

  Hinweis: Dieser Parameter kann mit dem Tool, das sich im Ordner /tools/spring-2.0.8.RELEASE/bin befindet, verschlüsselt werden. Das verschlüsselte Passwort muss innerhalb von '{cipher} ...'gespeichert werden. Weitere Informationen finden Sie unter: Daten in der Anwendungskonfigurationsdatei verschlüsseln

• spring.datasource.driverClassName

  Der Treiberklassenname der Datenquelle.

  Beispiel: org.postgresql.Driver

• spring.datasource.username

  Benutzerkonto für den Zugriff auf die Datenbank.

  Beispiel: im-db-user

• spring.datasource.password

  Passwort des Benutzers für den Zugriff auf die Datenbank.

  Beispiel: im-db-password

  Hinweis: Dieser Parameter kann mit dem Tool, das sich im Ordner /tools/spring-2.0.8.RELEASE/bin befindet, verschlüsselt werden. Das verschlüsselte Passwort muss innerhalb von '{cipher} ...'gespeichert werden. Weitere Informationen finden Sie unter: Daten in der Anwendungskonfigurationsdatei verschlüsseln

• spring.datasource.url

  Verbindungs-String zur -Datenbank.

  Beispiel: jdbc:postgresql://localhost:5432/provisioning_rest_api

• spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation

  Postgres JPA-Fehler korrigieren.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Hinweis: Die Methode org.postgresql.jdbc.PgConnection.createClob() ist noch nicht implementiert.

  Beispiel: true

• spring.jpa.hibernate.jdbc.lob.non_contextual_creation

  Postgres JPA-Fehler korrigieren.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Hinweis: Die Methode org.postgresql.jdbc.PgConnection.createClob() ist noch nicht implementiert.

  Beispiel: true

• spring.jpa.hibernate.ddl-auto

  Eigenschaft, die vom Hibernate für die DDL-Erstellung verwendet wird.

  Wichtig!

  • Diese Konfiguration sollte nicht geändert werden.
  • Verwenden Sie in der Produktionsumgebung nicht die Optionen create/update/create-drop, da dies Änderungen in der Datenbank verwirft oder vornimmt.
  • Die validate-Option wird verwendet, um sicherzustellen, dass die Datenbank nur mit dem Produkt abgeglichen wird.

  Mögliche Werte:

  • create: Hibernate zuerst löscht vorhandene Tabellen und erstellt dann neue.
  • update: Das Objektmodell, das basierend auf den Zuordnungen (Anmerkungen oder XML) erstellt wurde, wird mit dem vorhandenen Schema verglichen. Anschließend aktualisiert Hibernate das Schema entsprechend der Unterschiede. Die vorhandenen Tabellen oder Spalten werden nie gelöscht, auch wenn sie nicht mehr von der Anwendung benötigt werden.
  • create-drop:: ähnlich wie "create", mit dem Zusatz, dass Hibernate die Datenbank auslagert, nachdem alle Vorgänge abgeschlossen sind. Wird normalerweise für Einheitentests verwendet.
  • validate: Hibernate überprüft nur, ob die Tabellen und Spalten vorhanden sind. andernfalls wird eine Ausnahme ausgelöst.
  • none: Dieser Wert deaktiviert die DDL-Erstellung.

  Beispiel: validate

• spring.jpa.hibernate.dialect

  Richtet den Hibernate Dialect für die Arbeit mit der Datenbank ein.

  Beispiel: org.hibernate.dialect.PostgreSQLDialect

• spring.jpa.show-sql

  Wenn dies konfiguriert ist, wird der SQL-Befehl in der Logdatei angezeigt, wenn die Anwendung ausgeführt wird.

  Mögliche Werte: true, false

  Beispiel: false

• spring.mvc.throw-exception-if-no-handler-found

  Wenn dies konfiguriert ist, wird ein Fehler zurückgegeben, wenn ein unbekannter Endpunkt aufgerufen wird.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Mögliche Werte: true, false

  Beispiel: true

• spring.mvc.static-path-pattern

  Wenn dies konfiguriert ist, wird das Swagger-Dokument für das REST-API aktiviert.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Beispiel: /swagger*

• spring.resources.static-locations

  Wenn dies konfiguriert ist, wird das Swagger-Dokument für das REST-API aktiviert.

  Beispiel: classpath:/swagger*

• logging.file

  Pfad zum Anwendungslog.

  Beispiel: logs/InfrastructureManager.log

• logging.level.root

  Log-Ebene.

  Beispiel: INFO

• logging.level.io.swagger.models.parameters.AbstractSerializableParameter

  Abhilfe für einen Fehler von Swagger, der die Warnmeldung auslöst, wenn kein Standardwert für den ganzzahligen API-Parameter vorhanden ist.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Beispiel: ERROR

• management.endpoints.web.base-path

  Dieser Parameter konfiguriert den URL-Pfad, um einige Standard-REST-Endpunkte zu aktivieren, um die Anwendung zu verwalten.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Beispiel: /api/v1/management

• management.endpoints.web.exposure.include

  Dieser Parameter aktiviert die Management-Endpunkte.

  Wichtig! Diese Konfiguration sollte nicht geändert werden.

  Mögliche Werte:

  • /api/v2/management/health
  • /api/v2/management/info
  • /api/v2/management/logfile

  Beispiel: health

• imPath

  Der Arbeitsordner "Infrastructure Management", in dem Ausführungslogs, Vorlagen und andere für den Betrieb erforderliche Ressourcen enthalten sind.

  Beispiel: data

• rest-api-paging-max-results

  Paging-Setup für die Abfrage von Endpunkten.

  Beispiel: 20

• template-collector.max-update-time

  Maximale Dauer (in Sekunden) für die Aktualisierung des Vorlagen-Repositories

  Beispiel: 900