Skip to content

Commit

Permalink
change the method to set the custom headers in the client.go, it allo…
Browse files Browse the repository at this point in the history
…ws now to override the content-type

add warning for smtp and office365

improve notes and warning format

Signed-off-by: Thomas Labarussias <[email protected]>
  • Loading branch information
Issif committed Apr 25, 2024
1 parent d5dccd0 commit 5e64d4e
Show file tree
Hide file tree
Showing 66 changed files with 85 additions and 82 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ It works as a single endpoint for as many as you want `Falco` instances :

`Falcosidekick` manages a large variety of outputs with different purposes.

> **Note**
> [!NOTE]
Follow the links to get the configuration of each output.

### Chat
Expand Down Expand Up @@ -250,7 +250,7 @@ helm repo update
helm install falcosidekick --set config.debug=true falcosecurity/falcosidekick
```

> **Note**
> [!NOTE]
You can also deploy `falcosidekick` as a dependency of the `falco` chart, the settings for the communication between falco and `falcosidekick` are automatically set. Just prefix all `falcosidekick` settings with `falcosidekick.`:
```bash
helm repo add falcosecurity https://falcosecurity.github.io/charts
Expand Down Expand Up @@ -346,7 +346,7 @@ tlsserver:
# - "/healthz"
```

> **Note**
> [!NOTE]
For the confiuration of the outputs, see the [docs](https://github.com/falcosecurity/falcosidekick/blob/master/docs/outputs/).

## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/EXAMPLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| | | | |
| | | | |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/alertmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| `alertmanager.minimumpriority` | `ALERTMANAGER_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |
| `alertmanager.customheaders` | `ALERTMANAGER_CUSTOMHEADERS` | | Custom headers for the POST request |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/aws_cloudwatch_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| `aws.cloudwatchlogs.minimumpriority` | `AWS_CLOUDWATCHLOGS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |


> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -49,7 +49,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

### CloudWatch Logs Sample IAM Policy
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/aws_kinesis.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| `aws.kinesis.streamname` | `AWS_KINESIS_STREAMNAME` | | AWS Kinesis Stream Name, if not empty, Kinesis output is **enabled** |
| `aws.kinesis.minimumpriority` | `AWS_KINESIS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -45,7 +45,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

## Screenshots
4 changes: 2 additions & 2 deletions docs/outputs/aws_lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
| `aws.lambda.functionname` | `AWS_LAMBDA_FUNCTIONNAME` | | Lambda function name, if not empty, AWS Lambda output is **enabled** |
| `aws.lambda.minimumpriority` | `AWS_LAMBDA_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -46,7 +46,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

### Lambda Sample IAM Policy
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/aws_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| `aws.s3.endpoint` | `AWS_S3_ENDPOINT` | | Endpoint URL that overrides the default generated endpoint, use this for S3 compatible APIs |
| `aws.s3.objectcannedacl` | `AWS_S3_OBJECTCANNEDACL` | `bucket-owner-full-control` | Canned ACL (`x-amz-acl`) to use when creating the object |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -51,7 +51,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

## Screenshots
4 changes: 2 additions & 2 deletions docs/outputs/aws_security_lake.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
| `aws.securitylake.batchsize` | `AWS_SECURITYLAKE_BATCHSIZE` | `1000` | Max number of events by parquet file |
| `aws.securitylake.minimumpriority` | `AWS_SECURITYLAKE_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -55,7 +55,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

## Screenshots
4 changes: 2 additions & 2 deletions docs/outputs/aws_sns.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
| `aws.sns.rawjson` | `AWS_SNS_RAWJSON` | `false` | end Raw JSON or parse it |
| `aws.sns.minimumpriority` | `AWS_SNS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -48,7 +48,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

### SNS Sample Policy
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/aws_sqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
| `aws.sqs.url` | `AWS_SQS_URL` | | SQS Queue URL, if not empty, AWS SQS output is **enabled** |
| `aws.sqs.minimumpriority` | `AWS_SQS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -46,7 +46,7 @@ aws:

## Additional info

> **Note**
> [!NOTE]
When using this AWS output you will need to set the AWS keys or role with some permissions.

### SQS Sample IAM Policy
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/azure_event_hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| `azure.eventhub.namespace` | `AZURE_EVENTHUB_NAMESPACE` | | Name of the space the Hub is in |
| `azure.eventhub.minimumpriority` | `AZURE_EVENTHUB_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/cliq.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| `cliq.messageformat` | `CLIQ_MESSAGEFORMAT` | | A Go template to format Cliq Text above Attachment, displayed in addition to the output from `CLIQ_OUTPUTFORMAT`, see [Message Formatting](#message-formatting) in the README for details. If empty, no Text is displayed before Attachment. |
| `cliq.minimumpriority` | `CLIQ_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/cloudevents.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `cloudevents.checkcert` | `CLOUDEVENTS_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `cloudevents.minimumpriority` | `CLOUDEVENTS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -40,7 +40,7 @@ cloudevents:

