Skip to content

Commit

Permalink
Format markdown (kubernetes#1163)
Browse files Browse the repository at this point in the history
Produced via:
  `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
/assign @adrcunha
  • Loading branch information
mattmoor-sockpuppet authored and knative-prow-robot committed Jul 19, 2019
1 parent cad8ba5 commit 999724a
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 17 deletions.
15 changes: 9 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,22 @@

This directory doesn't host documentation for the knative/test-infra repository.

Instead, this is the source of the GitHub Pages for knative/test-infra. See https://pages.github.com/ for details.
Instead, this is the source of the GitHub Pages for knative/test-infra. See
https://pages.github.com/ for details.

Documentation can be found in the several directories of the repository. For example:
Documentation can be found in the several directories of the repository. For
example:

* [Main README](../README.md)
* [Documentation on the CI/CD system](../ci/README.md)
* [Documentation on the helper scripts](../scripts/README.md)
- [Main README](../README.md)
- [Documentation on the CI/CD system](../ci/README.md)
- [Documentation on the helper scripts](../scripts/README.md)

## Updating the test-infra GitHub page

Main contents are rendered from [index.html](index.html).

In order to allow [index.html](index.html) to read data from the oncall GCS bucket, proper permissions must be granted:
In order to allow [index.html](index.html) to read data from the oncall GCS
bucket, proper permissions must be granted:

```shell
$ gsutil cors set cors-json-file.json gs://knative-infra-oncall
Expand Down
31 changes: 20 additions & 11 deletions tools/monitoring/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Knative Monitoring

Knative monitoring is a service that listens to prow job pubsub messages. It scrapes through all the failure logs to catch test infrastructure failures.
Knative monitoring is a service that listens to prow job pubsub messages. It
scrapes through all the failure logs to catch test infrastructure failures.

## System Diagram

Expand All @@ -21,24 +22,32 @@ required that the cluster is in the same zone as the CloudSQL instance.

### Update the Kubernetes components

[monitoring_service.yaml](https://github.com/knative/test-infra/blob/master/tools/monitoring/gke_deployment/monitoring_service.yaml) is the config to set up all the Kubernetes resources. Use `kubectl apply` on the monitoring_service file to make any updates.
[monitoring_service.yaml](https://github.com/knative/test-infra/blob/master/tools/monitoring/gke_deployment/monitoring_service.yaml)
is the config to set up all the Kubernetes resources. Use `kubectl apply` on the
monitoring_service file to make any updates.

### Update Image

1. `images/monitoring/Makefile` Commands to build and deploy the monitoring images.
1. `images/monitoring/Makefile` Commands to build and deploy the monitoring
images.

1. Update to use the latest image on GKE
```bash
kubectl rollout restart deployment.apps/monitoring-app
```

Check the rollout status
```bash
kubectl rollout status deployment.apps/monitoring-app
```
```bash
kubectl rollout restart deployment.apps/monitoring-app
```

Check the rollout status

```bash
kubectl rollout status deployment.apps/monitoring-app
```

### Clearing the alerts

From `tools/monitoring/clearalerts` directory, run `run_clear_alerts.sh` script.

Note: `run_clear_alerts.sh` only works on linux machine. It builds the binary on the local machine and copies it to the monitoring pod. On MacOS, the binary it built returns error `cannot execute binary file: Exec format error` when it runs on the monitoring pod.
Note: `run_clear_alerts.sh` only works on linux machine. It builds the binary on
the local machine and copies it to the monitoring pod. On MacOS, the binary it
built returns error `cannot execute binary file: Exec format error` when it runs
on the monitoring pod.

0 comments on commit 999724a

Please sign in to comment.