Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation landing page for k8s operator #1760

Merged
merged 3 commits into from
Sep 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ content/en/docs/instrumentation/python/ @open-telemetry/docs-approvers @open-te
# ruby is a content module
content/en/docs/instrumentation/rust/ @open-telemetry/docs-approvers @open-telemetry/rust-maintainers @open-telemetry/rust-approvers
content/en/docs/instrumentation/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-mainteiners @open-telemetry/swift-approvers
content/en/docs/k8s-operator @open-telemetry/operator-approvers @open-telemetry/operator-maintainers
svrnm marked this conversation as resolved.
Show resolved Hide resolved
content/en/blog/ @open-telemetry/docs-approvers @open-telemetry/blog-approvers
63 changes: 63 additions & 0 deletions content/en/docs/k8s-operator/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: OpenTelemetry Operator for Kubernetes
linkTitle: K8s Operator
weight: 11
description:
An implementation of a Kubernetes Operator, that
manages collectors and auto-instrumentation of the workload using OpenTelemetry
instrumentation libraries.
spelling: cSpell:ignore Otel
aliases: [/docs/operator]
---

## Introduction

The OpenTelemetry Operator is an implementation of a [Kubernetes Operator](https://coreos.com/operators/).

The operator manages:

- OpenTelemetry Collector
- [auto-instrumentation of the workloads using OpenTelemetry instrumentation libraries](https://github.com/open-telemetry/opentelemetry-operator#opentelemetry-auto-instrumentation-injection)

## Getting started

To install the operator in an existing cluster, make sure you have cert-manager
svrnm marked this conversation as resolved.
Show resolved Hide resolved
installed and run:

```bash
$ kubectl apply -f https://github.com/open-telemetry/opentelemetry-operator/releases/latest/download/opentelemetry-operator.yaml
```

Once the `opentelemetry-operator` deployment is ready, create an OpenTelemetry
Collector (otelcol) instance, like:

```bash
$ kubectl apply -f - <<EOF
apiVersion: opentelemetry.io/v1alpha1
kind: OpenTelemetryCollector
metadata:
name: simplest
spec:
config: |
receivers:
otlp:
protocols:
grpc:
http:
processors:

exporters:
logging:

service:
pipelines:
traces:
receivers: [otlp]
processors: []
exporters: [logging]
EOF
```

For more configuration options and for setting up the injetion of
auto-instrumentation of the workloads using OpenTelemetry instrumentation
libraries, continue reading [here](https://github.com/open-telemetry/opentelemetry-operator/blob/main/README.md).