ドキュメント

ミドルウェア構成

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

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

1. 概要

ミドルウェア構成は、クライアント環境のさまざまなストレージおよびミドルウェアと統合し、以下のようなコンポーネントの接続情報を一元管理する MDP オペレーションプラットフォームのページです S3 オブジェクトストレージ、 Redis、メッセージキュー Kafka、リレーショナルデータベース MySQL、ドキュメントデータベース MongoDB、および全文検索 Elasticsearch。設定の変更は非同期タスクを介してクライアント環境に発行され、変更プロセス中にテストとリリースの進捗がリアルタイムで表示されます。

主な機能:

  • 各ミドルウェアの接続情報を設定(エンドポイント、アクセスキーなど) USERNAMEPASSWORD
  • 異なるベンダー間で切り替え (S3 および OSS, AWS / MinIO / Tencent Cloud COS / Huawei Cloud OBS, MySQL および DM Dameng)
  • フォームの変更された値を追跡; 編集されたフィールドのみが送信されます
  • 各構成セクションは独立してテストできます。検証が合格した後にのみ公開が許可されます
  • ワンクリック公開:すべての変更されたフィールド構成を一括で送信し、非同期で実行します

1.1 適用対象ユーザー

役割 一般操作
実装エンジニア 初期展開時にミドルウェア接続情報を入力
運用当番 資格情報の置換、エンドポイントの変更、接続テスト
緊急対応 バックアップミドルウェアに切り替え、タイムアウト構成を変更

1.2 このモジュールで推奨されない操作

ベンダーの切り替え(例: S3 → OSS)は大規模な下流データ移行を伴う変更であり、変更プロセスに従って処理する必要があります。複数環境間での接続情報の一括調整はこのモジュールでは扱われません。各環境に個別にアクセスしてページを設定する必要があります。ミドルウェアのキャパシティ計画や監視アラームはこのページに含まれません。クラスタ管理およびアラーム設定モジュールをご利用ください。


2. 各ミドルウェア構成の詳細な説明

2.1 S3 オブジェクトストレージ

操作手順: 左側メニューから『ミドルウェア構成』に入り、このセクションがデフォルト → 下にスクロールして、次の3つの構成セクションを順に確認してください: パブリック S3 インスタンス設定、コラボレーション編集 S3 インスタンス設定、およびバケット設定。

2.1.1 公開 S3 および共同編集 S3

操作手順: まず公開を入力してください S3 インスタンス設定、その後共同編集を入力してください S3 インスタンス設定を行い、最後にバケット設定を入力します。どのフィールドを変更した後でも、下部の「接続テスト」をクリックしてください。 両方のセクションのフォームフィールドは一貫しています:

フィールド 説明 必須
ストレージタイプ ドロップダウンで選択 ‘S3 (オブジェクトストレージ)’ または ‘OSS (アリババクラウド)’ はい
サブタイプ ストレージタイプに基づいて動的に読み込まれます: S3、オプションには AWS / Tencent Cloud COS / Huawei Cloud OBS / MinIO / その他;対象の場合 OSS、Alibaba Cloud のみ OSS が利用可能です はい
アクセスキーID 認証情報識別子 はい
アクセスキーシークレット 認証情報キー、入力欄 PASSWORD マスク済み はい
リージョン 例えば cn-north-1 はい
ForcePathStyle チェックボックス、パススタイルアクセスを有効にするかどうか いいえ
SSL チェックボックス、有効にするかどうか HTTPS いいえ
エンドポイント 内部サービスアクセスアドレス はい
公開アクセスアドレス ユーザー側アクセスアドレス はい
アドレス置換ルール 内部アドレスを公開アドレスにマッピングするために使用される正規表現または文字列 はい

2.1.2 バケット設定

操作手順: サーバーから返されたすべてのバケットは1つずつ順番に表示され、必要に応じて CDN ドメイン名を入力できます。

フィールド 説明
バケット名 バケットの名前
接頭辞 オブジェクトストレージパスのプレフィックス
CDN ドメイン CDN アクセラレーションドメイン
有効にする CDN 認証 チェックボックス、有効にすると「認証タイプ」と「認証キー」の2つの項目が追加されます

有効化後 CDN 認証には、対応する認証タイプと認証キーが必要です。

2.2 Redis

手順: 右側のクイックナビゲーションを使用して Redis アイコンをクリックし、このセクションにスクロール → モードを選択 → アドレスを入力し PASSWORD → 「接続テスト」をクリックします。

フィールド説明:

フィールド 説明
モード スタンドアロンまたはセンチネル
アドレス スタンドアロンモードでの接続アドレス例 redis-sentinel-master-ss:6379
マスター名 センチネルモードで必須、例 mymaster
アドレスリスト センチネルモードで複数のアドレスを動的に追加/削除可能
PASSWORD 必須

モードを切り替えると、アドレス、マスタ名、アドレスリストの項目が自動的にリセットされます。

2.3 Kafka

操作手順: 右側のクイックナビゲーションで Kafka アイコンをクリックしてこのセクションにスクロール → ブローカーのアドレスを入力 → もし SASL が有効になっている場合、 SASL のサブフィールドを展開 → 「接続テスト」をクリックします。

フィールド説明:

フィールド 説明
ブローカーのアドレス 配列、動的に追加/削除可能
トピックの接頭辞 すべてのトピックに自動的に追加される接頭辞
有効にする SASL 認証 スイッチ、有効にすると3つの SASL 設定
認証メカニズム PLAIN / SCRAM-SHA-256 / SCRAM-SHA-512(有効化後) SASL)
USERNAME / PASSWORD SASL 資格情報(有効化後 SASL)

