Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Sagi-Kazar <[email protected]>
  • Loading branch information
sagikazarmark committed Jan 9, 2024
1 parent adad6a0 commit 82f90b0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions examples/kubernetes-pod-exec-time/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

This example demonstrates metering execution time of Pods running in Kubernetes.

## Table of Contents

- [Prerequisites](#prerequisites)
- [Preparations](#preparations)
- [Deploy the example](#deploy-the-example)
- [Cleanup](#cleanup)
- [Advanced configuration](#advanced-configuration)

## Prerequisites

Any local (or remote if that's what's available for you) Kubernetes cluster will do.
Expand Down Expand Up @@ -61,3 +69,11 @@ Delete the cluster:
```shell
kind delete cluster
```

## Advanced configuration

This example uses a custom Benthos plugin called `kubernetes_resources` (included in this project) to periodically scrape the Kubernetes API for active pods.

The entire pipeline can be found in [config.yaml](config.yaml).

Check out the configuration file and the [Benthos documentation](https://www.benthos.dev/docs/about) for more details.

0 comments on commit 82f90b0

Please sign in to comment.