Skip to content

Commit

Permalink
docs: update install info for Grafana/Jaeger
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <[email protected]>
  • Loading branch information
StackScribe committed Oct 23, 2023
1 parent e13b9be commit 4e937d4
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 46 deletions.
68 changes: 38 additions & 30 deletions docs/content/en/docs/implementing/otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,37 +95,45 @@ you must have the following on your cluster:
for more information.
- Prometheus Operator.
See [Prometheus Operator Setup](https://github.com/prometheus-operator/kube-prometheus/blob/main/docs/customizing.md).
- The Prometheus Operator must have the required permissions
to watch resources of the `keptn-lifecycle-toolkit-system` namespace (see
[Setup for Monitoring other Namespaces](https://prometheus-operator.dev/docs/kube/monitoring-other-namespaces/)).

If you want a dashboard for reviewing metrics and traces,
you need:

- [Grafana](https://grafana.com/)
or the dashboard of your choice.
See
[Grafana Setup](https://grafana.com/docs/grafana/latest/setup-grafana/).

- [Jaeger](https://jaegertracing.io)
or a similar tool if you want traces.
See
[Jaeger Setup](https://github.com/jaegertracing/jaeger-operator#getting-started).

To install Prometheus into the `monitoring` namespace,
using the default configuration included with Keptn,
use the following commands.
Use similar commands if you define a different configuration::

> **Note**
You must clone the `lifecycle-toolkit` repository and `cd` into the correct directory
(`examples/support/observability`) before running the following commands.

```shell
kubectl create namespace monitoring
kubectl apply --server-side -f config/prometheus/setup
kubectl apply -f config/prometheus/
```
* The Prometheus Operator must have the required permissions
to watch resources of the `keptn-lifecycle-toolkit-system` namespace (see
[Setup for Monitoring other Namespaces](https://prometheus-operator.dev/docs/kube/monitoring-other-namespaces/)).

* To install Prometheus into the `monitoring` namespace
using the default configuration included with Keptn,
use the following command sequence.
Use similar commands if you define a different configuration:

> **Note**
You must clone the `lifecycle-toolkit` repository
and `cd` into the correct directory
(`examples/support/observability`) before running the following commands.

```shell
kubectl create namespace monitoring
kubectl apply --server-side -f config/prometheus/setup
kubectl apply -f config/prometheus/
```

* If you want a dashboard for reviewing metrics and traces:

- Install
[Grafana](https://grafana.com/grafana/dashboards/)
or the dashboard of your choice, following the instructions in
[Grafana Setup](https://grafana.com/docs/grafana/latest/setup-grafana/).
- Install
[Jaeger](https://grafana.com/grafana/dashboards/10001-jaeger/)
or a similar tool for traces following the instructions in
[Jaeger Setup](https://github.com/jaegertracing/jaeger-operator#getting-started).

- Follow the instructions about configuring the Grafana dashboards for Keptn
in the Grafana
[README](https://github.com/keptn/lifecycle-toolkit/blob/main/dashboards/grafana/README.md)
file.

Metrics can be retrieved without a dashboard. See
[Accessing Metrics via the Kubernetes Custom Metrics API](evaluatemetrics/#accessing-metrics-via-the-kubernetes-custom-metrics-api)

### Integrate OpenTelemetry into Keptn

Expand Down
35 changes: 19 additions & 16 deletions docs/content/en/docs/install/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,13 @@ Your cluster should include the following:
See [Supported Kubernetes versions](reqs.md/#supported-kubernetes-versions)
for details.

* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
* The
[kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
command that is used to administer Kubernetes.

* [Helm](https://helm.sh/docs/intro/install/)
* The
[Helm](https://helm.sh/docs/intro/install/)
command that is used to install and configure Keptn.

* Metric provider such as
[Prometheus](https://prometheus.io/),
Expand All @@ -84,23 +88,22 @@ Your cluster should include the following:

* If you want to use the standardized observability feature,
you must have an OpenTelemetry collector
and a Prometheus operator installed on your cluster.

If you want a dashboard for reviewing metrics and traces,
install Grafana or the dashboard of your choice.

For traces, install Jaeger or a similar tool.
as well as a Prometheus operator installed on your cluster.
For more information, see
[Requirements for Open Telemetry](../implementing/otel.md/#requirements-for-opentelemetry).

* If you want a dashboard for reviewing metrics and traces,
install the dashboard tools of your choice;
we primarily use Grafana and Jaeger.
For more information, see
[Requirements for Open Telemetry](../implementing/otel.md/#requirements-for-opentelemetry).

Also note that Keptn includes
a light-weight cert-manager that, by default, is installed
as part of the Keptn software.
If you are using another cert-manager in the cluster,
you can configure Keptn to instead use your cert-manager.
See [Use Keptn with cert-manager.io](../operate/cert-manager.md)
for detailed instructions.
* Keptn includes a lightweight `cert-manager` that, by default,
is installed as part of the Keptn software.
If you are using another certification manager in the cluster,
you can configure Keptn to instead use your cert-manager.
See [Use Keptn with cert-manager.io](../operate/cert-manager.md)
for detailed instructions.

## How many namespaces?

Expand All @@ -109,7 +112,7 @@ and how to set them up.
See the Kubernetes
[Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
documentation for some basic information.
You can also search and find lots of "Best Practices for Namespaces"
You can also search and find many "Best Practices for Namespaces"
documents published on the web.

Some considerations for Keptn:
Expand Down

0 comments on commit 4e937d4

Please sign in to comment.