diff --git a/docs/configdoc.md b/docs/configdoc.md index c6ba4e304..d26172b77 100644 --- a/docs/configdoc.md +++ b/docs/configdoc.md @@ -27,7 +27,7 @@ environment: PROD ## [l3afd] -| FieldName | Example | Description | Required | +| FieldName | Default | Description | Required | | ------------- | ------------- | --------------- | --------------- | |pid-file| `"./l3afd.pid"` | The path to the l3afd.pid file which contains process id of L3afd | Yes | |datacenter| `"dummy"` | Name of Datacenter| Yes | @@ -44,13 +44,13 @@ environment: PROD |BpfMapDefaultPath|`"/sys/fs/bpf"`|The base pin path for eBPF maps| Yes | ## [kf-repo] -| FieldName | Example | Description | Required | +| FieldName | Default | Description | Required | | ------------- | ------------- | --------------- |----------| |url| `"http://localhost:8000/"`|Default repository from which to download eBPF packages| Yes | ## [web] -| FieldName | Example | Description | Required | +| FieldName | Default | Description | Required | | ------------- | ------------- | --------------- |----------| |metrics-addr|`"0.0.0.0:8898"`|Prometheus endpoint for pulling/scraping the metrics. For more info about Prometheus see [prometheus.io](https://prometheus.io/) | Yes | |kf-poll-interval|`"30s"`|Periodic interval at which to scrape metrics using Prometheus| No | @@ -60,7 +60,7 @@ environment: PROD ## [xdp-root-program] This section is needed when bpf-chaining-enabled is set to true. -| FieldName | Example | Description | Required | +| FieldName | Default | Description | Required | | ------------- | ------------- | --------------- | --------------- | |name|`"xdp-root"`|Name of subdirectory in which to extract artifact| Yes | |artifact|`"xdp-root.tar.gz"`|Filename of xdp-root package. Only tar.gz and .zip formats are supported| Yes | @@ -91,12 +91,12 @@ This section is needed when bpf-chaining-enabled is set to true. | ------------- | ------------- | --------------- |----------| |restapi-addr|`"localhost:53000"`| Hostname and Port of l3af-configs REST API | No | -# [l3af-config-store] +## [l3af-config-store] | FieldName | Default | Description | Required | | ------------- | ------------- | --------------- | --------------- | |filename|`"/etc/l3afd/l3af-config.json"`|Absolute path of persistent config file where we are storing L3afBPFPrograms objects. For more info see [models](https://github.com/l3af-project/l3afd/blob/main/models/l3afd.go)| Yes | -# [mtls] +## [mtls] | FieldName | Default | Description | Required | | ------------- | ------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| |enabled| `"true"` | Boolean controlling whether mTLS is enabled or not on the REST API exposed by l3afd | No |