这是indexloc提供的服务，不要输入任何密码
Skip to content

📝 [docs] リリース後のREADME自動更新 (v1.20.0) #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 2, 2025
Merged

📝 [docs] リリース後のREADME自動更新 (v1.20.0) #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 38 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a href="https://github.com/Sunwood-ai-labs/AMATERASU/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/Sunwood-ai-labs/AMATERASU?color=green"></a>
</p>

<h2 align="center">エンタープライズグレードのプライベートAIプラットフォーム (v1.19.0)</h2>
<h2 align="center">エンタープライズグレードのプライベートAIプラットフォーム (v1.20.0)</h2>

>[!IMPORTANT]
>このリポジトリは[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage)を活用しており、リリースノートやREADME、コミットメッセージの9割は[SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) ＋ [claude.ai](https://claude.ai/)で生成しています。
Expand All @@ -18,11 +18,9 @@

## 🚀 プロジェクト概要

AMATERASUは、エンタープライズグレードのプライベートAIプラットフォームです。AWS BedrockとGoogle Vertex AIをベースに構築されており、セキュアでスケーラブルな環境でLLMを活用したアプリケーションを開発・運用できます。GitLabとの統合により、バージョン管理、CI/CDパイプライン、プロジェクト管理を効率化します。 v1.19.0では、Terraformによるインフラ構成管理の柔軟性と保守性が大幅に向上しました。具体的には、Terraform変数の追加、出力の追加、モジュール化、既存リソースのインポートスクリプト作成などを行いました。また、WAFの設定追加、ECSの設定追加、スケジューリング機能の追加など、セキュリティと運用性の向上に重点を置いたアップデートが含まれています。さらに、Dockerイメージの最適化、UIの改良、エラーハンドリングの強化なども行っています。
AMATERASUは、エンタープライズグレードのプライベートAIプラットフォームです。AWS BedrockとGoogle Vertex AIをベースに構築されており、セキュアでスケーラブルな環境でLLMを活用したアプリケーションを開発・運用できます。GitLabとの統合により、バージョン管理、CI/CDパイプライン、プロジェクト管理を効率化します。このリポジトリは、複数のAI関連プロジェクトを管理するための「呪文書（Spellbook）」として構成されています。各プロジェクトは、特定のAIサービスや機能をデプロイ・管理するための独立したフォルダとして構造化されています。


このリポジトリは、複数のAI関連プロジェクトを管理するための「呪文書（Spellbook）」として構成されています。各プロジェクトは、特定のAIサービスや機能をデプロイ・管理するための独立したフォルダとして構造化されています。

## ✨ 主な機能

### セキュアな基盤
Expand Down Expand Up @@ -50,6 +48,7 @@ AMATERASUは、エンタープライズグレードのプライベートAIプラ
- Terraformプロジェクトの自動検出と`terraform.tfvars`ファイルの生成
- `amaterasu`コマンドラインツールによる簡素化された設定


## 🏗️ システムアーキテクチャ

```mermaid
Expand Down Expand Up @@ -156,33 +155,19 @@ graph TB
- spellbook の各プロジェクトを対象に設定値を生成
- [詳細はこちら](./spellbook/amaterasu-tool-ui/README.md)

### 11. Kotaemon (ドキュメントとチャットRAG UIツール)
- ドキュメントとチャットするためのRAG UIツール
- Docker環境とTerraform設定を提供
- データ永続化とカスタマイズ可能な環境設定
- セキュアな認証システムを実装
- [詳細はこちら](./spellbook/kotaemon/README.md)

## 🆕 最新情報

### AMATERASU v1.19.0 (最新のリリース)

- 🎉 **Terraform変数の追加**: AWSリージョン、プロジェクト名、VPC設定、EC2インスタンス設定、アプリケーション設定、WAF設定などを柔軟に設定可能になりました。
- 🎉 **Terraform出力の追加**: CloudFront, ECS, セキュリティグループに関する情報を取得可能になりました。
- 🎉 **WAF(Web Application Firewall)の設定追加**: CloudFrontを保護するWAF Web ACLを作成し、IPホワイトリストによるアクセス制限を設定しました。
- 🎉 **セキュリティグループの設定追加**: ECSタスクとALB間の通信を許可するセキュリティグループを作成しました。
- 🎉 **アプリケーションのスケジューリング設定の追加**: Auto Scaling Targetを使用して、ECSサービスのDesiredCountを調整し、平日朝8時(JST)に起動、平日夜10時(JST)に停止するスケジュールを設定しました。
- 🎉 **IAM(Identity and Access Management)の設定追加**: ECSインスタンスプロファイル、ECSタスクロール、ECS実行ロールを作成し、必要なポリシーをアタッチしました。
- 🎉 **ECS(Elastic Container Service)の設定追加**: ECSクラスタ、タスク定義、サービスを作成し、CloudWatch LogsとALBと連携するように設定しました。
- 🎉 **EC2インスタンス、AutoScalingの設定追加**: ECSタスクを実行するためのEC2インスタンスを起動する設定を追加し、Auto Scaling Groupを利用してインスタンス数を管理します。
- 🎉 **CloudFrontの設定追加**: ALBをオリジンとするCloudFront Distributionの設定を追加しました。
- 🎉 **ALB(Application Load Balancer)の設定追加**: ALB、リスナー、ターゲットグループ、セキュリティグループを作成し、ALBはHTTPトラフィックをECSサービスに転送するように構成されています。
- 🎉 **アニメーション付きヘッダー画像の追加**: アプリケーションのヘッダーとしてアニメーション付きSVG画像を追加しました。
- 🎉 **UIの改良とエラーハンドリングの強化**: Streamlitを使用して、ユーザーフレンドリーなインターフェースを作成し、エラーハンドリングを強化しました。
- 🎉 **既存AWSリソースのTerraform stateへのインポートスクリプト作成**: 既存のAWSリソースをTerraform stateにインポートするスクリプトを作成しました。
- 🎉 **AWS ECSへのデプロイスクリプト作成**: AWS ECSクラスタとサービスにDockerイメージをデプロイするスクリプトを作成しました。
- 🎉 **Dockerイメージの最適化とヘルスチェックの追加**: Python 3.11-slimイメージをベースとしてイメージサイズを削減し、ヘルスチェックコマンドを追加しました。
- 🚀 **Terraform構成のモジュール化と変数化**: 全体構成をモジュール化し、各モジュールの変数を定義しました。
- 🚀 **READMEファイルの更新**: アプリケーションの概要、機能、環境構築方法、使用方法、デバッグ情報、AWS ECS Fargateへのデプロイ手順などを詳細に記述しました。
- 🚀 **docker-compose.ymlの修正とヘルスチェックの設定**: docker-compose.ymlの設定を修正し、ポートマッピングとヘルスチェックを正しく設定しました。
- 🚀 **CoderイメージのPython, Node.jsインストールとコードサーバー設定の改善**: Python3とpip, Node.jsとnpmをインストールし、Python3をデフォルトのPythonとして設定しました。
- 🚀 **依存関係の更新と追加**: Streamlit、OpenAI、requestsライブラリを最新バージョンに更新し、dnspythonライブラリを追加しました。
- 🐛 **docker-compose.yml のポート修正**: ClickHouseのポート9000をコメントアウトしました。
- ⚠️ **ALB関連のリソースの削除**: グローバルアクセラレータとALBを用いたロードバランシング構成から、CloudFrontを利用した構成へ移行しました。
### 12. Bolt DIY (AIチャットインターフェース)
- 最新のAIチャットインターフェース
- 複数のAIプロバイダー（OpenAI、Anthropic、Google等）をサポート
- Dockerコンテナ化された環境を提供
- CloudFrontインフラストラクチャの設定
- [詳細はこちら](./spellbook/bolt-diy/README.md)


## 🔧 使用方法
Expand Down Expand Up @@ -219,4 +204,26 @@ sourcesage

## 👏 謝辞

iris-s-coonとMakiへの貢献に感謝します。
iris-s-coonとMakiへの貢献に感謝します。

## 🆕 最新情報

### AMATERASU v1.20.0 (最新のリリース)

<img src="https://raw.githubusercontent.com/Sunwood-ai-labs/AMATERASU/refs/heads/main/docs/release_notes/header_image/release_header_v1.20.0.png" width="100%">

- 新規プロジェクトの追加:
- Kotaemon: ドキュメントとチャットするためのRAG UIツール
- Bolt DIY: 最新のAIチャットインターフェース (OpenAI, Anthropic, Google等対応)
- インフラストラクチャの改善:
- `.gitignore`と`.SourceSageignore`の更新 (Kotaemonのアプリケーションデータとvenvを除外)
- Docker環境の最適化 (Watchtowerによる自動アップデート機能追加)
- LiteLLMの機能拡張 (Langfuse連携強化)
- 設定ファイルの更新: Docker Compose、環境変数テンプレート、Terraformモジュールの改善
- ドキュメントの更新: READMEファイル(英訳含む)、インストール手順、セットアップガイドの改善

- 注意事項:
- Kotaemonの初期認証情報は必ず変更してください
- APIキーは適切に管理し、公開リポジトリにコミットしないよう注意してください
- 新規追加されたプロジェクトについては、それぞれのREADMEを参照してください