## Additional info

> **Note**
> [!NOTE]
This output works with [`KNative`](https://knative.dev/).

## Screenshots
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| `datadog.host` | `DATADOG_HOST` | `https://api.datadoghq.com` | Datadog host. Override if you are on the Datadog EU site |
| `datadog.minimumpriority` | `DATADOG_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/discord.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| `discord.ICON` | `DISCORD_ICON` | | Discord icon (avatar) |
| `discord.minimumpriority` | `DISCORD_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/dogstatsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| `dogstastd.namespace` | `DOGSTASTD_NAMESPACE` | `falcosidekick.` | A prefix for all metrics |
| `dogstastd.tags` | `DOGSTASTD_TAGS` | | Comma separeted list of key:value to add as tags to the metrics |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/dynatrace.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| | | | |
| `dynatrace.minimumpriority` | `DYNATRACE_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
| `elasticsearch.checkcert` | `ELASTICSEARCH_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `elasticsearch.minimumpriority` | `ELASTICSEARCH_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/falcosidekick-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| ----------- | ----------- | ------------- | ---------------------------------------------------- |
| `webui.url` | `WEBUI_URL` | | WebUI URL, if not empty, WebUI output is **enabled** |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/fission.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| `fission.checkcert` | `FISSION_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `fission.minimumpriority` | `FISSION_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/gcp_cloud_functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| `gcp.cloudfunctions.name` | `GCP_CLOUDFUNCTIONS_NAME` | | The name of the Cloud Function, if not empty, Google Cloud Functions is **enabled** |
| `gcp.cloudfunctions.minimumpriority` | `GCP_CLOUDFUNCTIONS_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/gcp_cloud_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| `gcp.cloudrun.jwt` | `GCP_CLOUDRUN_JWT` | | Appropriate JWT to invoke the Cloud Function |
| `gcp.cloudrun.minimumpriority` | `GCP_CLOUDRUN_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/gcp_pub_sub.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `gcp.pubsub.customattributes` | `GCP_PUBSUB_CUSTOMATTRIBUTES` | | Custom attributes to add to the Pub/Sub messages |
| `gcp.pubsub.minimumpriority` | `GCP_PUBSUB_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/gcp_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
| `gcp.storage.prefix` | `GCP_STORAGE_PREFIX` | | Prefix, keys will have format: gs://<bucket>/<prefix>/YYYY-MM-DD/YYYY-MM-DDTHH:mm:ss.s+01:00.json |
| `gcp.storage.minimumpriority` | `GCP_STORAGE_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/googlechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `googlechat.messageformat` | `GOOGLECHAT_MESSAGEFORMAT` | | A Go template to format Googlechat Text above Attachment, displayed in addition to the output from `GOOGLECHAT_OUTPUTFORMAT`, see [Message Formatting](#message-formatting) in the README for details. If empty, no Text is displayed before Attachment. |
| `googlechat.minimumpriority` | `GOOGLECHAT_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/gotify.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `gotify.checkcert` | `GOTIFY_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `gotify.minimumpriority` | `GOTIFY_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/outputs/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| `grafana.checkcert` | `GRAFANA_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `grafana.minimumpriority` | `GRAFANA_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand All @@ -46,7 +46,7 @@ grafana:

## Additional info

> **Note**
> [!NOTE]
This output creates annotations.

## Screenshots
2 changes: 1 addition & 1 deletion docs/outputs/grafana_oncall.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `grafanaoncall.checkcert` | `GRAFANAONCALL_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `grafanaoncall.minimumpriority` | `GRAFANAONCALL_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/influxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
| `influxdb.checkcert` | `INFLUXDB_CHECKCERT` | `true` | Check if ssl certificate of the output is valid | `mattermost.minimumpriority` | `MATTERMOST_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""`
| `influxdb.minimumpriority` | `INFLUXDB_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
| `kafka.clientid` | `KAFKA_CLIENTID` | | Specify a client.id when communicating with the broker for tracing |
| `kafka.minimumpriority` | `KAFKA_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/outputs/kafkarest.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| `kafkarest.checkcert` | `KAFKAREST_CHECKCERT` | `true` | Check if ssl certificate of the output is valid |
| `kafkarest.minimumpriority` | `KAFKAREST_MINIMUMPRIORITY` | `""` (= `debug`) | Minimum priority of event for using this output, order is `emergency,alert,critical,error,warning,notice,informational,debug or ""` |

> **Note**
> [!NOTE]
The Env var values override the settings from yaml file.

## Example of config.yaml
Expand Down
Loading

0 comments on commit 5e64d4e

Please sign in to comment.