From 0b5f0bb773ade8d690dadf363c687c41468adf8a Mon Sep 17 00:00:00 2001 From: nanehambardzumyan Date: Tue, 5 Aug 2025 15:30:33 +0400 Subject: [PATCH 1/2] Add Sidecar details into the README file --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd01268..6203e29 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Todo API is a simple RESTful service for managing a to-do list, allowing users t ## Prerequisites -- [Docker](https://www.docker.com/get-started) +- [Docker](https://www.docker.com/get-started) - [Docker Compose](https://docs.docker.com/compose/) ## Quick Start @@ -73,3 +73,15 @@ python app/main.py ``` The API will read the configuration from `auth_config.yml`. If the file doesn't exist, it will default to no authentication. + +## Sidecar Usage + +The application is containerized and exposes port `8000`, making it suitable for use as a sidecar in various deployment scenarios. + +The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network. + +- **For PR testing**: `ghcr.io/codesignal/learn_todo-api:` + - Example: `ghcr.io/codesignal/learn_todo-api:pr-8` +- **For main branch**: `ghcr.io/codesignal/learn_todo-api:latest` + +The sidecar can be used in base tasks and other containerized environments where you need a todo API service. From 31c199d8add8520cfca3292bcca822abfdd1b572 Mon Sep 17 00:00:00 2001 From: nanehambardzumyan Date: Tue, 5 Aug 2025 15:33:26 +0400 Subject: [PATCH 2/2] update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6203e29..8da2250 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ The API will read the configuration from `auth_config.yml`. If the file doesn't The application is containerized and exposes port `8000`, making it suitable for use as a sidecar in various deployment scenarios. -The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network. +The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network. In order to enable it in the task, you need to add the following to the task configuration: - **For PR testing**: `ghcr.io/codesignal/learn_todo-api:` - Example: `ghcr.io/codesignal/learn_todo-api:pr-8`