Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidheryanto committed Mar 13, 2020
1 parent 571f1d9 commit cf26d16
Show file tree
Hide file tree
Showing 8 changed files with 2,350 additions and 1,050 deletions.
7 changes: 3 additions & 4 deletions infra/charts/feast/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ This chart install Feast deployment on a Kubernetes cluster using the [Helm](htt

## Chart requirements

The chart dependencies are bundled in this chart so Feast users do need to run
`helm dep update` to update the dependencies. It also allows Feast chart
maintainers to set reasonable defaults values for the dependencies so end users
of Feast are not overwhelmed with the available configuration.
The chart dependencies are bundled in this chart so Feast users can use them directly.
It also allows Feast chart maintainers to set reasonable defaults values for the
dependencies so end users are not overwhelmed with the available configuration.

| Name | Version |
|------|---------|
Expand Down
7 changes: 3 additions & 4 deletions infra/charts/feast/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,9 @@ This chart install Feast deployment on a Kubernetes cluster using the [Helm](htt

## Chart requirements

The chart dependencies are bundled in this chart so Feast users do need to run
`helm dep update` to update the dependencies. It also allows Feast chart
maintainers to set reasonable defaults values for the dependencies so end users
of Feast are not overwhelmed with the available configuration.
The chart dependencies are bundled in this chart so Feast users can use them directly.
It also allows Feast chart maintainers to set reasonable defaults values for the
dependencies so end users are not overwhelmed with the available configuration.

| Name | Version |
|------|---------|
Expand Down
449 changes: 321 additions & 128 deletions infra/charts/feast/charts/grafana/README.md

Large diffs are not rendered by default.

546 changes: 432 additions & 114 deletions infra/charts/feast/charts/kafka/README.md

Large diffs are not rendered by default.

700 changes: 566 additions & 134 deletions infra/charts/feast/charts/postgresql/README.md

Large diffs are not rendered by default.

106 changes: 57 additions & 49 deletions infra/charts/feast/charts/prometheus-statsd-exporter/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,57 @@
prometheus-statsd-exporter
==========================
A Helm chart for prometheus statsd-exporter Scrape metrics stored statsd

Current chart version is `0.1.2`

Source code can be found [here](https://github.com/prometheus/statsd_exporter)



## Chart Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"prom/statsd-exporter"` | |
| image.tag | string | `"v0.12.1"` | |
| persistentVolume.accessModes[0] | string | `"ReadWriteOnce"` | |
| persistentVolume.annotations | object | `{}` | |
| persistentVolume.claimName | string | `"prometheus-statsd-exporter"` | |
| persistentVolume.enabled | bool | `true` | |
| persistentVolume.existingClaim | string | `""` | |
| persistentVolume.mountPath | string | `"/data"` | |
| persistentVolume.name | string | `"storage-volume"` | |
| persistentVolume.size | string | `"20Gi"` | |
| persistentVolume.storageClass | object | `{}` | |
| persistentVolume.subPath | string | `""` | |
| service.annotations | object | `{}` | |
| service.clusterIP | string | `""` | |
| service.externalIPs | list | `[]` | |
| service.labels | object | `{}` | |
| service.loadBalancerIP | string | `""` | |
| service.loadBalancerSourceRanges | list | `[]` | |
| service.metricsPort | int | `9102` | |
| service.servicePort | int | `80` | |
| service.statsdPort | int | `9125` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.componentName | string | `"prometheus-statsd-exporter"` | |
| serviceAccount.enable | bool | `false` | |
| statsdexporter.affinity | object | `{}` | |
| statsdexporter.extraArgs | object | `{}` | |
| statsdexporter.ingress.enabled | bool | `false` | |
| statsdexporter.nodeSelector | object | `{}` | |
| statsdexporter.podAnnotations."prometheus.io/path" | string | `"/metrics"` | |
| statsdexporter.podAnnotations."prometheus.io/port" | string | `"9102"` | |
| statsdexporter.podAnnotations."prometheus.io/scrape" | string | `"true"` | |
| statsdexporter.replicaCount | int | `1` | |
| statsdexporter.resources | object | `{}` | |
| statsdexporter.tolerations | object | `{}` | |
# Prometheus statsd-exporter

## TL;DR;

```console
$ helm install incubator/prometheus-statsd-exporter
```

## Introduction

This chart bootstraps a prometheus-statsd-exporter deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Installing the Chart

To install the chart with the release name `my-release`:

```console
$ helm install incubator/prometheus-statsd-exporter --name my-release
```


The command deploys prometheus-statsd-exporter on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

## 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

|Parameter | Description | Default |
|----------------------------|------------------------------------------------------|----------------------------------------|
|`extraArgs` | key:value list of extra arguments to give the binary | `{}` |
|`image.pullPolicy` | Image pull policy | `IfNotPresent` |
|`image.repository` | Image repository | `prom/statsd-exporter` |
|`image.tag` | Image tag | `v0.8.0` |
|`ingress.enabled` | enable ingress | `false` |
|`ingress.path` | ingress base path | `/` |
|`ingress.host` | Ingress accepted hostnames | `nil` |
|`ingress.tls` | Ingress TLS configuration | `[]` |
|`ingress.annotations` | Ingress annotations | `{}` |
|`service.type` | type of service | `ClusterIP` |
|`tolerations` | List of node taints to tolerate | `[]` |
|`resources` | pod resource requests & limits | `{}` |
| `persistence.enabled` | Create a volume to store data | true |

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

```console
$ helm install incubator/prometheus-statsd-exporter --name my-release -f values.yaml
```
> **Tip**: You can use the default [values.yaml](values.yaml)
Loading

0 comments on commit cf26d16

Please sign in to comment.