✨ feat(payment-service): Update documentation for new payment service

dynatrace-oss · Jul 22, 2024 · 769463c · 769463c
1 parent a86a0a3
commit 769463c
Show file tree

Hide file tree

Showing 5 changed files with 219 additions and 133 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,7 @@ Unguard is composed of eight microservices written in different languages that t
 | [like-service](./src/like-service)                         | PHP                 | default         | Serves REST API for adding likes to posts using MariaDB; vulnerable to SQL injection attacks                                                |
 | [user-auth-service](./src/user-auth-service)               | Node.js Express     | default         | Serves REST API for authenticating users with JWT tokens (vulnerable to JWT key confusion).                                                 |
 | [status-service](./src/status-service)                     | Go                  | unguard-status  | Serves REST API for Kubernetes deployments health, as well as a user and user role list (vulnerable to SQL injection)                       |
+| [payment-service](./src/payment-service)                   | Python Flask        | default         | Serves REST API for adding and retrieving credit card payment information associated with a user.                                           |
 | jaeger                                                     |                     | default         | The [Jaeger](https://www.jaegertracing.io/) stack for distributed tracing.                                                                  |
 | mariadb                                                    |                     | unguard-mariadb | Relational database that holds user and token data.                                                                                         |
 | redis                                                      |                     | default         | Key-value store that holds all user data (except authentication-related stuff).                                                             |

diff --git a/docs/TRACING.md b/docs/TRACING.md
@@ -55,7 +55,7 @@ See in the Unguard Chart [README](../chart/README.md#tracing-and-jaeger)
 1. Port-forward the Jaeger UI
 
     ```sh
-    kubectl port-forward -n unguard service/jaeger-query 16686:16686
+    kubectl port-forward -n unguard service/jaeger-query 16686:80
     ```
 
 2. Open [localhost:16686](http://localhost:16686)

diff --git a/docs/images/unguard-architecture.fig b/docs/images/unguard-architecture.fig