Skip to content

Commit

Permalink
Update gateway readme
Browse files Browse the repository at this point in the history
Update root readme

Increate the Tratteria replices to 3
  • Loading branch information
kchiranjewee63 committed Jul 15, 2024
1 parent 62f4270 commit a580ff5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,8 @@ npm start

For more detailed instructions refer to the service-specific README files in their respective directories.

## Tratteria Documentation
For detailed documentation and setup guides of tratteria please visit tratteria official documentation page: [tratteria.io](https://tratteria.io)

## Contribute to Tratteria
Contributions to the project are welcome, including feature enhancements, bug fixes, and documentation improvements.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: tratteria
namespace: alpha-stocks-dev # Replace [your-namespace] with your Kubernetes namespace
spec:
replicas: 1
replicas: 3
selector:
matchLabels:
app: tratteria
Expand Down
6 changes: 4 additions & 2 deletions gateway/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Gateway Service

The Gateway Service acts as the entry point to the TraTs-Demo-Svcs platform, performing the role of a reverse proxy that routes incoming requests to the appropriate backend services, such as the Orders and Stocks services.
The Gateway Service acts as the entry point to Alpha Stocks, performing the role of a reverse proxy that routes incoming requests to the appropriate backend services, such as the Orders and Stocks services.

## Features

- **Request Routing**: Directs incoming requests to the correct service based on the request path and method.

- **Security and User Authentication**: Integrates with the Auth service to perform tasks such as user authentication and token generation.
- **User Authentication**: Integrates with the Auth service to perform tasks such as user authentication.

- **TraT Generation**: Requests TraT tokens from the Tratteria service for incoming external requests and propagates the generated TraTs through the `Txn-Token` request header.

This service is containerized and intended to be run as part of the overall project using Docker Compose. Refer to the main project README for instructions on how to run the entire suite of services.

0 comments on commit a580ff5

Please sign in to comment.