Skip to content

Commit b34ebe2

Browse files
authored
Add cross references to Collector security docs (open-telemetry#5524)
1 parent c87c294 commit b34ebe2

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

content/en/docs/collector/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ It is also easier to [setup a collector](quick-start) than you might think: the
5252
default OTLP exporters in each language assume a local collector endpoint, so if
5353
you launch a collector it will automatically start receiving telemetry.
5454

55+
## Collector security
56+
57+
Follow best practices to make sure your collectors are [hosted] and [configured]
58+
securely.
59+
5560
## Status and releases
5661

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

7277
[registry]: /ecosystem/registry/?language=collector
78+
[hosted]: /docs/security/hosting-best-practices/
79+
[configured]: /docs/security/config-best-practices/
7380
[mixed]: /docs/specs/otel/document-status/#mixed
7481
[stability levels]:
7582
https://github.com/open-telemetry/opentelemetry-collector#stability-levels

content/en/docs/collector/configuration.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ the following content:
1414

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

1920
## Location {#location}
2021

content/en/docs/collector/deployment/_index.md

+3
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,16 @@ The OpenTelemetry Collector consists of a single binary which you can use in
88
different ways, for different use cases. This section describes deployment
99
patterns, their use cases along with pros and cons and best practices for
1010
collector configurations for cross-environment and multi-backend deployments.
11+
For deployment security considerations, see [Collector hosting best
12+
practices][security].
1113

1214
## Resources
1315

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

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

0 commit comments

Comments
 (0)