Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep initial charts indexing #14

Merged
merged 33 commits into from
Aug 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
0bfe2ec
[stable/prometheus] update prometheus to 2.20.1 and cm reloader to 0.…
monotek Aug 11, 2020
c91695f
Deprecate prometheus-operator chart before helm repo index, so that i…
scottrigby Aug 15, 2020
b324685
Update prometheus-community/prometheus chart. Needed to update refere…
scottrigby Aug 16, 2020
4e4c1b5
Add Helm 3 commands before Helm 2. Add helm update command. Reorganiz…
scottrigby Aug 18, 2020
23fe556
Fix header
scottrigby Aug 18, 2020
7fe4d2e
Fix markdown linting
scottrigby Aug 19, 2020
7b344bb
Add direct links to values.yaml configuration file for easy browsing …
scottrigby Aug 19, 2020
30e19a7
Remove prometheus chart OWNERS file
scottrigby Aug 19, 2020
2c98e11
Merge remote-tracking branch 'origin/main' into prep-initial-charts-i…
scottrigby Aug 19, 2020
86b656b
Update prometheus-adapter chart README and bump version
scottrigby Aug 19, 2020
adb4e21
prometheus chart: Return updated, working command example for Sharing…
scottrigby Aug 19, 2020
2820b0f
prometheus-adapter: fix configure command typos
scottrigby Aug 19, 2020
625050f
prometheus-blackbox-exporter: Update readme, delete OWNERS file and b…
scottrigby Aug 19, 2020
444b0ee
prometheus-cloudwatch-exporter: Update Readme with new template, dele…
scottrigby Aug 19, 2020
de8f7c8
prometheus-consul-exporter: Update Readme per new template and bump c…
scottrigby Aug 19, 2020
64cfc42
prometheus-couchdb-exporter: Update Readme per new template and bump …
scottrigby Aug 19, 2020
6f98656
prometheus-mongodb-exporter: Update Readme per new template, remove O…
scottrigby Aug 19, 2020
e077831
prometheus-couchdb-exporter: Fix k8s 1.16 deprecated PodSecurityPolic…
scottrigby Aug 19, 2020
1e18c2a
prometheus-couchdb-exporter: Fix bad YAML indentation. How did this e…
scottrigby Aug 20, 2020
41a6dd6
prometheus-mysql-exporter: update readme per new template, remove OWN…
scottrigby Aug 20, 2020
43c38d4
prometheus-nats-exporter: update readme per new template, move specif…
scottrigby Aug 20, 2020
cfd8734
prometheus-node-exporter: update readme per new template, remove OWNE…
scottrigby Aug 20, 2020
0af8705
prometheus-postgres-exporter: update readme per new template, remove …
scottrigby Aug 20, 2020
8f57b42
prometheus-pushgateway: update readme per new template, remove OWNERS…
scottrigby Aug 20, 2020
8088bb7
prometheus-rabbitmq-exporter: update readme per new template, bump ch…
scottrigby Aug 20, 2020
7c70909
prometheus-redis-exporter: update readme per new template, remove OWN…
scottrigby Aug 20, 2020
991f0b7
prometheus-snmp-exporter: update readme per new template, remove OWNE…
scottrigby Aug 20, 2020
0cde9c5
prometheus-to-sd: update readme per new template, remove OWNERS file,…
scottrigby Aug 20, 2020
20623b4
prometheus-to-sd: fix deprecated deployment apps/v1beta1
scottrigby Aug 20, 2020
c92bfcd
Remove instructions for stable repos from all charts, except promethe…
scottrigby Aug 20, 2020
079e7ab
Temporary workaround github API rate limiting
scottrigby Aug 20, 2020
5154b99
prometheus-to-sd: missing required field "selector" in io.k8s.api.app…
scottrigby Aug 20, 2020
391e246
disable chart testing for prometheus-to-sd. If not running on GCE, wi…
scottrigby Aug 20, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/prometheus-adapter/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v1
name: prometheus-adapter
version: 2.5.0
version: 2.5.1
appVersion: v0.7.0
description: A Helm chart for k8s prometheus adapter
home: https://github.com/DirectXMan12/k8s-prometheus-adapter
Expand Down
8 changes: 0 additions & 8 deletions charts/prometheus-adapter/OWNERS

This file was deleted.

