Created new term "Sidecar Container" #3353
Conversation
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. |
Signed-off-by: Fernando Harris <[email protected]>
|
|
||
| ## Problem it addresses | ||
|
|
||
| There are scenarios where it is convenient to group [containers](/container/) |
There was a problem hiding this comment.
| 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 |
| ## 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.
| to deal with cross-platform requirements or shared functionality. | |
| to deal with scenarios |
|
|
||
| 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.
| Such scenarios include [observability](/observability/) topics |
| 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.
|
|
||
| ## How it helps | ||
|
|
||
| The term "sidecar" comes from the representation of a classic motorcycle |
There was a problem hiding this comment.
| The term "sidecar" comes from the representation of a classic motorcycle |
| 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.
| 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
| 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.
| As a secondary container, the "sidecar" takes care of platform related tasks |
redundant
| 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.
| such as logging, monitoring or security. |
| but rather to the entire platform where the application is running. | ||
| The Sidecar Container will share the same resources, | ||
| including storage and networking, as the main container. | ||
| While doing this, it frees the main container to be focused on functional tasks |
There was a problem hiding this comment.
This sentence is a bit vague. I would rather be happy to see a more specific example. For instance something like this:
This makes it easy for a logging sidecar to collect logs from the main application without needing to change anything in the main application. The sidecar could read the same directory, the main application writes its logs to.
| 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.
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".