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

📖 [docs] 英語READMEの自動更新 #57

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
Jan 19, 2025
Merged

📖 [docs] 英語READMEの自動更新 #57

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
51 changes: 25 additions & 26 deletions docs/README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,23 @@
<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">Enterprise-Grade Private AI Platform (v1.13.0)</h2>
<h2 align="center">Enterprise-Grade Private AI Platform (v1.14.0)</h2>

>[!IMPORTANT]
>This repository leverages [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage). Approximately 90% of the release notes, README, and commit messages were generated using [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) and [claude.ai](https://claude.ai/).
>This repository leverages [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and approximately 90% of the release notes, README, and commit messages are generated using [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage) + [claude.ai](https://claude.ai/).

>[!NOTE]
>AMATERASU is the successor project to [MOA](https://github.com/Sunwood-ai-labs/MOA). It has evolved to run each AI service on an independent EC2 instance using Docker Compose, enabling easy deployment with Terraform.


## 🚀 Project Overview

AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and Google Vertex AI, it allows you to develop and operate LLM-based applications in a secure and scalable environment. Integration with GitLab streamlines version control, CI/CD pipelines, and project management. v1.13.0 includes UI/UX improvements for the Streamlit application, improvements to the Langfuse backend infrastructure, and updated documentation.
AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and Google Vertex AI, it allows you to develop and operate LLM-based applications in a secure and scalable environment. Integration with GitLab streamlines version control, CI/CD pipelines, and project management. v1.14.0 includes Terraform code to simplify the construction and management of AWS infrastructure, and a module to facilitate the creation of CloudFront infrastructure. Setup scripts and output value definitions have also been added to improve Dify setup and operation.

## ✨ Key Features

### Secure Foundation
- Secure LLM foundation based on AWS Bedrock and Google Vertex AI
- Operation in a fully closed environment
- Operation in a completely closed environment
- Enterprise-grade security

### Microservice Architecture
Expand All @@ -34,15 +33,15 @@ AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and G
- Flexible scaling

### Infrastructure as Code
- Fully automated deployment using Terraform
- Fully automated deployment with Terraform
- Environment-specific configuration management
- Version-controlled configuration

### GitLab Integration
- Enhanced version control, CI/CD pipelines, and project management features
- Enhanced version control, CI/CD pipelines, and project management
- Integration with self-hosted GitLab instances
- LLM-powered merge request analysis
- Automated labeling using GitLab webhooks
- Automated labeling using GitLab Webhooks

## 🏗️ System Architecture

Expand All @@ -56,33 +55,33 @@ graph TB
LF["Langfuse<br/>Monitoring"]
GL["GitLab<br/>Version Control"]
end

subgraph "Fargate-based Service"
PP["Prompt Pandora<br/>Prompt Generation Support"]
PP["Prompt Pandora<br/>Prompt Generation Assistance"]
ECS["ECS Fargate Cluster"]
end
end

subgraph "Infrastructure Layer"
CF["CloudFront"]
WAF["WAF"]
R53["Route 53"]
end

subgraph "AWS Services"
Bedrock["AWS Bedrock<br/>LLM Service"]
IAM["IAM<br/>Authentication & Authorization"]
end

OW --> CF
LL --> CF
LF --> CF
GL --> CF
PP --> ECS

CF --> WAF
WAF --> R53

EC2 --> Bedrock
ECS --> Bedrock
EC2 --> IAM
Expand Down Expand Up @@ -110,29 +109,29 @@ graph TB
### 4. GitLab (Version Control)
- Self-hosted GitLab instance
- Project and code management
- CI pipeline and runner configuration
- CI pipeline and Runner configuration
- Backup and restore functionality

### 5. FG-prompt-pandora (Fargate Sample Application)
- Auto-scaling on AWS Fargate
- Prompt generation using Claude-3.5-Sonnet
- Intuitive UI based on Streamlit

## 🆕 What's New
## 🆕 Latest News

### AMATERASU v1.13.0 (Latest Release)
### AMATERASU v1.14.0 (Latest Release)

- 🎉 UI style of the Streamlit app defined with CSS: A more refined design.
- 🎉 Improved setup script: Enhanced error handling.
- 🎉 Terraformization of the Langfuse backend infrastructure: More robust and manageable infrastructure.
- 🎉 Updated CloudFront infrastructure documentation: Updated to the latest information.
- 🎉 Added Streamlit progress bar display: Progress of file generation can now be monitored.
- ⚠️ Significant infrastructure changes: Back up your existing infrastructure and settings before upgrading.
- 🎉 **Setup Script Implementation:** Automates cloning the AMATERASU repository, setting environment variables, and starting the application using Docker Compose after launching an EC2 instance.
- 🎉 **Terraform Configuration for CloudFront Infrastructure Module:** Implemented a Terraform module to manage CloudFront distributions, WAFv2, Route53 records, and ACM certificates.
- 🎉 **Added Terraform Code for Main Infrastructure Construction:** Integrated IAM, Compute, and Networking modules into the main Terraform file.
- 🎉 **Defined Output Values for Built Infrastructure:** Defined output values for the built infrastructure resources.
- 🎉 **Added Variables for CloudFront Infrastructure:** Added variables required for configuring the CloudFront infrastructure.
- 🎉 **Created and Configured Common Variable File:** Defined commonly used variables in `common_variables.tf` to improve modularity and reusability of resource definitions across all infrastructure resources.


## 🛠️ Usage
## 🛠️ How to Use

Refer to the README file for each component for usage instructions. Specifically, for instructions on using the Terraform variable generator web app, see `spellbook/tfvars_generator/README.md`.
Refer to the README file for each component for usage instructions. Specifically, refer to `spellbook/tfvars_generator/README.md` for instructions on using the Terraform variable generator web application.


## 📦 Installation Instructions
Expand Down