|
1 | 1 | # Firetail Kubernetes Sensor
|
2 | 2 |
|
3 |
| -POC for a FireTail Kubernetes Sensor. |
4 |
| - |
| 3 | +## Deployment |
5 | 4 |
|
| 5 | +- Create an API & API Key on the FireTail Platform |
| 6 | +- API: [https://www.firetail.ai/docs/create-an-api](https://www.firetail.ai/docs/create-an-api) |
| 7 | +- API Token: [https://www.firetail.ai/docs/create-an-api-token](https://www.firetail.ai/docs/create-an-api-token) |
| 8 | +- ```git clone https://github.com/FireTail-io/firetail-kubernetes-sensor.git``` |
| 9 | +- deploy helm chart ```cd helm && helm install firetail-sensor firetail-sensor/ --set apiKey="PS-02-XXXXXXXX"``` |
6 | 10 |
|
7 | 11 | ## Environment Variables
|
8 | 12 |
|
9 |
| -| Variable Name | Required? | Example | Description | |
10 |
| -| ----------------------------------------------- | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | |
11 |
| -| `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 | |
| 13 | +| Variable Name | Required? | Example | Description | |
| 14 | +| ----------------------------------------------- | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | |
| 15 | +| `FIRETAIL_API_TOKEN` | ✅ | `PS-02-XXXXXXXX` | The API token the sensor will use to report logs to FireTail | |
12 | 16 | | `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 |
|
13 | 17 | | `MAX_CONTENT_LENGTH` | ❌ | `1048576` | The sensor will only read request or response bodies if their length is less than `MAX_CONTENT_LENGTH` bytes. |
|
14 | 18 | | `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. |
|
@@ -46,16 +50,6 @@ After a few seconds, you should see logs appear in the FireTail SaaS platform.
|
46 | 50 |
|
47 | 51 |
|
48 | 52 |
|
49 |
| -## Publishing to ECS |
50 |
| - |
51 |
| -Authenticate and then use the `publish` target in [the provided makefile](./Makefile) to login to ECS, tag the image and push it: |
52 |
| - |
53 |
| -```bash |
54 |
| -ftauth |
55 |
| -make publish VERSION=latest |
56 |
| -``` |
57 |
| - |
58 |
| - |
59 | 53 |
|
60 | 54 | ## Publishing to GHCR
|
61 | 55 |
|
|
0 commit comments