Filebeat Chart #117

tylerjl · 2019-05-01T23:07:18Z

Chart version not bumped (the versions are all bumped and released at the same time)
README.md updated with any new values or changes
Updated template tests in ${CHART}/tests/*.py
Updated integration tests in ${CHART}/examples/*/test/goss.yaml

@Crazybus pushing what I have thus far. I think the actual body of the yaml templates, template tests, and docs are mostly complete, the remaining steps from my perspective are:

Adding goss testing to check for end-to-end "are filebeat indices being created" tests, which will involve releasing ES to a test cluster
Writing up accompanying CI definitions

I've pushed this to a branch on this repo instead of my fork so feel free to tinker with the branch if you want, I'm fine with either of us writing those tests and CI jobs, whoever gets to it first.

Implementation notes:

I left out PDBs since they don't make sense for a DaemonSet but left configurable tolerations in place, because they apply for a DaemonSet anyway and were in my copypasta 😁
Old versions of the Chart used emptyDir, while the newer reference that the beats team maintains prefers hostPath, which I've reflected here. See the associated commit that made this change for additional information.
Do note that I'm using the internal monitoring HTTP port as a health check for the pod. I don't know whether I prefer this or using the config check -c flag, I leaned this way because it's a more definitive check in case the go process became unresponsive for whatever reason. The downside is that the docs mark this feature as experimental.
This is the first chart that will potentially manage RBAC resources. I didn't do anything crazy here aside from permitting the chart to flip these off with a boolean value.

Crazybus

LGTM. This is awesome work 🏅 🥇

I left some comments on some improvements/changes. However I'm approving and merging this in so we can continue to iterate on it.

Crazybus · 2019-05-02T17:53:00Z

elasticsearch/README.md

@@ -65,11 +65,11 @@ helm install --name elasticsearch elastic/elasticsearch --version 7.0.0-alpha1 -
 | `minimumMasterNodes`       | The value for [discovery.zen.minimum_master_nodes](https://www.elastic.co/guide/en/elasticsearch/reference/6.7/discovery-settings.html#minimum_master_nodes). Should be set to `(master_eligible_nodes / 2) + 1`. Ignored in Elasticsearch versions >= 7.                                                                  | `2`                                                                                                                       |
 | `esMajorVersion`           | Used to set major version specific configuration                                                                                                                                                                                                                                                                           | `7`                                                                                                                       |
 | `esConfig`                 | Allows you to add any config files in `/usr/share/elasticsearch/config/` such as `elasticsearch.yml` and `log4j2.properties`. See [values.yaml](./values.yaml) for an example of the formatting.                                                                                                                           | `{}`                                                                                                                      |
-| `extraEnvs`                | Extra [environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config) which will be appended to the `env:` definition for the container                                                                         | `{}`                                                                                                                      |
+| `extraEnvs`                | Extra [environment variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config) which will be appended to the `env:` definition for the container                                                                         | `[]`                                                                                                                      |


Thanks for catching these Mr Eagle eyes.

Crazybus · 2019-05-02T17:57:26Z

filebeat/README.md

+| `secretMounts`             | Allows you easily mount a secret as a file inside the `DaemonSet`. Useful for mounting certificates and other secrets. See [values.yaml](./values.yaml) for an example                                                                                                                                                     | `[]`                                                                                                                      |
+| `terminationGracePeriod`   | Termination period (in seconds) to wait before killing Filebeat pod process on pod shutdown                                                                                                                                                                                                                                | `30`                                                                                                                      |
+| `tolerations`              | Configurable [tolerations](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)                                                                                                                                                                                                                        | `[]`                                                                                                                      |
+| `updateStrategy`           | The [updateStrategy](https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#updating-statefulsets) for the `DaemonSet`. By default Kubernetes will kill and recreate pods on updates. Setting this to `OnDelete` will require that pods be deleted manually.                                        | `RollingUpdate`                                                                                                           |


The link here should be pointing to the daemonset docs instead of the statefulset. https://kubernetes.io/docs/tasks/manage-daemon/update-daemon-set/#daemonset-update-strategy

Crazybus · 2019-05-02T17:59:28Z

filebeat/examples/default/values.yaml

@@ -0,0 +1,17 @@
+---
+filebeatConfig:


As discussed we are going to make these values the defaults so that the default helm install filebeat experience will already send logs to the default elasticsearch chart address.

Crazybus · 2019-05-02T17:59:58Z

filebeat/templates/NOTES.txt

@@ -0,0 +1,4 @@
+1. Watch all cluster members come up.


Think this is a copy/paste thing but I'll update this to remove "cluster members".

Crazybus · 2019-05-02T18:05:37Z

filebeat/templates/daemonset.yaml

+      {{- end }}
+      - name: data
+        hostPath:
+          path: {{ .Values.hostPathRoot }}/{{ template "fullname" . }}-data


I think adding the namespace as part of the path would be a good idea too. Without it there will be collisions if there are multiple filebeat releases running in different namespaces but on the same physical host.

Release names need to be unique in helm but it is possible to have multiple helm/tiller installations in a cluster, and with helm 3 tiller will be gone so I suspect that release names will be namespaced too.

Crazybus · 2019-05-02T18:13:43Z

filebeat/templates/daemonset.yaml

+            port: monitor
+        ports:
+        - name: monitor
+          containerPort: 5066


Should probably make this configurable since it can be changed in filebeat. Not sure why but I'm sure someone has a valid usecase for wanting to customize it so may as well make it configurable.

Crazybus · 2019-05-02T18:18:36Z

Do note that I'm using the internal monitoring HTTP port as a health check for the pod. I don't know whether I prefer this or using the config check -c flag, I leaned this way because it's a more definitive check in case the go process became unresponsive for whatever reason. The downside is that the docs mark this feature as experimental.

This sounds good to me. I'm going to play with it a bit to see how it responds when the endpoint (such as elasticsearch) is down. It was only added in 6.4 but I don't see that being a problem as long as it is working in the latest 6.x and 7.x releases.

tylerjl added 4 commits April 25, 2019 09:23

Fix some incorrect es/kibana default values in docs

2a231f2

Initial commit of Filebeat chart

b367fa5

Remove unused filebeat PDB template

161c6cf

[filebeat] python templating tests

2a00066

tylerjl self-assigned this May 1, 2019

Crazybus approved these changes May 2, 2019

View reviewed changes

Crazybus merged commit 7fd4d16 into master May 2, 2019

tylerjl deleted the filebeat-chart branch May 2, 2019 18:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filebeat Chart #117

Filebeat Chart #117

tylerjl commented May 1, 2019

Crazybus left a comment

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus May 2, 2019

Crazybus commented May 2, 2019

		@@ -0,0 +1,17 @@
		---
		filebeatConfig:

Filebeat Chart #117

Filebeat Chart #117

Conversation

tylerjl commented May 1, 2019

Crazybus left a comment

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus May 2, 2019

Choose a reason for hiding this comment

Crazybus commented May 2, 2019