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

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

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
Nov 30, 2024
Merged

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

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
54 changes: 25 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<p align="center">
<img src="https://raw.githubusercontent.com/Sunwood-ai-labs/AMATERASU/refs/heads/main/docs/amaterasu_main.png" width="100%">
</p>
Expand All @@ -9,15 +8,20 @@
<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プラットフォーム</h2>
<h2 align="center">エンタープライズグレードのプライベートAIプラットフォーム (v1.2.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/)で生成しています。

>[!NOTE]
>AMATERASUは[MOA](https://github.com/Sunwood-ai-labs/MOA)の後継プロジェクトです。各AIサービスを独立したEC2インスタンス上でDocker Composeを用いて実行し、Terraformで簡単にデプロイできるように進化させました。

## 🌟 主な特長
## 🚀 プロジェクト概要

AMATERASUは、エンタープライズグレードのプライベートAIプラットフォームです。AWS Bedrockをベースに構築されており、セキュアでスケーラブルな環境でLLMを活用したアプリケーションを開発・運用できます。GitLabとの統合により、バージョン管理、CI/CDパイプライン、プロジェクト管理を効率化します。


## ✨ 主な機能

### セキュアな基盤
- AWS Bedrockベースの安全なLLM基盤
Expand All @@ -34,6 +38,11 @@
- 環境ごとの設定管理
- バージョン管理された構成

### GitLab統合
- バージョン管理、CI/CDパイプライン、プロジェクト管理機能の向上
- セルフホスト型GitLabインスタンスの統合


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

```mermaid
Expand Down Expand Up @@ -67,28 +76,19 @@ graph TB
IAM["IAM<br/>認証・認可"]
end

%% EC2ベースのサービスの接続
OW --> ALB
LL --> ALB
LF --> ALB
GL --> ALB

%% Fargateベースのサービスの接続
PP --> ECS
ECS --> ALB

%% インフラストラクチャの接続
ALB --> EC2
ALB --> ECS
EC2 --> SG
ECS --> SG
R53 --> ALB
ACM --> ALB

%% コンテナイメージの流れ
ECR --> ECS

%% AWS サービスとの接続
EC2 --> Bedrock
ECS --> Bedrock
EC2 --> IAM
Expand Down Expand Up @@ -130,7 +130,7 @@ graph TB
- シンプルなDockerイメージによる容易なデプロイ
- AMATERASU環境への統合サンプル

## 🛠 デプロイメントガイド
## 🔧 デプロイメントガイド

### 前提条件
- AWS アカウント
Expand Down Expand Up @@ -198,27 +198,15 @@ cd spellbook/gitlab
cp .env.example .env
```

2. 環境変数の設定：
```env
GITLAB_HOME=/srv/gitlab
GITLAB_HOSTNAME=your.gitlab.domain
GITLAB_ROOT_PASSWORD=your_secure_password
```
2. 環境変数の設定： `.env` ファイルを編集して、`GITLAB_HOME`, `GITLAB_HOSTNAME`, `GITLAB_ROOT_PASSWORD` などの必要な環境変数を設定してください。

3. GitLabの起動：
```bash
docker-compose up -d
```

4. バックアップの設定（オプション）：
```bash
# バックアップディレクトリの作成
mkdir -p backups
chmod 777 backups
4. バックアップの設定（オプション）：バックアップディレクトリを作成し、`docker-compose exec gitlab gitlab-backup create` コマンドでバックアップを実行してください。

# バックアップの実行
docker-compose exec gitlab gitlab-backup create
```

## 📈 運用管理

Expand Down Expand Up @@ -252,7 +240,15 @@ docker-compose exec gitlab gitlab-backup create
- セキュアな開発環境の提供


## 📝 ライセンス
## 🆕 最新情報

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

- 🎉 **GitLab統合**: バージョン管理、CI/CDパイプライン、プロジェクト管理のためにセルフホスト型GitLabインスタンスを統合しました。README.mdにもGitLabのセットアップ手順を追加しました。
- 🚀 README.mdを大幅に更新し、可読性を向上させました。


## 📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細は[LICENSE](LICENSE)ファイルをご参照ください。

Expand All @@ -276,4 +272,4 @@ iris-s-coon氏とMaki氏の貢献に感謝いたします。

---

AMATERASUで、エンタープライズグレードのAIプラットフォームを構築しましょう。✨
AMATERASUで、エンタープライズグレードのAIプラットフォームを構築しましょう。✨