[stable/apm-server] Elastic APM Server (helm#6058)

[Elastic APM](https://www.elastic.co/guide/en/apm/get-started/current/overview.html) is an application performance monitoring system built on the Elastic Stack. This chart is to install the server part of the system. See the official documentation to setup the agent part of the system. Even though apm-server is built by the Elastic team, it supports alternative outputs other than Elasticsearch via built-in beat output plugins and community plugins. For example, [awsbeats](https://github.com/s12v/awsbeats) enables apm-server to write collected application traces to AWS Kinesis Streams. Other changelog: - Include the commented-out elasticsearch output too support common use-cases - Include the configuraion table in the README
or1can · Jul 10, 2018 · 7c30609 · 7c30609
1 parent 8afc95d
commit 7c30609
Show file tree

Hide file tree

Showing 11 changed files with 427 additions and 0 deletions.
diff --git a/stable/apm-server/.helmignore b/stable/apm-server/.helmignore
@@ -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
diff --git a/stable/apm-server/Chart.yaml b/stable/apm-server/Chart.yaml
@@ -0,0 +1,12 @@
+apiVersion: v1
+description: The server receives data from the Elastic APM agents and stores the data into a datastore like Elasticsearch
+icon: https://www.elastic.co/assets/blt47799dcdcf08438d/logo-elastic-beats-lt.svg
+name: apm-server
+version: 0.1.0
+appVersion: 6.2.4
+home: https://www.elastic.co/solutions/apm
+sources:
+- https://www.elastic.co/guide/en/apm/get-started/current/index.html
+maintainers:
+- name: mumoshu
+  email: [email protected]
diff --git a/stable/apm-server/README.md b/stable/apm-server/README.md
@@ -0,0 +1,71 @@
+# apm-server
+
+[apm-server](https://www.elastic.co/guide/en/beats/apm-server/current/index.html)  is the server receives data from the Elastic APM agents and stores the data into a datastore like Elasticsearch.
+
+## Introduction
+
+This chart deploys apm-server 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/apm/get-started/current/install-and-run.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/apm-server
+```
+
+After a few minutes, you should see service statuses being written to the configured output, which is a log file inside the apm-server 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 apm-server chart and their default values.
+
+|             Parameter               |            Description             |                    Default                |
+|-------------------------------------|------------------------------------|-------------------------------------------|
+| `image.repository`                  | The image repository to pull from  | `docker.elastic.co/apm/apm-server`        |
+| `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 apm-server. See the [apm-server documentation](https://www.elastic.co/guide/en/beats/apm-server/current/apm-server-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/apm-server
+```
+
+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/apm-server
+```
+
+> **Tip**: You can use the default [values.yaml](values.yaml)
diff --git a/stable/apm-server/templates/NOTES.txt b/stable/apm-server/templates/NOTES.txt
@@ -0,0 +1,3 @@
+To verify that apm-server has started, run:
+
+  kubectl --namespace={{ .Release.Namespace }} get pods -l "app={{ template "apm-server.name" . }},release={{ .Release.Name }}"
diff --git a/stable/apm-server/templates/_helpers.tpl b/stable/apm-server/templates/_helpers.tpl
@@ -0,0 +1,43 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "apm-server.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 "apm-server.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 "apm-server.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "apm-server.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+    {{ default (include "apm-server.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+    {{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}
diff --git a/stable/apm-server/templates/clusterrole.yaml b/stable/apm-server/templates/clusterrole.yaml
@@ -0,0 +1,17 @@
+{{- if .Values.rbac.create -}}
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: {{ template "apm-server.fullname" . }}
+  labels:
+    app: {{ template "apm-server.name" . }}
+    chart: {{ template "apm-server.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+rules:
+- apiGroups: [""]
+  resources:
+  - namespaces
+  - pods
+  verbs: ["get", "list", "watch"]
+{{- end -}}
diff --git a/stable/apm-server/templates/clusterrolebinding.yaml b/stable/apm-server/templates/clusterrolebinding.yaml
@@ -0,0 +1,19 @@
+{{- if .Values.rbac.create -}}
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: {{ template "apm-server.fullname" . }}
+  labels:
+    app: {{ template "apm-server.name" . }}
+    chart: {{ template "apm-server.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: {{ template "apm-server.fullname" . }}
+subjects:
+- kind: ServiceAccount
+  name: {{ template "apm-server.serviceAccountName" . }}
+  namespace: {{ .Release.Namespace }}
+{{- end -}}
diff --git a/stable/apm-server/templates/daemonset.yaml b/stable/apm-server/templates/daemonset.yaml
@@ -0,0 +1,92 @@
+apiVersion: apps/v1
+kind: DaemonSet
+metadata:
+  name: {{ template "apm-server.fullname" . }}
+  labels:
+    app: {{ template "apm-server.name" . }}
+    chart: {{ template "apm-server.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+spec:
+  selector:
+    matchLabels:
+      app: {{ template "apm-server.name" . }}
+      release: {{ .Release.Name }}
+  minReadySeconds: 10
+  updateStrategy:
+    type: RollingUpdate
+    rollingUpdate:
+      maxUnavailable: 1
+  template:
+    metadata:
+      labels:
+        app: {{ template "apm-server.name" . }}
+        release: {{ .Release.Name }}
+        {{-  range $key, $value := .Values.podLabels }}
+        {{ $key }}: {{ $value }}
+        {{- end }}
+      annotations:
+        checksum/secret: {{ toYaml .Values.config | sha256sum }}
+        {{-  range $key, $value := .Values.podAnnotations }}
+        {{ $key }}: {{ $value }}
+        {{- end }}
+    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 }}
+{{- if .Values.extraArgs }}
+{{ toYaml .Values.extraArgs | indent 8 }}
+{{- end }}
+        env:
+{{- range $key, $value := .Values.extraVars }}
+        - name: {{ $key }}
+          value: {{ $value }}
+{{- end }}
+        ports:
+          - containerPort: 8200
+        securityContext:
+          runAsUser: 0
+        resources:
+{{ toYaml .Values.resources | indent 10 }}
+        volumeMounts:
+        - name: apm-server-config
+          mountPath: /usr/share/apm-server/apm-server.yml
+          readOnly: true
+          subPath: apm-server.yml
+        - name: data
+          mountPath: /usr/share/apm-server/data
+{{- if .Values.extraVolumeMounts }}
+{{ toYaml .Values.extraVolumeMounts | indent 8 }}
+{{- end }}
+      volumes:
+      - name: apm-server-config
+        secret:
+          secretName: {{ template "apm-server.fullname" . }}
+      - name: data
+        hostPath:
+          path: /var/lib/apm-server
+          type: DirectoryOrCreate
+{{- if .Values.extraVolumes }}
+{{ toYaml .Values.extraVolumes | indent 6 }}
+{{- end }}
+      terminationGracePeriodSeconds: 60
+      serviceAccountName: {{ template "apm-server.serviceAccountName" . }}
+{{- if .Values.nodeSelector }}
+      nodeSelector:
+{{ toYaml .Values.nodeSelector | indent 8 }}
+    {{- end }}
+    {{- if .Values.tolerations }}
+      tolerations:
+{{ toYaml .Values.tolerations | indent 8 }}
+    {{- end }}
+    {{- if .Values.affinity }}
+      affinity:
+{{ toYaml .Values.affinity | indent 8 }}
+    {{- end }}
diff --git a/stable/apm-server/templates/secret.yaml b/stable/apm-server/templates/secret.yaml
@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ template "apm-server.fullname" . }}
+  labels:
+    app: {{ template "apm-server.name" . }}
+    chart: {{ template "apm-server.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+type: Opaque
+data:
+  apm-server.yml: {{ toYaml .Values.config | indent 4 | b64enc }}
diff --git a/stable/apm-server/templates/serviceaccount.yaml b/stable/apm-server/templates/serviceaccount.yaml
@@ -0,0 +1,11 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ template "apm-server.serviceAccountName" . }}
+  labels:
+    app: {{ template "apm-server.name" . }}
+    chart: {{ template "apm-server.chart" . }}
+    release: {{ .Release.Name }}
+    heritage: {{ .Release.Service }}
+{{- end -}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		To verify that apm-server has started, run:

		kubectl --namespace={{ .Release.Namespace }} get pods -l "app={{ template "apm-server.name" . }},release={{ .Release.Name }}"