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

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

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 16, 2025
Merged

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

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
35 changes: 13 additions & 22 deletions docs/README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
<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.11.0)</h2>
<h2 align="center">Enterprise-Grade Private AI Platform (v1.12.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/).

>[!NOTE]
>AMATERASU is the successor project to [MOA](https://github.com/Sunwood-ai-labs/MOA). It has been improved to run each AI service as an independent EC2 instance using Docker Compose, and deployment is simplified using Terraform.
>AMATERASU is the successor project to [MOA](https://github.com/Sunwood-ai-labs/MOA). It has evolved to run each AI service as an independent EC2 instance using Docker Compose, allowing for 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.
AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and Google Vertex AI, it allows for the development and operation of LLM-based applications in a secure and scalable environment. Integration with GitLab streamlines version control, CI/CD pipelines, and project management. v1.12.0 includes a new Terraform variable generator web application.

## ✨ Key Features

Expand All @@ -27,7 +27,7 @@ AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and
- Operation in a completely closed environment
- Enterprise-grade security

### Microservices Architecture
### Microservice Architecture
- Independent service components
- Container-based deployment
- Flexible scaling
Expand All @@ -38,7 +38,7 @@ AMATERASU is an enterprise-grade private AI platform. Built on AWS Bedrock and
- 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
Expand All @@ -57,7 +57,7 @@ graph TB
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
Expand Down Expand Up @@ -117,27 +117,18 @@ graph TB
- Prompt generation using Claude-3.5-Sonnet
- Intuitive UI based on Streamlit

## 🆕 Latest Information
## 🆕 Latest News

### AMATERASU v1.11.0 (Latest Release)
### AMATERASU v1.12.0 (Latest Release)

- 🎉 **IP Whitelist Configuration with WAFv2**: Implemented an IP whitelist feature to control access to CloudFront using AWS WAFv2. IP addresses are read from the `whitelist-waf.csv` file, and an IP set is created using the `aws_wafv2_ip_set` resource. By default, access is blocked, and only access from IP addresses registered in the whitelist is permitted. (commit: 57883b3)
- 🎉 **Creation of README.md for CloudFront Infrastructure Construction**: Added a README.md document describing the procedure for building the CloudFront infrastructure to run OpenWebUI on EC2. This comprehensively explains CloudFront, WAFv2, and Route 53 configuration methods, prerequisites, setup procedures, output values, environment removal methods, precautions, and troubleshooting. (commit: b275845)
- 🎉 **Route 53 DNS Record Configuration**: Added a setting to automatically create alias records for the CloudFront distribution in Route 53. (commit: 105d6a6)
- 🎉 **Definition of CloudFront-Related Output Values**: Defined output values to obtain important information such as the domain name, ID, ARN, and URL of the CloudFront distribution. (commit: 27df674)
- 🎉 **Automation of ACM Certificate and DNS Verification**: Implemented automatic creation of ACM certificates used for CloudFront and DNS verification using Route 53. (commit: 6ad223a)
- 🎉 **Enhanced Security Group Configuration and Explicit AMI ID**: Changed the security group ID from a single ID to a list of multiple IDs. (commit: 5897676)
- 🎉 **Added Security Group ID Output**: Added an item to output the security group ID to `outputs.tf`. (commit: 6e97f07)
- 🎉 **Added Whitelist Sample CSV**: Added a sample CSV file for WAF whitelist configuration. (commit: 49dd8b4)
- 🚀 **Provider Configuration Integration**: Integrated `provider.tf` into `main.tf` to reduce the number of files. (commit: 7f9dfd6)
- 🚀 **Added Example tfvars File**: Added a `terraform.example.tfvars` file for setting environment variables. (commit: fc59dcd)
- 🐛 **Corrected Whitelist CSV Path in WAF Configuration**: Corrected the path to the whitelist CSV file referenced in the WAF configuration. (commit: f6254c4)
- ⚠️ **Significant Infrastructure Changes**: Improvements and refactoring of already implemented features have been made. Please back up your existing infrastructure and configuration before upgrading.
- 🎉 **Added Terraform Variable Generator Web App**: A web application to assist in the automatic generation of `terraform.tfvars` files has been added. It automatically detects projects with a `main-infrastructure` directory and enables the bulk generation of common and project-specific individual settings. (commit: b9b2c59)
- 🎉 Numerous other new features and improvements (commit: 4441658, 70c69bc, 54ca945, 337eb64, 0ad4f8e, 6b8c544, b1c473d, a8360f0)
- 🚀 **UI Component Package Organization**: The `utils/ui_components` package has been reorganized to simplify module imports.


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

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


## 📦 Installation Instructions
Expand Down