pnoker
80ec2beab4
Align all READMEs, AGENTS.md, CONTRIBUTING.md and dc3/doc/* with the new Makefile interface (SERVICES/GROUP selectors, REGISTRY=cn, podman default) and updated Dockerfile structure.
8.4 KiB
English | 中文 | 日本語 | Tiếng Việt
IoT DC3は、Spring Cloud上に構築された完全オープンソースの分散型IoT（モノのインターネット）プラットフォームです。
IoTソリューションの提供を加速し、デバイスのライフサイクル全体の管理を簡素化しながら、堅牢で本番運用可能なIoTシステムを支える包括的なアーキテクチャを提供します。
さらにAI-Readyであり、インテリジェントな接続、自動化、データドリブンな運用をシームレスに統合できます。
すべてのコンポーネントとコードはオープンソースであり、透明性、柔軟性、コミュニティ主導のイノベーションを保証します。
1 アーキテクチャ
このアーキテクチャは、デバイス接続、データサービス、運用管理、拡張可能なアプリケーション統合までを含む、エンドツーエンドのIoT機能を実現するために設計されています。
- ドライバー層: 標準/独自プロトコルを通じて物理デバイスへ接続するSDKを提供し、南向きのデータ収集とコマンド実行を担います。
- データ層: デバイスデータの収集・保存・参照を信頼性高く提供し、リアルタイム/履歴データサービスを支えます。
- 管理層: 分散マイクロサービス連携の中核として、サービス登録、デバイス/ドライバー管理、コマンドオーケストレーション、設定ガバナンスを担います。
- アプリケーション層: データ公開、スケジューリング、アラート通知、ログ管理、サードパーティ統合、AI拡張自動化シナリオを実現します。
2 目標
- スケーラビリティ: Spring Cloudにより水平スケールを実現し、高スループットな分散IoTワークロードに対応します。
- レジリエンス: 交換可能なサービスノードと耐障害設計により、単一障害点リスクを最小化します。
- パフォーマンス: 大規模デバイス接続とテレメトリ処理に対応します。
- 拡張性: SDKとサービス登録により、新規プロトコルやカスタムドライバー統合を高速化します。
- デプロイ柔軟性: プライベートクラウド、パブリッククラウド、エッジで動作し、Java互換性を維持します。
- 運用効率: デバイスのオンボーディング、登録、権限検証を効率化します。
- セキュリティとマルチテナンシー: 暗号化通信、名前空間分離、テナント分離をサポートします。
- クラウドネイティブ提供: Kubernetes最適化とDockerコンテナ化で一貫したデプロイを実現します。
- AI-Ready進化: インテリジェント自動化とデータドリブン運用の統合を可能にします。
3 開発
3.1 起動依存関係
いずれかを選択してください
この基本依存スタックでは PostgreSQL と RabbitMQ を起動します。データベースSQLスクリプトが必要な場合は、コンテナ内で起動したデータベースに直接接続してエクスポートしてください
# 標準Dockerレジストリサービスによるグローバルアクセス
podman compose -f dc3/docker-compose-db.yml up -d
# 中国本土のユーザー向けに最適化されたレジストリサービス
DC3_IMAGE_REGISTRY=registry.cn-beijing.aliyuncs.com/dc3 podman compose -f dc3/docker-compose-db.yml up -d
利用しやすい make ショートカット:
make dev-db
make dev-optional
make dev
make dev-all
中国本土向けのイメージレジストリを使う場合は REGISTRY=cn を指定してください:
make dev-db REGISTRY=cn
make dev-all REGISTRY=cn
make app-all REGISTRY=cn
make compose-up STACK=optional REGISTRY=cn
make compose-logs STACK=dev REGISTRY=global
Compose 環境変数の上書き
公開ポート、イメージタグ、またはオブザーバビリティ設定を変更する前に、まずテンプレートファイルをコピーしてください:
cp .env.example .env
リポジトリ直下の .env は dc3/ 配下の Compose ファイル用の変数展開に使用されます。アプリケーション実行時の環境変数は引き続き
dc3/env/dev.env または dc3/env/dev.env.sh
で管理されます。
Compose は、Compose ファイルで明示的に参照された変数のみをコンテナへ渡します。たとえばイメージレジストリ、イメージタグ、公開ポート、
ログ設定、任意の監視スタック設定です。Agentic provider は通常データベースに保存されます。フォールバックが必要な場合のみ
AGENTIC_FALLBACK_OPENAI_BASE_URL、AGENTIC_FALLBACK_OPENAI_API_KEY、AGENTIC_FALLBACK_OPENAI_MODEL を設定してください。
リポジトリ直下の .env と dc3/env/dev.env(.sh) の違いは dc3/doc/ENVIRONMENT.md を参照してください。
3.2 準備
source dc3/env/dev.env.sh
mvn -s .mvn/settings.xml clean package
モジュール概要: モジュールの依存関係マップとランタイムフロー図は
dc3/doc/MODULES.mdを参照してください。
ローカル開発ガイド: ワンストップのローカルセットアップ手順は
dc3/doc/QUICKSTART.mdを参照してください。
トラブルシューティング: よくあるビルド/ランタイムの問題と解決策は
dc3/doc/TROUBLESHOOTING.mdを参照してください。
3.3 サービスの起動
順番に起動してください
# ゲートウェイ
java -jar dc3-gateway/target/dc3-gateway.jar
# 認証センター
java -jar dc3-center/dc3-center-auth/target/dc3-center-auth.jar
# データセンター
java -jar dc3-center/dc3-center-data/target/dc3-center-data.jar
# マネージャーセンター
java -jar dc3-center/dc3-center-manager/target/dc3-center-manager.jar
# Agenticセンター
java -jar dc3-center/dc3-center-agentic/target/dc3-center-agentic.jar
# 仮想ドライバー
java -jar dc3-driver/dc3-driver-virtual/target/dc3-driver-virtual.jar
# その他のドライバー: リスニング仮想ドライバー、Modbus TCPドライバー、MQTTドライバー、OPC DAドライバー、OPC UAドライバー、Siemens S7ドライバー
4 技術スタック
5 貢献
- ブランチ作成:
mainブランチから新しいブランチを作成することから始めます。ブランチを作成する前にmainブランチが最新であることを確認してください。 - ブランチ命名: 新しいブランチには次の命名規則に従ってください:
feature/your_name/feature_description。例:feature/pnoker/mqtt_driver - コードとドキュメント: 新しいブランチでコードまたはドキュメントに変更を加えます。完了したら、変更をコミットします。
- プルリクエスト:
developブランチに変更をマージするためのPull Request（PR）を提出します。PRはメンテナによってレビューされ、マージされます。
6 ライセンス
IoT DC3オープンソースプラットフォームはAGPL 3.0 Licenseの下でライセンスされています。
リポジトリのライセンス通知と商用ライセンスの説明は LICENSE.txt を参照してください。