133 changes: 60 additions & 73 deletions charts/prometheus-adapter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,74 @@ Installs the [Prometheus Adapter](https://github.com/DirectXMan12/k8s-prometheus

Kubernetes 1.14+

## Installing the Chart
## Get Repo Info

To install the chart with the release name `my-release`:
```console
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update
```

_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._

## Install Chart

```console
# Helm 3
$ helm install [RELEASE_NAME] prometheus-community/prometheus-adapter

# Helm 2
$ helm install --name [RELEASE_NAME] prometheus-community/prometheus-adapter
```

_See [configuration](#configuration) below._

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

## Uninstall Chart

```console
$ helm install --name my-release stable/prometheus-adapter
# Helm 3
$ helm uninstall [RELEASE_NAME]

# Helm 2
# helm delete --purge [RELEASE_NAME]
```

This command deploys the prometheus adapter with the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
This removes all the Kubernetes components associated with the chart and deletes the release.

_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._

## Upgrading Chart

```console
# Helm 3 or 2
$ helm upgrade [RELEASE_NAME] [CHART] --install
```

_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._

## Configuration

See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:

```console
# Helm 2
$ helm inspect values prometheus-community/prometheus-adapter

# Helm 3
$ helm show values prometheus-community/prometheus-adapter
```

## Using the Chart
### Prometheus Service Endpoint

To use the chart, ensure the `prometheus.url` and `prometheus.port` are configured with the correct Prometheus service endpoint. If Prometheus is exposed under HTTPS the host's CA Bundle must be exposed to the container using `extraVolumes` and `extraVolumeMounts`.

### Adapter Rules

Additionally, the chart comes with a set of default rules out of the box but they may pull in too many metrics or not map them correctly for your needs. Therefore, it is recommended to populate `rules.custom` with a list of rules (see the [config document](https://github.com/DirectXMan12/k8s-prometheus-adapter/blob/master/docs/config.md) for the proper format).

### Horizontal Pod Autoscaler Metrics

Finally, to configure your Horizontal Pod Autoscaler to use the custom metric, see the custom metrics section of the [HPA walkthrough](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics).

The Prometheus Adapter can serve three different [metrics APIs](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-metrics-apis):
Expand All @@ -30,7 +82,7 @@ The Prometheus Adapter can serve three different [metrics APIs](https://kubernet

Enabling this option will cause custom metrics to be served at `/apis/custom.metrics.k8s.io/v1beta1`. Enabled by default when `rules.default` is true, but can be customized by populating `rules.custom`:

```
```yaml
rules:
custom:
- seriesQuery: '{__name__=~"^some_metric_count$"}'
Expand All @@ -46,7 +98,7 @@ rules:

Enabling this option will cause external metrics to be served at `/apis/external.metrics.k8s.io/v1beta1`. Can be enabled by populating `rules.external`:

```
```yaml
rules:
external:
- seriesQuery: '{__name__=~"^some_metric_count$"}'
Expand All @@ -62,7 +114,7 @@ rules:

Enabling this option will cause resource metrics to be served at `/apis/metrics.k8s.io/v1beta1`. Resource metrics will allow pod CPU and Memory metrics to be used in [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) as well as the `kubectl top` command. Can be enabled by populating `rules.resource`:

```
```yaml
rules:
resource:
cpu:
Expand Down Expand Up @@ -93,68 +145,3 @@ rules:
```

**NOTE:** Setting a value for `rules.resource` will also deploy the resource metrics API service, providing the same functionality as [metrics-server](https://github.com/helm/charts/tree/master/stable/metrics-server). As such it is not possible to deploy them both in the same cluster.

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```console
$ helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Configuration

The following table lists the configurable parameters of the Prometheus Adapter chart and their default values.

| Parameter | Description | Default |
| ------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------|
| `affinity` | Node affinity | `{}` |
| `image.repository` | Image repository | `directxman12/k8s-prometheus-adapter-amd64` |
| `image.tag` | Image tag | `v0.7.0` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Image pull secrets | `{}` |
| `logLevel` | Log level | `4` |
| `listenPort` | Port that application would listen on in the container | `6443` |
| `metricsRelistInterval` | Interval at which to re-list the set of all available metrics from Prometheus | `1m` |
| `nodeSelector` | Node labels for pod assignment | `{}` |
| `podLabels` | Labels to add to the pod | `{}` |
| `podAnnotations` | Annotations to add to the pod | `{}` |
| `priorityClassName` | Pod priority | `` |
| `prometheus.url` | Url of where we can find the Prometheus service | `http://prometheus.default.svc` |
| `prometheus.port` | Port of where we can find the Prometheus service, zero to omit this option | `9090` |
| `prometheus.path` | Custom path to append to the prometheus URL | `` |
| `rbac.create` | If true, create & use RBAC resources | `true` |
| `resources` | CPU/Memory resource requests/limits | `{}` |
| `rules.default` | If `true`, enable a set of default rules in the configmap | `true` |
| `rules.custom` | A list of custom configmap rules | `[]` |
| `rules.existing` | The name of an existing configMap with rules. Overrides default, custom and external. | `` |
| `rules.external` | A list of custom rules for external metrics API | `[]` |
| `rules.resource` | `resourceRules` to set in configmap rules | `{}` |
| `service.annotations` | Annotations to add to the service | `{}` |
| `service.port` | Service port to expose | `443` |
| `service.type` | Type of service to create | `ClusterIP` |
| `serviceAccount.create` | If true, create & use Serviceaccount | `true` |
| `serviceAccount.name` | If not set and create is true, a name is generated using the fullname template | `` |
| `tls.enable` | If true, use the provided certificates. If false, generate self-signed certs | `false` |
| `tls.ca` | Public CA file that signed the APIService (ignored if tls.enable=false) | `` |
| `tls.key` | Private key of the APIService (ignored if tls.enable=false) | `` |
| `tls.certificate` | Public key of the APIService (ignored if tls.enable=false) | `` |
| `extraVolumeMounts` | Any extra volumes mounts | `[]` |
| `extraVolumes` | Any extra volumes | `[]` |
| `tolerations` | List of node taints to tolerate | `[]` |

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install --name my-release \
--set logLevel=1 \
stable/prometheus-adapter
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

```console
$ helm install --name my-release -f values.yaml stable/prometheus-adapter
```
2 changes: 1 addition & 1 deletion charts/prometheus-blackbox-exporter/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v1
description: Prometheus Blackbox Exporter
name: prometheus-blackbox-exporter
version: 4.3.0
version: 4.3.1
appVersion: 0.16.0
home: https://github.com/prometheus/blackbox_exporter
sources:
Expand Down
6 changes: 0 additions & 6 deletions charts/prometheus-blackbox-exporter/OWNERS

This file was deleted.

Loading