dev->main

Makefile

@@ -22,4 +22,5 @@ dev: build-dev
 		-e FIRETAIL_API_TOKEN=${FIRETAIL_API_TOKEN} \
 		-e FIRETAIL_KUBERNETES_SENSOR_DEV_MODE=true \
 		-e FIRETAIL_KUBERNETES_SENSOR_DEV_SERVER_ENABLED=true \
+		-e DISABLE_SERVICE_IP_FILTERING=true \
 		firetail/kubernetes-sensor-dev

README.md

@@ -10,14 +10,13 @@ POC for a FireTail Kubernetes Sensor.
 | ----------------------------------------------- | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | `FIRETAIL_API_TOKEN`                            | ✅         | `PS-02-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX` | The API token the sensor will use to report logs to FireTail |
 | `BPF_EXPRESSION`                                | ❌         | `tcp and (port 80 or port 443)`                              | The BPF filter used by the sensor. See docs for syntax info: https://www.tcpdump.org/manpages/pcap-filter.7.html |
+| `DISABLE_SERVICE_IP_FILTERING`                  | ❌         | `true`                                                       | Disables polling Kubernetes for the IP addresses of services & subsequently ignoring all requests captured that aren't made to one of those IPs. |
 | `FIRETAIL_API_URL`                              | ❌         | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk`  | The API url the sensor will send logs to. Defaults to the EU region production environment. |
-| `FIRETAIL_KUBERNETES_SENSOR_DEV_MODE`           | ❌         | `true`                                                       | Enables debug logging when set to `true`.                    |
+| `FIRETAIL_KUBERNETES_SENSOR_DEV_MODE`           | ❌         | `true`                                                       | Enables debug logging when set to `true`, and reduces the max age of a log in a batch to be sent to FireTail. |
 | `FIRETAIL_KUBERNETES_SENSOR_DEV_SERVER_ENABLED` | ❌         | `true`                                                       | Enables a demo web server when set to `true`; useful for sending test requests to. |
 
 
 
-
-
 ## Dev Quickstart
 
 Clone the repo, make a `.env` file with your API token in it, then use the `dev` target in [the provided makefile](./Makefile):
@@ -54,5 +53,10 @@ ftauth
 make publish VERSION=latest
 ```
 
