Skip to content

Commit

Permalink
chore(readme): fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxStroh committed Apr 22, 2024
1 parent bb0a7ff commit fa7965b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![](teaser.jpg)

This repository enables prometheus scraping of dockerhub rate limits by providing a ready to use docker image and helm chart.
This repository enables Prometheus scraping of dockerhub rate limits by providing a ready to use docker image and helm chart.

You can find more background information in this blog post: https://blog.viadee.de/en/monitoring-the-docker-hub-rate-limit-with-prometheus

Expand All @@ -27,17 +27,17 @@ If your kubernetes cluster does not authenticate with dockerhub you don't need t
2. Fill in the variables `config.dockerhub.username` and `config.dockerhub.password`. It is recommended to use a dockerhub access token for the password.
3. Run `helm upgrade <release name> viadee/docker-hub-rate-limit-exporter --install --namespace=<desired namespace> -f <name of value file>`

## How to tell prometheus to scrape the metrics
## How to tell Prometheus to scrape the metrics

We recommend you to use the prometheus kubernetes operator to run prometheus in your cluster (see: https://github.com/prometheus-operator/prometheus-operator). If you run the operator you can create a `ServiceMonitor` resource to tell prometheus how to scrape the docker-hub-rate-limit-exporter. To do so follow the steps below:
We recommend you to use the Prometheus kubernetes operator to run Prometheus in your cluster (see: https://github.com/prometheus-operator/prometheus-operator). If you run the operator you can create a `ServiceMonitor` resource to tell Prometheus how to scrape the docker-hub-rate-limit-exporter. To do so follow the steps below:

1. Create a helm value file as per the example in this repository or use the value file from above (see: chart/values.yaml)
2. Set the variable `serviceMonitor.enabled` to true
3. Depending on the configuration of your Prometheus Operator you might need to configure the `serviceMonitor.additionalLabels` section to tell prometheus to scrape from this `ServiceMonitor` resource.
3. Depending on the configuration of your Prometheus Operator you might need to configure the `serviceMonitor.additionalLabels` section to tell Prometheus to scrape from this `ServiceMonitor` resource.
4. Alternatively, you might have configured the Prometheus Operator to consider all `ServiceMonitors` in a specific namespace. In that case you can set the `serviceMonitor.namespace` option to deploy the `ServiceMonitor` resource in that namespace.
5. Run `helm upgrade <release name> viadee/docker-hub-rate-limit-exporter --install --namespace=<desired namespace> -f <name of value file>`

If you are not using the prometheus kubernetes operator you would need to configure prometheus manually to scrape the metrics.
If you are not using the Prometheus kubernetes operator you would need to configure Prometheus manually to scrape the metrics.

## Collaboration

Expand Down
2 changes: 1 addition & 1 deletion charts/docker-hub-rate-limit-exporter-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The command removes all the Kubernetes components associated with the chart and
| `serviceMonitor.enabled` | If true, creates a ServiceMonitor instance | `false` |
| `serviceMonitor.additionalLabels` | Configure additional labels for the servicemonitor | `{}` |
| `serviceMonitor.namespace` | The namespace into which the servicemonitor is deployed. If not set, will the same as the namespace of this chart | `nil` |
| `serviceMonitor.interval` | The interval with which prometheus will scrape | `30s` |
| `serviceMonitor.interval` | The interval with which Prometheus will scrape | `30s` |
| `serviceMonitor.scrapeTimeout` | The timeout for the scrape request | `10s` |

## Attribution
Expand Down

0 comments on commit fa7965b

Please sign in to comment.