Add Sidecar details into the README file#9
Merged
nanehambardzumyan merged 2 commits intomainfrom Aug 7, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for using the application as a sidecar container. The changes explain how to configure and use the containerized todo API service in different deployment scenarios.
- Added sidecar usage section with container configuration details
- Documented Docker image references for PR testing and main branch deployments
- Explained port exposure and network accessibility for 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. In order to enable it in the task, you need to add the following to the task configuration: |
There was a problem hiding this comment.
The documentation lacks specific instructions on how to add the Docker image to the task configuration. Consider providing an example configuration snippet or referencing the specific configuration file/section where this should be added.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added details about how to use sidecar in the base task