From 715cfc532616875c6b129261f23e33b0a6de1655 Mon Sep 17 00:00:00 2001 From: riley priddle Date: Tue, 13 May 2025 18:32:29 +0100 Subject: [PATCH 1/5] added correct endpoint --- README.md | 15 ++++----------- helm/firetail-sensor/values.yaml | 6 +++--- 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8c28c13..24b59db 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # Firetail Kubernetes Sensor -POC for a FireTail Kubernetes Sensor. +FireTail Kubernetes Sensor. +## Deployment +- Create an API & API Key on the FireTail Platform (https://www.firetail.ai/docs/create-an-api-token)[https://www.firetail.ai/docs/create-an-api-token] +- deploy helm chart ```helm install firetail-sensor-helm firetail-sensor/ --set apiKey="example"``` ## Environment Variables @@ -46,16 +49,6 @@ After a few seconds, you should see logs appear in the FireTail SaaS platform. -## Publishing to ECS - -Authenticate and then use the `publish` target in [the provided makefile](./Makefile) to login to ECS, tag the image and push it: - -```bash -ftauth -make publish VERSION=latest -``` - - ## Publishing to GHCR diff --git a/helm/firetail-sensor/values.yaml b/helm/firetail-sensor/values.yaml index 1176f8e..3bf9bc7 100644 --- a/helm/firetail-sensor/values.yaml +++ b/helm/firetail-sensor/values.yaml @@ -4,7 +4,7 @@ image: repository: ghcr.io/firetail-io/kubernetes-sensor - tag: 1dbc044 + tag: v0.1.8 pullPolicy: IfNotPresent imagePullSecrets: [] @@ -30,9 +30,9 @@ securityContext: env: - FIRETAIL_API_URL: "https://api.logging.eu-west-1.sandbox.firetail.app/logs/bulk" + FIRETAIL_API_URL: "https://api.logging.us-east-2.prod.us.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_API_URL_US: "https://api.logging.us-east-2.prod.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" From 832b82b7041f085998ea2efaa164032a22e67f8b Mon Sep 17 00:00:00 2001 From: riley priddle Date: Tue, 13 May 2025 18:34:01 +0100 Subject: [PATCH 2/5] update docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24b59db..3f95d1f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ FireTail Kubernetes Sensor. ## Deployment -- Create an API & API Key on the FireTail Platform (https://www.firetail.ai/docs/create-an-api-token)[https://www.firetail.ai/docs/create-an-api-token] +- Create an API & API Key on the FireTail Platform [https://www.firetail.ai/docs/create-an-api-token](https://www.firetail.ai/docs/create-an-api-token) - deploy helm chart ```helm install firetail-sensor-helm firetail-sensor/ --set apiKey="example"``` ## Environment Variables From e6e6621d794407fc5148f8e96edb0e3c5f595df6 Mon Sep 17 00:00:00 2001 From: riley priddle Date: Tue, 13 May 2025 19:30:08 +0100 Subject: [PATCH 3/5] set debug to false updated readme --- README.md | 15 ++++++++------- helm/firetail-sensor/values.yaml | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3f95d1f..4aefc1a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ # Firetail Kubernetes Sensor -FireTail Kubernetes Sensor. - ## Deployment -- Create an API & API Key on the FireTail Platform [https://www.firetail.ai/docs/create-an-api-token](https://www.firetail.ai/docs/create-an-api-token) -- deploy helm chart ```helm install firetail-sensor-helm firetail-sensor/ --set apiKey="example"``` +- Create an API & API Key on the FireTail Platform +- API: [https://www.firetail.ai/docs/create-an-api](https://www.firetail.ai/docs/create-an-api) +- API Token: [https://www.firetail.ai/docs/create-an-api-token](https://www.firetail.ai/docs/create-an-api-token) +- ```git clone https://github.com/FireTail-io/firetail-kubernetes-sensor.git``` +- deploy helm chart ```helm install firetail-sensor firetail-sensor/ --set apiKey="PS-02-XXXXXXXX"``` ## Environment Variables -| Variable Name | Required? | Example | Description | -| ----------------------------------------------- | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `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 | +| Variable Name | Required? | Example | Description | +| ----------------------------------------------- | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `FIRETAIL_API_TOKEN` | ✅ | `PS-02-XXXXXXXX` | 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 | | `MAX_CONTENT_LENGTH` | ❌ | `1048576` | The sensor will only read request or response bodies if their length is less than `MAX_CONTENT_LENGTH` bytes. | | `ENABLE_ONLY_LOG_JSON` | ❌ | `true` | Enables only logging requests where the content-type implies the payload should be JSON, or the payload is valid JSON regardless of the content-type. | diff --git a/helm/firetail-sensor/values.yaml b/helm/firetail-sensor/values.yaml index 3bf9bc7..760442c 100644 --- a/helm/firetail-sensor/values.yaml +++ b/helm/firetail-sensor/values.yaml @@ -33,7 +33,7 @@ env: FIRETAIL_API_URL: "https://api.logging.us-east-2.prod.us.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.prod.us.firetail.app/logs/bulk" - FIRETAIL_KUBERNETES_SENSOR_DEV_MODE: "true" + FIRETAIL_KUBERNETES_SENSOR_DEV_MODE: "false" 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" From 84768fe3684d739583c0ebeb25189ea972f343a5 Mon Sep 17 00:00:00 2001 From: riley priddle Date: Tue, 13 May 2025 19:46:27 +0100 Subject: [PATCH 4/5] fix readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4aefc1a..2862301 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ - API: [https://www.firetail.ai/docs/create-an-api](https://www.firetail.ai/docs/create-an-api) - API Token: [https://www.firetail.ai/docs/create-an-api-token](https://www.firetail.ai/docs/create-an-api-token) - ```git clone https://github.com/FireTail-io/firetail-kubernetes-sensor.git``` -- deploy helm chart ```helm install firetail-sensor firetail-sensor/ --set apiKey="PS-02-XXXXXXXX"``` +- deploy helm chart ```cd helm && helm install firetail-sensor firetail-sensor/ --set apiKey="PS-02-XXXXXXXX"``` ## Environment Variables From 8f0f27fb7ba921f64f5282cd8f2b8cc7ec0fcbfb Mon Sep 17 00:00:00 2001 From: riley priddle Date: Tue, 13 May 2025 19:47:05 +0100 Subject: [PATCH 5/5] dev mode on --- helm/firetail-sensor/values.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/helm/firetail-sensor/values.yaml b/helm/firetail-sensor/values.yaml index 760442c..3bf9bc7 100644 --- a/helm/firetail-sensor/values.yaml +++ b/helm/firetail-sensor/values.yaml @@ -33,7 +33,7 @@ env: FIRETAIL_API_URL: "https://api.logging.us-east-2.prod.us.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.prod.us.firetail.app/logs/bulk" - FIRETAIL_KUBERNETES_SENSOR_DEV_MODE: "false" + 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"