ドキュメント
ShimoDocs ドキュメント
ShimoDocs は、プライベートクラウドでドキュメント、文書作成、スプレッドシート、プレゼンテーション、フォーム、テーブルを提供し、すべての製品にプライベート設定可能な AI Agent を内蔵したセルフホスト型文書コラボレーションスイートです。
計画、インストール、運用、トラブルシューティングを扱う55件のガイド。
概要
- ShimoDocs Suite の導入・運用これらのガイドでは、ShimoDocs Suite のプライベート環境への導入について、計画、インストール、設定、運用、トラブルシューティングの手順を説明します。
はじめに
- 高可用性 Kubernetes 展開K8s クラスターデプロイメントは本番環境に適しています。単一マシンデプロイメントと比較して、クラスターデプロイメントは長期運用、スケーリング、高可用性のシナリオにより適しています。
- クイックスタートShimoDocs Suite を初めてインストールする手順です。インストーラーと配布パッケージの準備、環境チェック、完了後の動作確認までを説明します。
- リソース計画文書の内容は、過去のプロジェクトの容量計画、サンプル構成、ミドルウェアのベースラインに基づいており、プリセールス見積もり、リソース申請、実装展開、およびその後の拡張評価に使用できます。 本書は、プライベート展開シナリオにおける異なるユーザー規模のアプリケーションノードおよびミドルウェアリソースの事前計画に適用されます。
- シングルノード Kubernetes 展開サーバーにファイアウォールまたはセキュリティグループが有効な場合は、事前に上記ポートを開放してください。 以下の例では amd64 アーキテクチャを使用しています。他のアーキテクチャの場合は、実際のファイル名に置き換えてください。
- システム要件セルフホスト環境で ShimoDocs Suite を導入するために必要なサーバーリソース、ネットワーク要件、事前準備をまとめています。
ミドルウェア
Dameng
- で展開 Dameng V8インストーラーの「構成」ステップで、ネットワーク、ターゲット環境、ノード情報の構成を完了した後、ページ下部の「詳細構成」を展開します。 「ミドルウェアサービス」セクションで、 MySQL.
- Dameng V8 要件注意： <SYSDBAPASSWORD> および <SYSAUDITORPASSWORD> 文書内のはプレースホルダーです。実際の操作時には、実際のパスワードに置き換えて、複雑さの要件を満たしてください。 PASSWORD 複雑さの要件。
Kafka
MongoDB
- で展開 MongoDBインストーラーの「構成」ステップでは、ネットワーク、ターゲット環境、およびノード情報の構成完了後、ページ下部の「詳細構成」を展開します。 「ミドルウェアサービス」エリアでチェックを外します MongoDB
- MongoDB 構成ポートは K8s ビジネスクラスターにアクセスする MongoDB オープンでなければならない
MySQL 8
- で展開 MySQL 8インストーラーの「構成」ステップで、ネットワーク、ターゲット環境、ノード情報の構成を完了した後、ページ下部の「高度な構成」セクションを展開します。 「ミドルウェアサービス」エリアでチェックを外します MySQL.
- MySQL 8 要件マスター-スレーブの高可用性スイッチングをサポート 文字セット: utf8mb4 タイムゾーン: Asia/Shanghai または UTC 接続: 最大接続数 ≥ 1000 接続ユーザー: 管理者権限 別のインスタンスを設定する必要があります MySQL インスタンス;
オブジェクトストレージ
- オブジェクトストレージで展開インストーラーの「構成」ステップで、ネットワーク、ターゲット環境、ノード情報の構成を完了した後、ページ下部の「詳細構成」を展開します。 「ミドルウェアサービス」エリアでチェックを外します MinIO
- オブジェクトストレージ構成Only object storage fully compatible with the S3 protocol is supported. Huawei Cloud OBS, Alibaba Cloud OSS, Tencent Cloud COS, and AWS S3 are recommended.
運用プラットフォーム
- 運用プラットフォーム概要注意: 表示される具体的な機能は、現在の展開バージョンおよび有効化された機能によって異なります。
スイート管理
- AI構成AI 設定は接続に使用されます ShimoDocs Suite は、ベースモデル、画像モデル、オンライン検索、そして埋め込みサービスで使用できます。設定の完了後、機能は ShimoDocs Suite AIの会話、コンテンツ生成、画像処理、知識検索などは、対応するサービスにアクセスできます。
- ブランドカスタマイズブランドカスタマイズは、ブランドのアイデンティティとインターフェーススタイルを統一するために使用されます。 ShimoDocs Suiteここでは、企業ロゴ、ブラウザアイコン、タブのブランド拡張、テーマカラー、ボタンの角丸、ページの入口、システムウォーターマークを設定できます。
- ライセンス管理ライセンス管理は、サーバーのマシンコードを取得するために使用され、 ShimoDocs Suiteライセンスの書き込みと公開、および現在のライセンス状況、ライセンススコープ、稼働中マシン情報の表示に使用されます。初めてのアクティベーションの場合、...
- テナント管理テナント管理は、テナントを集中管理するために使用されます。 ShimoDocs Suite. 以下のテナントリストには、テナント名、有効化時間、テナント管理者、シート使用状況、および現在のステータスが表示されます。「操作」列では、対応するテナントの編集または無効化が可能です。
- スイートユーザー管理ユーザー管理は、各テナントのユーザーを表示し、 ShimoDocs Suite でユーザーアカウントを一括で有効化または無効化するために使用されます。 この機能を使用するには、まずユーザーが所属するテナントを選択し、次に管理するための対応するユーザーリストを入力する必要があります。
設定
業務制御
- 共同作業のブロックでバックログが発生した場合、 Kafka、特定のファイルによって異常なバックログが発生していることが確認された場合、この禁止機能を使用してそのファイルの編集を禁止することで、 Kafka バックログの問題を解決することができます。
- 文書修復ファイルが異常に破損している症状には、ドキュメントが正常に開かない、読み込み中にエラーポップアップが表示される、内容が表示されないことなどがあります。 ドキュメントが開けない場合、この機能を使用してファイルを修復します。 修復方法は2つあります。
- ファイル情報検索ファイル情報検索は、システム内のファイルの基本レコードを内部ファイル GUID または顧客側のファイル ID に基づいて検索し、ファイル識別子、関連アプリケーション、ファイルタイプ、ステータス、コンテンツサイズの確認を容易にします。 このページは読み取り専用であり、ファイルの内容やステータスを変更することはありません。
- トランスコーディングイベント検索トランスコーディングイベントクエリ機能は、最近のトランスコーディングイベントを迅速に確認するために使用されます MDP バックエンドでは、トランスコーディングプロセス中の問題を特定し、トラブルシューティングするのに役立ちます。 デフォルトでは、リストに最新のトランスコーディングイベントが表示されます。
コントロールパネル
ミドルウェアツール
- gRPC ツールgRPC ツールは内部に接続するために使用されます gRPC サービス、サービスとメソッドの表示、およびユニャリメソッドのデバッグ呼び出しの開始。
- Kafka ツールKafka ツールにより、次の内容を確認できます Kafka Redpandaコンソールを通じてクラスタの状態、トピック、メッセージ、コンシューマグループ、パーティション情報を表示でき、メッセージ書き込み、コンシューマのバックログ、非同期リンクの問題のトラブルシューティングに一般的に使用されます。
- MongoDB ツールMongoDB は、運用プラットフォームで表示するために使用されます MongoDB データベース、コレクション、およびドキュメントの内容。これは、ドキュメントベースのデータ、中間状態、タスク記録、および柔軟な構造のビジネスデータのトラブルシューティングに適しています。
- RDB ツールRDB は、オペレーションプラットフォームでリレーショナルデータベースのデータを表示およびトラブルシューティングするために使用され、ビジネス記録、構成記録、タスクの状態、操作ログ、その他の構造化データを確認するために一般的に使用されます。
- Redis ツールRedis は、運用プラットフォームで表示するために使用されます Redis インスタンス、DB、キーの一覧およびキーの詳細。キャッシュ、セッション、分散ロック、レート制限カウンター、短期状態のトラブルシューティングによく使用されます。
サービス運用
- クラスタ管理クラスタ管理モジュールは、 MDP オペレーションプラットフォーム内のコンソールで、顧客クラスタとインターフェースします。 Kubernetes...
- 構成センター構成センターは、さまざまなサービスのアプリケーション構成を表示および変更するために使用されます。このページでは、工場出荷時のテンプレート構成と現在有効な構成の両方が表示されるため、構成の違いやリリース変更を管理された方法で簡単に理解できます。
- ミドルウェア構成ミドルウェア構成は、クライアント環境のさまざまなストレージおよびミドルウェアと統合し、以下のようなコンポーネントの接続情報を一元管理する MDP オペレーションプラットフォームのページです S3 オブジェクトストレージ、 Redis、メッセージキュー Kafka、リレーショナルデータベース...
- リアルタイムログリアルタイムログは、クラスタ内のサービスの操作ログをオンラインで表示するために使用され、 Kubernetes サービスの異常、リクエストの失敗、および実行遅延を迅速に特定することができます。
- サービスログサービスログ機能は、Kibanaのようなログ取得プラットフォームであり、さまざまな ShimoDocs サービスからPodログを収集し、ログ検索、クエリ、および割合分析の機能を提供します。 左側のメニュー：システムサービス --> サービス操作 --> サービスログ
- システムアップグレードシステムアップグレードは、新しいものをアップロードして適用するために使用されます MDP...
システム管理
- 監査ログ操作ログは、システム内のユーザー管理操作を表示・追跡するために使用され、トラブルシューティング、セキュリティ監査、変更追跡に役立ちます。 このページは読み取り専用であり、ログレコードの変更や削除はサポートされていません。 管理バックエンドにログイン後、左側ナビゲーションで 操作ログ を選択してページにアクセスします。
- プラットフォームユーザー管理システムユーザー管理は、管理バックエンドでのユーザーアカウントの維持に使用されます。 MDP ユーザーの作成、基本情報の編集、リセット、 PASSWORD二要素認証の管理、ユーザーの削除を含みます。 システム管理者アカウントでログインした後、選択します システムユーザー管理 を選択してページにアクセスします。
ツールセット
- 互換性テスト「Contents バケットを埋める」をクリックすると、バケットは自動的に切り替わることがあります file-contents. シークレットキーは機密情報です。スクリーンショット、チャット、チケットで平文で表示しないでください。
- コンテナパケットキャプチャコンテナパケットキャプチャは、実行中のPodからネットワークデータを収集するために使用されます Kubernetes 環境、接続障害やリクエストのタイムアウトなどの問題を分析するのに役立ちます、 TCP 再送信およびネットワークの混雑。
- 一般ツール一般ツールページには、7つの一般的に使用される機能が含まれています： JSON フォーマット、フォーマット変換、 JWT デコード、タイムスタンプ変換、マシン時間チェック、QRコード解析、Base64エンコード/デコード。 この機能は、フォーマット、圧縮、検証に使用されます JSON コンテンツ。
- ミドルウェア検査ミドルウェア検査はシステム依存の MySQL, Redis, Elasticsearch, S3, MongoDB、および Kafka が正常に接続および読み書きできるかを確認するために使用され、基盤となるサービスの異常をタイムリーに検出するのに役立ちます。
- 静的リソース監視静的リソース監視は、ウェブページで参照されるJSおよび CSS リソースをチェックするために使用され、リソースのアクセス状況、通信プロトコル、キャッシュ構成、および CDN 使用状況を理解するのに役立ちます。 システムページ上の機能名は「静的リソース検知」です。
トラブルシューティングと保守
- 共同編集インシデント大手企業の環境において、共同編集の利用不可タイプのインシデントが発生し、一部のスプレッドシートやドキュメントにおけるユーザーの通常の編集および保存に影響が生じた。インシデント発生中、ユーザーは保存失敗、編集の遅延、 Kafka...
- データバックアップデータディレクトリ、バックアップディレクトリ、およびバックアップ保持期間はクライアント側で統一的に管理されます。
- インシデント対応 SOP情報収集を完了した後、まず症状、指標、イベント、変更履歴に基づいて障害の範囲、発展傾向、および主な原因の方向性を判断し、その上で即時封じ込めが必要かどうかを決定します。判断結果は明確な結論として示されるべきであり、単一のPodや単一のログのみに依存してはなりません。
- インストール時のトラブルシューティングインストールフェーズ中の一般的な問題は通常、以下のカテゴリに分類されます。
- 監視指標リファレンスメトリック名は、Prometheusで収集された実際のエクスポーターのメトリックに基づいています。エクスポーターのバージョンによっては若干の違いがある場合があり、実際のトラブルシューティングはオンラインクエリ結果を最終参照として行う必要があります。