Skip to content

Commit

Permalink
Add cross references to Collector security docs (open-telemetry#5524)
Browse files Browse the repository at this point in the history
  • Loading branch information
tiffany76 authored Nov 5, 2024
1 parent c87c294 commit b34ebe2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
7 changes: 7 additions & 0 deletions content/en/docs/collector/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ It is also easier to [setup a collector](quick-start) than you might think: the
default OTLP exporters in each language assume a local collector endpoint, so if
you launch a collector it will automatically start receiving telemetry.

## Collector security

Follow best practices to make sure your collectors are [hosted] and [configured]
securely.

## Status and releases

The **Collector** status is: [mixed][], since core Collector components
Expand All @@ -70,6 +75,8 @@ for more details.
{{% docs/latest-release collector-releases /%}}

[registry]: /ecosystem/registry/?language=collector
[hosted]: /docs/security/hosting-best-practices/
[configured]: /docs/security/config-best-practices/
[mixed]: /docs/specs/otel/document-status/#mixed
[stability levels]:
https://github.com/open-telemetry/opentelemetry-collector#stability-levels
3 changes: 2 additions & 1 deletion content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ the following content:

- [Data collection concepts][dcc], to understand the repositories applicable to
the OpenTelemetry Collector.
- [Security guidance](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md)
- [Security guidance for end users](/docs/security/config-best-practices/)
- [Security guidance for component developers](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md)

## Location {#location}

Expand Down
3 changes: 3 additions & 0 deletions content/en/docs/collector/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ The OpenTelemetry Collector consists of a single binary which you can use in
different ways, for different use cases. This section describes deployment
patterns, their use cases along with pros and cons and best practices for
collector configurations for cross-environment and multi-backend deployments.
For deployment security considerations, see [Collector hosting best
practices][security].

## Resources

- KubeCon NA 2021 Talk on [OpenTelemetry Collector Deployment
Patterns][y-patterns]
- [Deployment Patterns][gh-patterns] accompanying the talk

[security]: /docs/security/hosting-best-practices/
[gh-patterns]:
https://github.com/jpkrohling/opentelemetry-collector-deployment-patterns/
[y-patterns]: https://www.youtube.com/watch?v=WhRrwSHDBFs

0 comments on commit b34ebe2

Please sign in to comment.