Add an initial security document #2461
Conversation
Capture relevant security information and considerations. Attempts to address open-telemetry/opentelemetry-collector-contrib#2232.
Codecov Report
@@ Coverage Diff @@
## main #2461 +/- ##
==========================================
+ Coverage 91.76% 91.79% +0.02%
==========================================
Files 265 265
Lines 15111 15111
==========================================
+ Hits 13867 13871 +4
+ Misses 866 863 -3
+ Partials 378 377 -1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
This looks good! My main concern is that this document might work very well for Collector developers but it might be a bit hard to read as docs for end-users: the doc sometimes reads like a spec, describing the desired behavior of the Collector but not how does one ensure that that behavior is met.
I left a couple of comments for some links that could be included to help end-users reading this meet that behavior, but I am undecided on whether they fit on this doc or not.
- Add TL;DR - Add both end-user and component developer security information - Link to examples or more information - Link open issues
|
@jpkrohling @mx-psi @ericmustin thanks for the feedback! I attempted to incorporate all of it - please take another look and let me know what you think. |
There was a problem hiding this comment.
Looks good after adressing @jpkrohling comments. Thanks for doing this!
Move contributing doc within Getting Involved link. Depends on open-telemetry#2461
Move contributing doc within Getting Involved link. Depends on open-telemetry#2461
Move contributing doc within Getting Involved link. Depends on #2461
The .submit-request job has been renamed to .submit-signing-request. The job fails when referring to the old name, so this updates the GitLab CI yaml file to use the new name.
Capture relevant security information and considerations.
Attempts to address: