Skip to content

Commit 4bc5bb1

Browse files
committed
docs: add an aws diagram
1 parent f3f54c9 commit 4bc5bb1

6 files changed

+6
-214
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ A REST API implementing each of the [30 example applications](https://platform.o
6868
- [AWS account](https://aws.amazon.com/)
6969
- [AWS Command Line Interface](https://aws.amazon.com/cli/)
7070
- [Terraform](https://www.terraform.io/).
71-
_If you're new to Terraform then see [Getting Started With AWS and Terraform](./doc/terraform-getting-started.md)_
71+
_If you're new to Terraform then see [Getting Started With AWS and Terraform](./doc/TERRAFORM_GETTING_STARTED_GUIDE.md)_
7272
- [OpenAI platform API key](https://platform.openai.com/).
73-
_If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/openai-api-key.md)_
73+
_If you're new to OpenAI API then see [How to Get an OpenAI API Key](./doc/OPENAI_API_GETTING_STARTED_GUIDE.md)_
7474
- [Python 3.11](https://www.python.org/downloads/): for creating virtual environment used for building AWS Lambda Layer, and locally by pre-commit linters and code formatters.
7575
- [NodeJS](https://nodejs.org/en/download): used with NPM for local ReactJS developer environment, and for configuring/testing Semantic Release.
7676
- [Docker Compose](https://docs.docker.com/compose/install/): used by an automated Terraform process to create the AWS Lambda Layer for OpenAI and LangChain.
File renamed without changes.

doc/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Technical Overview of this Architecture
22

3-
- **[Rekognition](https://aws.amazon.com/rekognition/)**: (FOR FUTURE USE) a cloud-based software as a service computer vision platform that was launched in 2016. It is an AWS managed Machine Learning Service with Content moderation, Face compare and search, Face Detection and analysis, Labeling, Custom labels, Text detection, Celebrity recognition, Video segment detection and Streaming Video Events detection features. It is used by a number of United States government agencies, including U.S. Immigration and Customs Enforcement and Orlando, Florida police, as well as private entities.
3+
![AWS Diagram](https://github.com/FullStackWithLawrence/aws-openai/blob/main/doc/img/aws-diagram.png "AWS Diagram")
4+
45
- **[IAM](https://aws.amazon.com/iam/)**: a web service that helps you securely control access to AWS resources. With IAM, you can centrally manage permissions that control which AWS resources users can access. You use IAM to control who is authenticated (signed in) and authorized (has permissions) to use resources.
56
- **[S3](https://aws.amazon.com/s3/)**: Amazon Simple Storage Service is a service offered by Amazon Web Services that provides object storage through a web service interface. Amazon S3 uses the same scalable storage infrastructure that Amazon.com uses to run its e-commerce network.
6-
- **[DynamoDB](https://aws.amazon.com/dynamodb/)**: a fully managed proprietary NoSQL database offered by Amazon.com as part of the Amazon Web Services portfolio. DynamoDB offers a fast persistent Key-Value Datastore with built-in support for replication, autoscaling, encryption at rest, and on-demand backup among other features.
77
- **[Lambda](https://aws.amazon.com/lambda/)**: an event-driven, serverless computing platform provided by Amazon as a part of Amazon Web Services. It is a computing service that runs code in response to events and automatically manages the computing resources required by that code. It was introduced on November 13, 2014.
88
- **[API Gateway](https://aws.amazon.com/api-gateway/)**: an AWS service for creating, publishing, maintaining, monitoring, and securing REST, HTTP, and WebSocket APIs at any scale.
99
- **[Certificate Manager](https://aws.amazon.com/certificate-manager/)**: handles the complexity of creating, storing, and renewing public and private SSL/TLS X.509 certificates and keys that protect your AWS websites and applications.
1010
- **[Route53](https://aws.amazon.com/route53/)**: a scalable and highly available Domain Name System service. Released on December 5, 2010.
1111
- **[CloudWatch](https://aws.amazon.com/cloudwatch/)**: CloudWatch enables you to monitor your complete stack (applications, infrastructure, network, and services) and use alarms, logs, and events data to take automated actions and reduce mean time to resolution (MTTR).
12+
- **[Rekognition](https://aws.amazon.com/rekognition/)**: (FOR FUTURE USE) a cloud-based software as a service computer vision platform that was launched in 2016. It is an AWS managed Machine Learning Service with Content moderation, Face compare and search, Face Detection and analysis, Labeling, Custom labels, Text detection, Celebrity recognition, Video segment detection and Streaming Video Events detection features. It is used by a number of United States government agencies, including U.S. Immigration and Customs Enforcement and Orlando, Florida police, as well as private entities.
13+
- **[DynamoDB](https://aws.amazon.com/dynamodb/)**: (FOR FUTURE USE) a fully managed proprietary NoSQL database offered by Amazon.com as part of the Amazon Web Services portfolio. DynamoDB offers a fast persistent Key-Value Datastore with built-in support for replication, autoscaling, encryption at rest, and on-demand backup among other features.
1214

1315
## Lambda Functions
1416

doc/TERRAFORM.md

-210
This file was deleted.

doc/img/aws-diagram.png

128 KB
Loading

0 commit comments

Comments
 (0)