This repository has been archived by the owner on Feb 22, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16.8k
[stable/heartbeat] Add Heartbeat to check status of your services #5766
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Patterns to ignore when building packages. | ||
# This supports shell glob matching, relative path matching, and | ||
# negation (prefixed with !). Only one pattern per line. | ||
.DS_Store | ||
# Common VCS dirs | ||
.git/ | ||
.gitignore | ||
.bzr/ | ||
.bzrignore | ||
.hg/ | ||
.hgignore | ||
.svn/ | ||
# Common backup files | ||
*.swp | ||
*.bak | ||
*.tmp | ||
*~ | ||
# Various IDEs | ||
.project | ||
.idea/ | ||
*.tmproj |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
apiVersion: v1 | ||
description: A Helm chart to periodically check the status of your services with heartbeat | ||
icon: https://www.elastic.co/jp/assets/blt75e7956191e1bd55/icon-heartbeat-bb.svg | ||
name: heartbeat | ||
version: 0.1.0 | ||
appVersion: 6.2.4 | ||
home: https://www.elastic.co/products/beats/heartbeat | ||
sources: | ||
- https://www.elastic.co/guide/en/beats/heartbeat/current/index.html | ||
maintainers: | ||
- name: mumoshu | ||
email: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# heartbeat | ||
|
||
[heartbeat](https://www.elastic.co/guide/en/beats/heartbeat/current/index.html) is a lightweight daemon that periodically check the status of your services and determine whether they are available. | ||
|
||
## Introduction | ||
|
||
This chart deploys heartbeat agents to all the nodes in your cluster via a DaemonSet. | ||
|
||
By default this chart only ships a single output to a file on the local system. Users should set config.output.file.enabled=false and configure their own outputs as [documented](https://www.elastic.co/guide/en/beats/heartbeat/current/configuring-output.html) | ||
|
||
## Prerequisites | ||
|
||
- Kubernetes 1.9+ | ||
|
||
## Installing the Chart | ||
|
||
To install the chart with the release name `my-release`, run: | ||
|
||
```bash | ||
$ helm install --name my-release stable/heartbeat | ||
``` | ||
|
||
After a few minutes, you should see service statuses being written to the configured output, which is a log file inside the heartbeat container. | ||
|
||
> **Tip**: List all releases using `helm list` | ||
|
||
## Uninstalling the Chart | ||
|
||
To uninstall/delete the `my-release` deployment: | ||
|
||
```bash | ||
$ 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 heartbeat chart and their default values. | ||
|
||
| Parameter | Description | Default | | ||
|-------------------------------------|------------------------------------|-------------------------------------------| | ||
| `image.repository` | The image repository to pull from | `docker.elastic.co/beats/heartbeat` | | ||
| `image.tag` | The image tag to pull | `6.2.4` | | ||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` | | ||
| `rbac.create` | If true, create & use RBAC resources | `true` | | ||
| `rbac.serviceAccount` | existing ServiceAccount to use (ignored if rbac.create=true) | `default` | | ||
| `config` | The content of the configuration file consumed by heartbeat. See the [heartbeat documentation](https://www.elastic.co/guide/en/beats/heartbeat/current/heartbeat-reference-yml.html) for full details | | ||
| `plugins` | List of beat plugins | | ||
| `extraVars` | A map of additional environment variables | | | ||
| `extraVolumes`, `extraVolumeMounts` | Additional volumes and mounts, for example to provide other configuration files | | | ||
| `resources.requests.cpu` | CPU resource requests | | | ||
| `resources.limits.cpu` | CPU resource limits | | | ||
| `resources.requests.memory` | Memory resource requests | | | ||
| `resources.limits.memory` | Memory resource limits | | | ||
|
||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, | ||
|
||
```bash | ||
$ helm install --name my-release \ | ||
--set rbac.create=true \ | ||
stable/heartbeat | ||
``` | ||
|
||
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, | ||
|
||
```bash | ||
$ helm install --name my-release -f values.yaml stable/heartbeat | ||
``` | ||
|
||
> **Tip**: You can use the default [values.yaml](values.yaml) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
To verify that heartbeat has started, run: | ||
|
||
kubectl --namespace={{ .Release.Namespace }} get pods -l "app={{ template "heartbeat.name" . }},release={{ .Release.Name }}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
{{/* vim: set filetype=mustache: */}} | ||
{{/* | ||
Expand the name of the chart. | ||
*/}} | ||
{{- define "heartbeat.name" -}} | ||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create a default fully qualified app name. | ||
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). | ||
If release name contains chart name it will be used as a full name. | ||
*/}} | ||
{{- define "heartbeat.fullname" -}} | ||
{{- if .Values.fullnameOverride -}} | ||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} | ||
{{- else -}} | ||
{{- $name := default .Chart.Name .Values.nameOverride -}} | ||
{{- if contains $name .Release.Name -}} | ||
{{- .Release.Name | trunc 63 | trimSuffix "-" -}} | ||
{{- else -}} | ||
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
{{- end -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create chart name and version as used by the chart label. | ||
*/}} | ||
{{- define "heartbeat.chart" -}} | ||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create the name of the service account to use | ||
*/}} | ||
{{- define "heartbeat.serviceAccountName" -}} | ||
{{- if .Values.serviceAccount.create -}} | ||
{{ default (include "heartbeat.fullname" .) .Values.serviceAccount.name }} | ||
{{- else -}} | ||
{{ default "default" .Values.serviceAccount.name }} | ||
{{- end -}} | ||
{{- end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{{- if .Values.rbac.create -}} | ||
apiVersion: rbac.authorization.k8s.io/v1 | ||
kind: ClusterRole | ||
metadata: | ||
name: {{ template "heartbeat.fullname" . }} | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
chart: {{ template "heartbeat.chart" . }} | ||
release: {{ .Release.Name }} | ||
heritage: {{ .Release.Service }} | ||
rules: | ||
- apiGroups: [""] | ||
resources: | ||
- namespaces | ||
- pods | ||
verbs: ["get", "list", "watch"] | ||
{{- end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{{- if .Values.rbac.create -}} | ||
apiVersion: rbac.authorization.k8s.io/v1 | ||
kind: ClusterRoleBinding | ||
metadata: | ||
name: {{ template "heartbeat.fullname" . }} | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
chart: {{ template "heartbeat.chart" . }} | ||
release: {{ .Release.Name }} | ||
heritage: {{ .Release.Service }} | ||
roleRef: | ||
apiGroup: rbac.authorization.k8s.io | ||
kind: ClusterRole | ||
name: {{ template "heartbeat.fullname" . }} | ||
subjects: | ||
- kind: ServiceAccount | ||
name: {{ template "heartbeat.serviceAccountName" . }} | ||
namespace: {{ .Release.Namespace }} | ||
{{- end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
apiVersion: apps/v1 | ||
kind: DaemonSet | ||
metadata: | ||
name: {{ template "heartbeat.fullname" . }} | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
chart: {{ template "heartbeat.chart" . }} | ||
release: {{ .Release.Name }} | ||
heritage: {{ .Release.Service }} | ||
spec: | ||
selector: | ||
matchLabels: | ||
app: {{ template "heartbeat.name" . }} | ||
release: {{ .Release.Name }} | ||
minReadySeconds: 10 | ||
updateStrategy: | ||
type: RollingUpdate | ||
rollingUpdate: | ||
maxUnavailable: 1 | ||
template: | ||
metadata: | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
release: {{ .Release.Name }} | ||
annotations: | ||
checksum/secret: {{ toYaml .Values.config | sha256sum }} | ||
spec: | ||
containers: | ||
- name: {{ .Chart.Name }} | ||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" | ||
imagePullPolicy: {{ .Values.image.pullPolicy }} | ||
args: | ||
- "-e" | ||
{{- if .Values.plugins }} | ||
- "--plugin" | ||
- {{ .Values.plugins | join "," | quote }} | ||
{{- end }} | ||
env: | ||
{{- range $key, $value := .Values.extraVars }} | ||
- name: {{ $key }} | ||
value: {{ $value }} | ||
{{- end }} | ||
securityContext: | ||
runAsUser: 0 | ||
resources: | ||
{{ toYaml .Values.resources | indent 10 }} | ||
volumeMounts: | ||
- name: heartbeat-config | ||
mountPath: /usr/share/heartbeat/heartbeat.yml | ||
readOnly: true | ||
subPath: heartbeat.yml | ||
- name: data | ||
mountPath: /usr/share/heartbeat/data | ||
{{- if .Values.extraVolumeMounts }} | ||
{{ toYaml .Values.extraVolumeMounts | indent 8 }} | ||
{{- end }} | ||
volumes: | ||
- name: heartbeat-config | ||
secret: | ||
secretName: {{ template "heartbeat.fullname" . }} | ||
- name: data | ||
hostPath: | ||
path: /var/lib/heartbeat | ||
type: DirectoryOrCreate | ||
{{- if .Values.extraVolumes }} | ||
{{ toYaml .Values.extraVolumes | indent 6 }} | ||
{{- end }} | ||
terminationGracePeriodSeconds: 60 | ||
serviceAccountName: {{ template "heartbeat.serviceAccountName" . }} | ||
tolerations: | ||
- key: node-role.kubernetes.io/master | ||
operator: Exists | ||
effect: NoSchedule | ||
{{- if .Values.nodeSelector }} | ||
nodeSelector: | ||
{{ toYaml .Values.nodeSelector | indent 8 }} | ||
{{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: {{ template "heartbeat.fullname" . }} | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
chart: {{ template "heartbeat.chart" . }} | ||
release: {{ .Release.Name }} | ||
heritage: {{ .Release.Service }} | ||
type: Opaque | ||
data: | ||
heartbeat.yml: {{ toYaml .Values.config | indent 4 | b64enc }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{{- if .Values.serviceAccount.create -}} | ||
apiVersion: v1 | ||
kind: ServiceAccount | ||
metadata: | ||
name: {{ template "heartbeat.serviceAccountName" . }} | ||
labels: | ||
app: {{ template "heartbeat.name" . }} | ||
chart: {{ template "heartbeat.chart" . }} | ||
release: {{ .Release.Name }} | ||
heritage: {{ .Release.Service }} | ||
{{- end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
image: | ||
repository: docker.elastic.co/beats/heartbeat | ||
tag: 6.2.4 | ||
pullPolicy: IfNotPresent | ||
|
||
config: | ||
# See https://www.elastic.co/guide/en/beats/heartbeat/current/heartbeat-reference-yml.html for reference | ||
heartbeat.monitors: | ||
- type: icmp | ||
schedule: '*/5 * * * * * *' | ||
hosts: ["localhost"] | ||
ipv4: true | ||
timeout: 16s | ||
wait: 1s | ||
|
||
processors: | ||
- add_cloud_metadata: | ||
|
||
output.file: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about leaving an elasticsearch output section commented out just after this one? That would help the user configuring the most common use case. Something like this:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sounds good! |
||
path: "/usr/share/heartbeat/data" | ||
filename: heartbeat | ||
rotate_every_kb: 10000 | ||
number_of_files: 5 | ||
|
||
# output.elasticsearch: | ||
# hosts: ["elasticsearch:9200"] | ||
# protocol: "https" | ||
# username: "elastic" | ||
# password: "changeme" | ||
|
||
# List of beat plugins | ||
plugins: [] | ||
# - kinesis.so | ||
|
||
# A map of additional environment variables | ||
extraVars: {} | ||
# test1: "test2" | ||
|
||
# Add additional volumes and mounts, for example to read other log files on the host | ||
extraVolumes: [] | ||
# - hostPath: | ||
# path: /var/log | ||
# name: varlog | ||
extraVolumeMounts: [] | ||
# - name: varlog | ||
# mountPath: /host/var/log | ||
# readOnly: true | ||
|
||
resources: {} | ||
# We usually recommend not to specify default resources and to leave this as a conscious | ||
# choice for the user. This also increases chances charts run on environments with little | ||
# resources, such as Minikube. If you do want to specify resources, uncomment the following | ||
# lines, adjust them as necessary, and remove the curly braces after 'resources:'. | ||
# limits: | ||
# cpu: 100m | ||
# memory: 200Mi | ||
# requests: | ||
# cpu: 100m | ||
# memory: 100Mi | ||
|
||
rbac: | ||
# Specifies whether RBAC resources should be created | ||
create: true | ||
|
||
serviceAccount: | ||
# Specifies whether a ServiceAccount should be created | ||
create: true | ||
# The name of the ServiceAccount to use. | ||
# If not set and create is true, a name is generated using the fullname template | ||
name: |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice, this improves our current manifests, I'll copy it to upstream ❤️