Skip to content

Commit

Permalink
fix(helm): review
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienOrain committed Nov 7, 2024
1 parent d604a9c commit c0d9aa8
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 14 deletions.
37 changes: 33 additions & 4 deletions chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,32 @@

### Logstash configuration

| Name | Description | Value |
| -------------- | --------------------- | ---------------------- |
| `logstash.url` | Logstash instance URL | `http://logstash:9600` |
| Name | Description | Value |
| ----------------------- | --------------------- | ---------------------- |
| `logstash.url` | Logstash instance URL | `http://logstash:9600` |
| `logstash.httpTimeout` | http timeout | `3s` |
| `logstash.httpInsecure` | http insecure | `false` |

### Web settings

| Name | Description | Value |
| ---------- | ----------------------------------- | ----- |
| `web.path` | Path under which to expose metrics. | `/` |

### PodMonitor settings

| Name | Description | Value |
| ------------------------------ | --------------------------------- | -------------------------- |
| `podMonitor.enabled` | Enable pod monitor creation | `false` |
| `podMonitor.apiVersion` | Set pod monitor apiVersion | `monitoring.coreos.com/v1` |
| `podMonitor.namespace` | Set pod monitor namespace | `""` |
| `podMonitor.labels` | Set pod monitor labels | `{}` |
| `podMonitor.interval` | Set pod monitor interval | `60s` |
| `podMonitor.scrapeTimeout` | Set pod monitor scrapeTimeout | `10s` |
| `podMonitor.honorLabels` | Set pod monitor honorLabels | `true` |
| `podMonitor.scheme` | Set pod monitor scheme | `http` |
| `podMonitor.relabelings` | Set pod monitor relabelings | `[]` |
| `podMonitor.metricRelabelings` | Set pod monitor metricRelabelings | `[]` |

### Image settings

Expand Down Expand Up @@ -58,6 +81,12 @@
| `deployment.rollingUpdate.maxSurge` | Maximum surge for rolling update | `1` |
| `deployment.rollingUpdate.maxUnavailable` | Maximum unavailable for rolling update | `0` |

### metricsPort settings

| Name | Description | Value |
| ----------------------------- | ---------------- | ------ |
| `deployment.metricsPort.name` | Name of the port | `http` |

### Service settings

| Name | Description | Value |
Expand All @@ -74,4 +103,4 @@
| `serviceAccount.enabled` | Enable service account creation | `false` |
| `serviceAccount.create` | Create service account | `false` |
| `serviceAccount.name` | Service account name | `""` |
| `serviceAccount.annotations` | Additional service account annotations | `{}` |
| `serviceAccount.annotations` | Additional service account annotations | `{}` |
87 changes: 87 additions & 0 deletions chart/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,83 @@
"type": "string",
"description": "Logstash instance URL",
"default": "http://logstash:9600"
},
"httpTimeout": {
"type": "string",
"description": "http timeout",
"default": "3s"
},
"httpInsecure": {
"type": "boolean",
"description": "http insecure",
"default": false
}
}
},
"web": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path under which to expose metrics.",
"default": "/"
}
}
},
"podMonitor": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable pod monitor creation",
"default": false
},
"apiVersion": {
"type": "string",
"description": "Set pod monitor apiVersion",
"default": "monitoring.coreos.com/v1"
},
"namespace": {
"type": "string",
"description": "Set pod monitor namespace",
"default": ""
},
"labels": {
"type": "object",
"description": "Set pod monitor labels",
"default": {}
},
"interval": {
"type": "string",
"description": "Set pod monitor interval",
"default": "60s"
},
"scrapeTimeout": {
"type": "string",
"description": "Set pod monitor scrapeTimeout",
"default": "10s"
},
"honorLabels": {
"type": "boolean",
"description": "Set pod monitor honorLabels",
"default": true
},
"scheme": {
"type": "string",
"description": "Set pod monitor scheme",
"default": "http"
},
"relabelings": {
"type": "array",
"description": "Set pod monitor relabelings",
"default": [],
"items": {}
},
"metricRelabelings": {
"type": "array",
"description": "Set pod monitor metricRelabelings",
"default": [],
"items": {}
}
}
},
Expand Down Expand Up @@ -187,6 +264,16 @@
"default": 0
}
}
},
"metricsPort": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the port",
"default": "http"
}
}
}
}
},
Expand Down
12 changes: 2 additions & 10 deletions chart/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,9 @@ deployment:
restartPolicy: Always
## @param deployment.annotations Additional deployment annotations
##
## Example:
## annotations:
## kubernetes.io/foo: bar
##
annotations: {}
## @param deployment.labels Additional deployment labels
##
## Example:
## labels:
## foo: bar
##
labels: {}
## @param deployment.pullSecret Kubernetes secret for pulling the image
##
Expand Down Expand Up @@ -173,7 +165,7 @@ deployment:
## @section metricsPort settings
##
metricsPort:
## @param metricsPort.name Name of the port
## @param deployment.metricsPort.name Name of the port
##
name: http

Expand Down Expand Up @@ -207,4 +199,4 @@ serviceAccount:
name: ""
## @param serviceAccount.annotations Additional service account annotations
##
annotations: {}
annotations: {}

0 comments on commit c0d9aa8

Please sign in to comment.