ドキュメント

構成センター

約1分で読めます · このページを GitHub で編集

← ShimoDocs Suite デプロイメント文書

機能概要

構成センターは、さまざまなサービスのアプリケーション構成を表示および変更するために使用されます。このページでは、工場出荷時のテンプレート構成と現在有効な構成の両方が表示されるため、構成の違いやリリース変更を管理された方法で簡単に理解できます。

構成が公開されると、システムはこの変更を保存し、新しい構成を適用するために選択に応じて関連サービスを自動で再起動することができます。

ページへのアクセス

管理バックエンドにログインした後、 構成センター 左側のナビゲーションでこのページにアクセスします。

構成センターは管理者のみ利用可能です。このメニューが表示されない場合は、システム管理者にお問い合わせのうえ、アカウントの権限を確認してください。

ページの説明

このページは主に3つのエリアに分かれています。

  • アプリケーションおよびファイルリスト: アプリケーションごとに構成可能なファイルを表示し、アプリケーション名で検索することが可能です。
  • 工場テンプレート構成: インストールパッケージに含まれる元の構成を表示し、閲覧および参照のみが可能です。
  • 現在のアクティブ構成: 環境で現在使用されている構成を表示します。直接編集可能です。

構成ファイルは通常 JSON, YAML、または TOML 形式です。正しいファイルの構文とデータ構造を維持してください。

構成の変更と公開

以下の手順に従うことをお勧めします:

  1. 左側で、変更が必要なアプリケーションと構成ファイルを選択します。
  2. 工場テンプレートを参照して、 有効な構成 領域で構成内容を変更します。
  3. 変更後、ページには 変更済みだが公開されていない.
  4. クリック 変更済みだが公開されていないと表示されるか、 Ctrl S (Windows) / Command S (macOS) を使用して確認ウィンドウを開きます。
  5. 公開されるフィールドパス、変更タイプ、新しい値を確認します。
  6. 必要に応じて 構成公開後に関連サービスを再起動する かどうかを選択します。
  7. クリック 構成を公開 して変更を完了します。

構成内容にフォーマットエラーがある場合、システムはエラーを表示して公開を防ぎます。修正して再実行してください。

変更確認

公開前の確認ウィンドウには、この変更の差分が表示されます:

  • パス: 変更された設定のパス。
  • 操作: 追加、変更、削除などの変更種類。
  • : 変更後の設定値。

誤って設定を削除したり、サービスパラメータを誤って変更したりしないよう、各差分を確認することをお勧めします。

サービス再起動

一部の設定は、サービスの再起動後にのみ反映されます。デフォルトでは、このページで有効になっており 構成公開後に関連サービスを再起動する、公開が成功すると、アプリケーションに関連するサービスは自動的に再起動されます。

このオプションをオフにした場合でも、設定は公開されますが、関連サービスは新しい設定を適用するために手動で再起動が必要になる場合があります。

サービス再起動中、関連機能に一時的な変動が発生する可能性があります。重要な設定変更は、業務の非繁忙時間に行うことをお勧めします。

一般的な状況

  • アプリケーションが見つかりません: 検索条件をクリアするか、対象アプリケーションが正しくデプロイされていることを確認してください。
  • 設定ファイルを読み込むことができません: 再試行する前に、サービスの状態と現在のアカウント権限を確認してください。
  • 設定フォーマットエラー: インデント、括弧、引用符、およびフィールド形式を確認してください JSON, YAML、または TOML.
  • 公開する変更はありません: 実際の設定内容が効果的に変更されていないため、公開は不要です。
  • 公開後に変更が効果的ではありません: 関連サービスが再起動されているか確認してください。必要に応じて手動で再起動し、再度確認してください。
  • リリース失敗: ページ上の指示に従って設定内容またはサービス状態を確認し、対応後に再公開してください。

設定変更はサービスの起動や業務機能に影響を与える可能性があります。変更を十分に確認した上でのみ公開してください。

操作インターフェース例

下の図は、設定ファイルの選択、設定内容の表示、編集の領域を示しています。