Skip to content

Commit

Permalink
Document prow monitoring
Browse files Browse the repository at this point in the history
Add short readme for the monitoring stack and link to it from the main
prow readme.

Signed-off-by: Lennart Jern <[email protected]>
  • Loading branch information
lentzi90 committed Dec 13, 2024
1 parent f42f57e commit 1685fae
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
4 changes: 4 additions & 0 deletions prow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ avoid deleting it even if the Service is deleted. See
[cert-manager](https://cert-manager.io/) and the Let's Encrypt HTTP01 challenge,
as seen in [infra/cluster-issuer-http.yaml](infra/cluster-issuer-http.yaml).

#### Monitoring

Please see [infra/kube-prometheus](infra/kube-prometheus).

## Building node images

The Kubernetes cluster where Prow runs needs pre-built images for the Nodes. We
Expand Down
33 changes: 33 additions & 0 deletions prow/infra/kube-prometheus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Kube-prometheus for Metal3 Prow

This monitoring stack is based on
[kube-prometheus](https://github.com/prometheus-operator/kube-prometheus/tree/main).
We also took inspiration from how [k8s.io is monitoring
ProwJobs](https://github.com/kubernetes/k8s.io/pull/5355).

This is how you apply it in the cluster:

```bash
kubectl apply -f manifests/setup
kubectl apply -f manifests
kubectl apply -f prow-rules.yaml
```

The `manifests` are rendered using jsonnet based on
`metal3-kube-prometheus.jsonnet`. Use the build script to render them after
making changes:

```bash
make build
```

## How to access?

For now, we have not exposed grafana or any other component. You can access them
by using port-forward like this (after setting up access to the cluster itself):

```bash
kubectl -n monitoring port-forward svc/grafana 3000
```

Then go to <localhost:3000>.

0 comments on commit 1685fae

Please sign in to comment.