2.4 MySQL (リレーショナルデータベース)

操作手順:右側のクイックナビゲーションで RDB アイコンをクリックし、このセクションまでスクロール → 選択 MySQL または DM Dameng → ホスト、ポートを入力 USERNAMEPASSWORD → 「接続をテスト」をクリック。

フィールド説明:

フィールド 説明
データベースタイプ MySQL または DM(Dameng)
ホストアドレス 例えば mysql-master
ポート 3306
USERNAME / PASSWORD 資格情報

右側メニューおよびページタイトルの「RDB リレーショナルデータベース」は、次に対応します MySQL 設定セクション。

2.5 MongoDB

操作手順: 右側のクイックナビゲーションで MongoDB 右のクイックナビゲーションのアイコンでこのセクションにスクロール → 接続文字列を入力 → サーバー構成に従って各データベースの資格情報を一つずつレンダリング → 「接続テスト」をクリック。

フィールドの説明:

フィールド 説明
接続文字列 例えば mongo-master:27017
各データベース USERNAME / PASSWORD サーバー設定されたデータベースごとに順番に表示されます

2.6 Elasticsearch

手順: 右側のクイックナビゲーションを使って Elasticsearch アイコンをクリックし、このセクションまでスクロール → ホストアドレスとポートを入力 → 認証が有効な場合は入力 USERNAME および PASSWORD → 『接続テスト』をクリック。

フィールドの説明:

フィールド 説明 必須
ホストアドレス 例、 elasticsearch はい
ポート 9200 はい
USERNAME ES認証情報 いいえ
PASSWORD ES認証情報 いいえ

3. 一般的な操作

3.1 資格情報の更新(例:アクセスキーのローテーション)

  1. ミドルウェアの設定に移動
  2. 公開カード内のアクセスキーIDとアクセスキーシークレットを置き換えてください S3
  3. 「接続テスト」をクリックし、緑色の「接続テスト成功」メッセージが表示されるのを待ちます
  4. 他の変更されたセクションについても接続テストを繰り返します
  5. 下部の「構成を公開」をクリック
  6. システムは非同期タスクが作成されたことを通知し、タスクログタブにリダイレクトします

3.2 ミドルウェアプロバイダーの切り替え

  1. ミドルウェアの設定に移動
  2. 該当するカードで「ストレージタイプ / サブタイプ」および新しいベンダーのエンドポイント、アクセスキー、アドレス置換ルールなどを変更します
  3. 変更後、「接続をテスト」をクリックして確認します
  4. 「構成を公開」をクリックします

ベンダーを切り替えると、下流サービスのコネクションプールがリロードされるため、ピーク業務時間は避けてください。切り替え後は、5〜10分程度アプリケーションログの監視を推奨します

3.3 有効化 Kafka SASL

  1. ミドルウェア構成に移動し、次を探します Kafka セクション
  2. 「有効にする」をオンにします SASL 認証」スイッチを切り替えると、 SASL フィールドが展開されます
  3. 認証メカニズムを入力してください、 USERNAME、および PASSWORD
  4. 「接続テスト」をクリック
  5. 合格後、「設定の公開」をクリック

3.4 操作ミスからの復元

「設定の公開」をクリックする前に、フォームの状態はブラウザのlocalStorageに保存されます。次の方法で復元できます:

  • 下部の「すべてリセット」ボタンをクリックすると、すべてのフィールドが初期のサーバー値に戻ります

3.5 非同期タスク追跡

構成を正常に公開した後、システムはタスク進行状況を表示するためにタスクログタブにジャンプします。タスクはミドルウェアのインスタンス数や変更されたフィールドの数によって長短が異なります。


4. よくある問題

Q1: 右上のクイックナビゲーションの Redis をクリックしても反応がありません。

右側のクイックナビゲーションは対応するセクションまでスクロールするだけです。そのセクションが現在のページに表示されていない場合(例:ポップアップで隠れている場合)、ページをスクロールするか、右側ナビゲーションの Redis アイコンを再度クリックして位置を調整してください。

Q2: 構成を公開した後、ステータスが更新されないようです。

公開後、ページは自動的に更新されます。ブラウザが自動で更新されない場合は、F5キーを押して最新の構成を取得してください。

Q3: 「N 件の構成が変更されました」の数が実際の件数と一致しません。

ページ数はフォームの未保存の値フィールドに基づいて計算されます。リセット後に変更を加えた場合や、配列項目を動的に追加/削除した場合など、特定の状況ではカウントの不一致が発生することがあります。『すべてリセット』をクリックして、エントリを再入力できます。

Q4: バケット設定カードで追加したいバケットが見つかりません。

このページはサーバー側の構成に基づいて既存のバケットを表示します。新しいバケットを追加するには、このページではなく基盤となるサーバー構成ファイルを変更する必要があります。必要な場合は、実装エンジニアにお問い合わせください。


付録A: 用語集

用語 説明
サーバー構成ファイル プラットフォームのデフォルト値とこのページで発行された値をマージして形成される、プラットフォーム保守の最終構成ソース
バケット ストレージバケット S3 / OSS
エンドポイント 内部クラスタアクセス用のミドルウェアサービスアドレス
公開アクセスアドレス ユーザーが確認できるミドルウェアアドレス
アドレス置換ルール 内部アドレスを公開アドレスの正規表現または文字列にマッピングする
SASL シンプル認証およびセキュリティ層、コンポーネントの認証メカニズムなど Kafka
センチネル の一つ Redisの高可用性計画
DM Dameng データベース(国内リレーショナルデータベース)
ダーティフィールド フォーム内で変更され、初期値と異なるフィールド