Dokumentation
ShimoDocs-Dokumentation
ShimoDocs ist eine selbst gehostete Suite für Dokumentenzusammenarbeit mit Dokumenten, Textverarbeitung, Tabellen, Präsentationen, Formularen und...
55 Anleitungen zu Planung, Installation, Betrieb und Fehlerbehebung.
Überblick
- Bereitstellung und Betrieb der ShimoDocs SuiteVerwenden Sie diese Anleitungen, um eine private Bereitstellung der ShimoDocs Suite zu planen, zu installieren, zu konfigurieren, zu betreiben und Fehler zu...
Erste Schritte
- Hohe Verfügbarkeit Kubernetes BereitstellungK8s Cluster-Bereitstellung ist für Produktionsumgebungen geeignet.
- SchnellstartShimoDocs Suite erstmals installieren: Installer und Release-Paket vorbereiten, die Umgebung prüfen und die Bereitstellung anschließend verifizieren.
- RessourcenplanungDer Inhalt des Dokuments basiert auf historischer Projektressourcenplanung, Beispielkonfigurationen und Middleware-Baselines und kann für...
- Einzelknoten Kubernetes BereitstellungWenn der Server eine Firewall oder Sicherheitsgruppe aktiviert hat, öffnen Sie bitte im Voraus die oben genannten Ports.
- SystemanforderungenUnterstützte Serverressourcen, Netzwerkzugriff und Voraussetzungen für die Installation von ShimoDocs Suite in Ihrer eigenen Private-Cloud-Infrastruktur.
Middleware
Dameng
- Bereitstellen mit Dameng V8Nach Abschluss der Konfiguration überprüft der Installer die Datenbankanmeldung, die Netzwerkkonnektivität und die Berechtigungen zur Tabellenerstellung.
- Dameng V8 AnforderungenDameng Datenbank zum ersten Mal, um die Dameng DM8 Datenbankinitialisierung, MySQL Konfigurationsmodus-Kompatibilität, Dienststart und...
Kafka
- Bereitstellen mit KafkaNach der Konfiguration überprüft der Installer die KafkaNetzwerkkonnektivität und die Berechtigung zur Erstellung von Themen.
- Kafka KonfigurationDie Ports für den Zugriff auf Kafka Instanzen aus dem K8s Geschäftscluster müssen offen sein
MongoDB
- Bereitstellen mit MongoDBNach der Konfiguration überprüft der Installer MongoDB Netzwerkverbindung und Berechtigungen wie Verbindung und Authentifizierung.
- MongoDB KonfigurationDie Ports für K8s Geschäftscluster zum Zugriff MongoDB muss offen sein
MySQL 8
- Bereitstellen mit MySQL 8Nach der Konfiguration überprüft der Installer die Datenbankanmeldung, die Netzwerkverbindung und die Berechtigungen zur Tabellenerstellung.
- MySQL 8 AnforderungenUnterstützt Master-Slave-Hochverfügbarkeitsumschaltung Zeichensatz: utf8mb4 Zeitzone: Asia/Shanghai oder UTC Verbindungen: maxVerbindungen ≥ 1000...
Objektspeicher
- Bereitstellen mit ObjektspeicherNach Abschluss der Konfiguration prüft der Installer die S3 Objektspeicher-Netzwerkkonnektivität, Authentifizierungsinformationen und...
- Objektspeicher-KonfigurationOnly object storage fully compatible with the S3 protocol is supported. Huawei Cloud OBS, Alibaba Cloud OSS, Tencent Cloud COS, and AWS S3 are recommended.
Redis
- Bereitstellen mit RedisNach der Konfiguration überprüft der Installer die Redis Netzwerkverbindung, Verbindung, Authentifizierung, Befehlsausführung,...
- Redis KonfigurationEs wird typischerweise für Kernszenarien wie Sitzungsverwaltung, verteilte Sperren, Rate-Limiting-Zähler und Nachrichtenwarteschlangen verwendet.
Betriebsplattform
- Übersicht der BetriebsplattformHinweis: Die angezeigte spezifische Funktionalität hängt von der aktuellen Bereitstellungsversion und den aktivierten Funktionen ab.
Suite-Verwaltung
- KI-KonfigurationDie KI-Konfiguration wird verwendet, um eine Verbindung zu ShimoDocs Suite mit den Basismodellen, Bildmodellen, Onlinesuche und Embedding-Diensten.
- MarkenanpassungBrand-Anpassung wird verwendet, um die Markenidentität und den Schnittstellenstil von ShimoDocs Suitezu vereinheitlichen.
- LizenzverwaltungDie Lizenzverwaltung wird verwendet, um den Server-Maschinen-Code für ShimoDocs Suitezu erhalten, Lizenzen zu schreiben und zu veröffentlichen sowie den...
- MandantenverwaltungTenant Management wird für die zentrale Verwaltung von Mandanten verwendet in ShimoDocs Suite.
- Benutzerverwaltung der SuiteDie Benutzerverwaltung wird verwendet, um Benutzer in jedem Mandanten von ShimoDocs Suite anzusehen und Benutzerkonten in großen Mengen zu aktivieren oder...
Konfiguration
- Editor-KonfigurationDieses Handbuch führt in die Funktion „Editor-Konfiguration“ von ShimoDocs Suiteein und eignet sich für Systemadministratoren und Implementierer, die diese...
- SystemkonfigurationDieses Handbuch stellt die Funktion "Systemkonfiguration" von ShimoDocs Suitevor, geeignet für Systemadministratoren und Implementierer, die diese Funktion...
Geschäftssteuerung
- ZusammenarbeitsblockierungWenn ein Rückstand in Kafkaauftritt und bestätigt wird, dass der abnormale Rückstand durch eine bestimmte Datei verursacht wird, können Sie diese...
- DokumentenreparaturDie Symptome einer abnormal beschädigten Datei umfassen, dass das Dokument nicht richtig geöffnet wird, Fehlermeldungen beim Laden erscheinen und der Inhalt...
- DateiinformationssucheDateiinformationsabfrage wird verwendet, um Basisdatensätze von Dateien im System basierend auf der internen Datei GUID oder der kundenbezogenen Datei-ID...
- Transcodierung EreignissucheDie Abfragefunktion für Transkodierungsereignisse wird verwendet, um kürzlich erfolgte Transkodierungsereignisse schnell zu überprüfen in der MDP Backend,...
Systemsteuerung
- Erweiterte EinstellungenErweiterte Einstellungen werden verwendet, um die benutzerdefinierten Systemeinstellungen zu verwalten pd-config direkt durch YAML.
- BenachrichtigungskanäleBenachrichtigungskanäle werden verwendet, um zentral zu verwalten, wie Systemwarnmeldungen empfangen werden, und ermöglichen es, dass...
Middleware-Werkzeuge
- gRPC WerkzeugeDer gRPC Tool wird verwendet, um eine Verbindung zu internen gRPC Diensten herzustellen, Dienste und Methoden anzuzeigen und Unary-Methoden-Debug-Aufrufe zu...
- Kafka WerkzeugeDer Kafka Tool ermöglicht Ihnen: Kafka Cluster-Status, Themen, Nachrichten, Consumer-Gruppen und Partitionsinformationen über die Redpanda-Konsole...
- MongoDB WerkzeugeMongoDB wird in der Operations-Plattform verwendet, um MongoDB Datenbanken, Sammlungen und Dokumentinhalte anzuzeigen.
- RDB WerkzeugeRDB wird verwendet, um relationale Datenbankdaten auf der Operationsplattform anzusehen und zu überprüfen, und wird häufig genutzt, um Geschäftsdatensätze,...
- Redis WerkzeugeRedis wird in der Operations-Plattform verwendet, um Redis Instanzen, DBs, eine Liste von Schlüsseln (Keys) und Schlüssel-Details.
Dienstbetrieb
- ClusterverwaltungDas Cluster-Management-Modul ist eine Konsole in der MDP Operations-Plattform, die mit dem Kunden interagiert Kubernetes Cluster, die auf drei Szenarien...
- KonfigurationszentrumDas Konfigurationszentrum wird verwendet, um Anwendungsconfigurations verschiedener Dienste anzusehen und zu ändern.
- Middleware-KonfigurationDie Middleware-Konfiguration ist die Seite in der MDP Operations-Plattform, die sich mit verschiedenen Speicher- und Middleware-Lösungen in der...
- Echtzeit-LogsEchtzeitprotokolle werden verwendet, um die Betriebsprotokolle von Diensten in einem Kubernetes Cluster online anzuzeigen, sodass Sie Dienstanomalien,...
- Service-LogsDie Funktion Service-Logs ist eine Kibana-ähnliche Protokollabrufplattform, die Pod-Protokolle von verschiedenen ShimoDocs Diensten sammeln kann und...
- System-UpgradeDas System-Upgrade wird verwendet, um eine neue hochzuladen und anzuwenden MDP Installationspaket.
Systemverwaltung
- PrüfprotokolleDas Operationsprotokoll wird verwendet, um Benutzerverwaltungsoperationen im System zu betrachten und zu verfolgen, was bei Fehlerbehebung,...
- PlattformbenutzerverwaltungDie Systembenutzerverwaltung wird verwendet, um Benutzerkonten im MDP Verwaltungs-Backend zu pflegen, einschließlich der Erstellung von Benutzern, der...
Werkzeuge
- KompatibilitätstestNach dem Klicken auf "Inhalte-Bucket ausfüllen" kann der Bucket automatisch wechseln zu file-contents.
- Container-Paket-ErfassungDie Container-Paketaufzeichnung wird verwendet, um Netzwerkdaten von laufenden Pods in einer Kubernetes Umgebung zu sammeln und hilft Ihnen, Probleme wie...
- Allgemeine WerkzeugeDie Seite Allgemeine Werkzeuge enthält 7 häufig verwendete Funktionen: JSON Formatierung, Formatkonvertierung, JWT Decodierung, Zeitstempelkonvertierung,...
- Middleware-InspektionDie Middleware-Inspektion wird verwendet, um zu prüfen, ob systemabhängige MySQL, Redis, Elasticsearch, S3, MongoDBund Kafka verbindungen normal hergestellt...
- Überwachung statischer RessourcenDie Überwachung statischer Ressourcen wird verwendet, um die von Webseiten referenzierten JS- und CSS Ressourcen zu überprüfen, damit Sie den Zugriffsstatus...
Fehlerbehebung und Wartung
- Zusammenarbeitsbearbeitung VorfallDie Umgebung eines großen Unternehmens erlebte einen Vorfall vom Typ „Nichtverfügbarkeit bei kollaborativem Bearbeiten“, der die normale Bearbeitung und das...
- DatensicherungDatenverzeichnisse, Sicherungsverzeichnisse und Aufbewahrungsfristen der Sicherungen werden einheitlich von der Kundenseite verwaltet.
- Vorfallreaktion SOPNach Abschluss der Informationssammlung zunächst den Fehlerbereich, die Entwicklungstendenz und die Hauptursachenrichtung anhand von Symptomen, Metriken,...
- Installation FehlerbehebungHäufige Probleme während der Installationsphase fallen normalerweise in die folgenden Kategorien.
- Überwachungsmetriken ReferenzMetriknamen basieren auf den tatsächlich in Prometheus gesammelten Exporter-Metriken.