-[Kubernetes sensor docker repository link](https://github.com/firetail-io/firetail-kubernetes-sensor/pkgs/container/kubernetes-sensor)
 
+
+## Publishing to GHCR
+
+Publishing to GHCR is done via GitHub actions found in [./.github/workflows](./.github/workflows).
+
+You can find the images published here: [github.com/firetail-io/firetail-kubernetes-sensor/pkgs/container/kubernetes-sensor](https://github.com/firetail-io/firetail-kubernetes-sensor/pkgs/container/kubernetes-sensor)

helm/README.md

@@ -0,0 +1,3 @@
+```bash
+helm install firetail-sensor-helm firetail-sensor/ --set apiKey="example"
+```

helm/firetail-sensor/.helmignore

@@ -0,0 +1,23 @@
+# 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
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

helm/firetail-sensor/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: firetail-sensor
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"

helm/firetail-sensor/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "firetail-sensor.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 "firetail-sensor.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 "firetail-sensor.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "firetail-sensor.labels" -}}
+helm.sh/chart: {{ include "firetail-sensor.chart" . }}
+{{ include "firetail-sensor.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "firetail-sensor.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "firetail-sensor.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "firetail-sensor.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "firetail-sensor.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

helm/firetail-sensor/templates/api-secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: firetail-api-token-secret
+  namespace: {{ .Values.namespace }}
+type: Opaque
+data:
+  api-key: {{ .Values.apiKey | b64enc | quote }}

helm/firetail-sensor/templates/daemonset.yaml

@@ -0,0 +1,53 @@
+apiVersion: apps/v1
+kind: DaemonSet
+metadata:
+  name: {{ .Release.Name }}-daemonset
+  namespace: {{ .Values.namespace }}
+  labels:
+    app: {{ .Chart.Name }}
+    release: {{ .Release.Name }}
+spec:
+  selector:
+    matchLabels:
+      app: {{ .Chart.Name }}
+      release: {{ .Release.Name }}
+  template:
+    metadata:
+      labels:
+        app: {{ .Chart.Name }}
+        release: {{ .Release.Name }}
+      annotations:
+        {{- toYaml .Values.podAnnotations | nindent 8 }}
+    spec:
+      serviceAccountName: {{ .Release.Name }}-sa
+      hostNetwork: true
+      containers:
+      - name: firetail-kubernetes-sensor
+        image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        env:
+        - name: "FIRETAIL_API_TOKEN"
+          valueFrom:
+            secretKeyRef:
+              name: "firetail-api-token-secret"
+              key: "api-key"
+        {{- range $key, $value := .Values.env }}
+        - name: "{{ $key }}"
+          value: "{{ $value }}"
+        {{- end }}
+        resources:
+          {{- toYaml .Values.resources | nindent 12 }}
+        securityContext:
+          {{- toYaml .Values.securityContext | nindent 12 }}
+        volumeMounts:
+        - name: lib-modules
+          mountPath: /lib/modules
+        - name: usr-src
+          mountPath: /usr/src
+      volumes:
+      - name: lib-modules
+        hostPath:
+          path: /lib/modules
+      - name: usr-src
+        hostPath:
+          path: /usr/src

helm/firetail-sensor/templates/namespace.yaml

@@ -0,0 +1,4 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: {{ .Values.namespace }}

helm/firetail-sensor/templates/rbac.yaml

@@ -0,0 +1,36 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ .Release.Name }}-sa
+  namespace: {{ .Values.namespace }}
+  labels:
+    app: {{ .Chart.Name }}
+    release: {{ .Release.Name }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: {{ .Release.Name }}-service-list-access
+  labels:
+    app: {{ .Chart.Name }}
+    release: {{ .Release.Name }}
+subjects:
+- kind: ServiceAccount
+  name: {{ .Release.Name }}-sa
+  namespace: {{ .Values.namespace }}
+roleRef:
+  kind: ClusterRole
+  name: {{ .Release.Name }}-list-services
+  apiGroup: rbac.authorization.k8s.io
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: {{ .Release.Name }}-list-services
+  labels:
+    app: {{ .Chart.Name }}
+    release: {{ .Release.Name }}
+rules:
+- apiGroups: [""]
+  resources: ["services"]
+  verbs: ["get", "list", "watch"]

helm/firetail-sensor/values.yaml

@@ -0,0 +1,42 @@
+# Default values for firetail-sensor.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+image:
+  repository: ghcr.io/firetail-io/kubernetes-sensor
+  tag: 1dbc044
+  pullPolicy: IfNotPresent
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+namespace: "firetail"
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Automatically mount a ServiceAccount's API credentials?
+  automount: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+  namespace: default
+
+securityContext: 
+  privileged: true
+
+
+
+
+env:
+  FIRETAIL_API_URL: "https://api.logging.eu-west-1.sandbox.firetail.app/logs/bulk"
+  FIRETAIL_API_URL_EU: "https://api.logging.eu-west-1.firetail.app/logs/bulk"
+  FIRETAIL_API_URL_US: "https://api.logging.us-east-2.us.firetail.app/logs/bulk"
+  FIRETAIL_KUBERNETES_SENSOR_DEV_MODE: "true"
+  FIRETAIL_KUBERNETES_SENSOR_DEV_SERVER_ENABLED: "false"
+  BPF_EXPRESSION: "tcp and (port 80 or port 443) and not net 169.254.0.0/16 and not net fd00::/8"
+  DISABLE_SERVICE_IP_FILTERING: "true"
+
+
+apiKey: ""

kube_templates/daemonset.yaml

@@ -15,7 +15,7 @@ spec:
       serviceAccountName: firetail-ebpf-sa
       hostNetwork: true
       containers:
-      - name: firetail-ebpf-daemonset
+      - name: firetail-ebpf-daemonset # nosemgrep: yaml.kubernetes.security.privileged-container.privileged-container
         image: ghcr.io/firetail-io/kubernetes-sensor:v0.1.5
         imagePullPolicy: IfNotPresent
         securityContext:
@@ -24,7 +24,7 @@ spec:
         - name: FIRETAIL_API_URL
           value: "https://api.logging.eu-west-1.sandbox.firetail.app/logs/bulk"
         - name: FIRETAIL_API_TOKEN
-          value: ""
+          value: 
         - name: FIRETAIL_KUBERNETES_SENSOR_DEV_MODE
           value: "true"
         - name: BPF_EXPRESSION