Created new term "Sidecar Container" #3353
Open
Conversation
This file contains 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
Signed-off-by: Fernando Harris <[email protected]>
✅ Deploy Preview for cncfglossary ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Fernando Harris <[email protected]>
fharris
requested review from
caniszczyk,
seokho-son,
iamNoah1,
jihoon-seo,
nate-double-u and
castrojo
as code owners
|
@iamNoah1 , would you please have a look ? Thanks. |
kaitoii11
reviewed
Nov 14, 2024
Signed-off-by: Fernando Harris <[email protected]>
iamNoah1
requested changes
Nov 20, 2024
content/en/sidecar-container.md
Outdated
|
|
||
| ## Problem it addresses | ||
|
|
||
| There are scenarios where it is convenient to group [containers](/container/) |
There was a problem hiding this comment.
Suggested change
| There are scenarios where it is convenient to group [containers](/container/) | |
| There are scenarios where it is convenient to group [containers](/container/) and their lifecycle |
content/en/sidecar-container.md
Outdated
| ## Problem it addresses | ||
|
|
||
| There are scenarios where it is convenient to group [containers](/container/) | ||
| to deal with cross-platform requirements or shared functionality. |
There was a problem hiding this comment.
Suggested change
| to deal with cross-platform requirements or shared functionality. | |
| to deal with scenarios |
content/en/sidecar-container.md
Outdated
|
|
||
| There are scenarios where it is convenient to group [containers](/container/) | ||
| to deal with cross-platform requirements or shared functionality. | ||
| Such scenarios include [observability](/observability/) topics |
There was a problem hiding this comment.
Suggested change
| Such scenarios include [observability](/observability/) topics |
content/en/sidecar-container.md
Outdated
| to deal with cross-platform requirements or shared functionality. | ||
| Such scenarios include [observability](/observability/) topics | ||
| like logging, monitoring, tracing, but also security, and networking. | ||
| For example, when multiple microservices have their sidecar containers |
There was a problem hiding this comment.
Here we talk already about the solution. This would be where you should show how collecting logs would look without the sidecar container.
content/en/sidecar-container.md
Outdated
|
|
||
| ## How it helps | ||
|
|
||
| The term "sidecar" comes from the representation of a classic motorcycle |
There was a problem hiding this comment.
Suggested change
| The term "sidecar" comes from the representation of a classic motorcycle |
content/en/sidecar-container.md
Outdated
| This approach consists of using a separated process | ||
| running on a secondary container to address problems | ||
| that aren't unique to a single application | ||
| but rather to the entire platform where the application is running. |
There was a problem hiding this comment.
Suggested change
| but rather to the entire platform where the application is running. |
We already kinda said that the problems are not unique to an application, but rather cross-platform relevant
content/en/sidecar-container.md
Outdated
| including storage and networking, as the main container. | ||
| While doing this, it frees the main container to be focused on functional tasks | ||
| or exposing business capabilities. | ||
| As a secondary container, the "sidecar" takes care of platform related tasks |
There was a problem hiding this comment.
Suggested change
| As a secondary container, the "sidecar" takes care of platform related tasks |
redundant
content/en/sidecar-container.md
Outdated
| While doing this, it frees the main container to be focused on functional tasks | ||
| or exposing business capabilities. | ||
| As a secondary container, the "sidecar" takes care of platform related tasks | ||
| such as logging, monitoring or security. |
There was a problem hiding this comment.
Suggested change
| such as logging, monitoring or security. |
content/en/sidecar-container.md
Outdated
| or exposing business capabilities. | ||
| As a secondary container, the "sidecar" takes care of platform related tasks | ||
| such as logging, monitoring or security. | ||
| It enforces the principle of separation of concerns |
There was a problem hiding this comment.
if you accept my suggested change some comments above this sentence could become redundant.
Signed-off-by: Fernando Harris <[email protected]>
Signed-off-by: Fernando Harris <[email protected]>
|
@iamNoah1 Thank you for the patience with me! I think I got it now. Looking forward to any comments or suggestions to improve it. Thanks once more |
|
To see where this is in the review pipeline and follow the progress, please look at the definition review board. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe your changes
Created new term "Sidecar Container"
Related issue number or link (ex:
resolves #issue-number)resolves #2958
Checklist before opening this PR (put
xin the checkboxes)git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to yourgitconfigby runninggit config --global alias.ci "commit -s".