Update config parameters #120

sanfern · 2022-09-30T18:32:24Z

Updating sample config file and updating the document link. This l3afd.cfg is an example for prod config deployment.

Signed-off-by: sanfern [email protected]

Signed-off-by: sanfern <[email protected]> Signed-off-by: sferna1 <[email protected]>

jniesz

Lets add in the PR notes this is meant to be example prod deployment config options.

config/l3afd.cfg

Signed-off-by: sferna1 <[email protected]>

jniesz

I left comments on several of the config options. Also we need to update the configdoc.md for the below items:
L3afConfigsRestAPIAddr - update docs to say this is optional

KFRepoURL - update docs to say this is required
KFPollInterval - update docs to say this is optional
NMetricSamples - update docs to say this is optional

XDPRootProgram* - update docs to say these are optional
TCRootProgram* - update docs to say these are optional

EBPFChainDebugAddr - missing doc for this option
EBPFChainDebugEnabled - missing doc for this option

MTLSEnabled - update docs to say this is optional (default: true)
MTLSCACertFilename - update docs to say this is optional
MTLSServerCertFilename - update docs to say this is optional
MTLSServerKeyFilename - update docs to say this is optional

XDPRootProgramUserProgramDaemon - need to remove from docs
TCRootProgramUserProgramDaemon - need to remove from docs

config/config.go

config/l3afd.cfg

Signed-off-by: sferna1 <[email protected]>

dthaler · 2022-10-05T16:58:16Z

docs/configdoc.md

+|kf-poll-interval|`"30s"`|Periodic interval at which to scrape metrics using Prometheus| No       |
+|n-metric-samples|`"20"`|Number of Metric Samples| No       |


Shouldn't we say that the "example" values are the default values used?

I think changing example to default makes sense and instead of giving example on each config option here we can point to the complete example config.

dthaler · 2022-10-05T16:59:43Z

docs/configdoc.md

+| FieldName     | Example       | Description     | Required |
+| ------------- | ------------- | --------------- |----------|
+|enabled| `"true"` | Boolean to check mtls enabled or not on REST API exposed by l3afd| No       |


dthaler · 2022-10-05T17:00:08Z

docs/configdoc.md

+|enabled| `"true"` | Boolean to check mtls enabled or not on REST API exposed by l3afd| No       |
+|min-tls-version|`"1.3"`| Minimum tls version allowed| No       |
+|cert-dir|`"/etc/l3af/certs"`|Absolute path of ca certificates. On Linux this points to a filesystem directory, but on Windows it can point to [certificate store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores) | No       |


Suggested change

|cert-dir|`"/etc/l3af/certs"`|Absolute path of ca certificates. On Linux this points to a filesystem directory, but on Windows it can point to [certificate store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores) | No |

|cert-dir|`"/etc/l3af/certs"`|Absolute path of CA certificates. On Linux this points to a filesystem directory, but on Windows it can point to a [certificate store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores) | No |

Signed-off-by: sferna1 <[email protected]>

jniesz

We should also update the sections for the kernel version something like:

|kernel-major-version|"4"|Major version of the kernel required to run eBPF programs (Linux Only)| No |
|kernel-minor-version|"15"|Minor version of the kernel required to run eBPF programs (Linux Only)| No |

jniesz · 2022-10-19T22:11:55Z

docs/configdoc.md

@@ -1,6 +1,6 @@
 # L3AFD Config Options Documentation

-See [l3afd.cfg](https://github.com/l3af-project/l3af-arch/blob/main/dev_environment/cfg/l3afd.cfg) for a full example configuration.
+See [l3afd.cfg](https://github.com/l3af-project/l3afd/blob/main/config/l3afd.cfg) for a full example configuration.


lets convert this to relative link since it references file in same repo

I think this got missed in your last commit

jniesz · 2022-10-19T22:14:07Z

docs/configdoc.md

-|restapi-addr|`"localhost:53000"`| Hostname and Port of l3af-configs REST API | Yes |
+| FieldName     | Default       | Description     | Required |
+| ------------- | ------------- | --------------- |----------|
+|restapi-addr|`"localhost:53000"`| Hostname and Port of l3af-configs REST API | No       |

 # [l3af-config-store]


should be heading2 "##" similar to above

jniesz · 2022-10-19T22:14:11Z

docs/configdoc.md


 # [l3af-config-store]
-| FieldName     | Example       | Description     | Required        |
+| 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]


should be heading2 "##" similar to above

jniesz · 2022-10-19T22:18:22Z

docs/configdoc.md

-| FieldName     | Example       | Description     | Required        |
-| ------------- | ------------- | --------------- | --------------- |
-|url| `"http://localhost:8000/"`|Default repository from which to download eBPF packages| No |
+| FieldName     | Example       | Description     | Required |


Please change heading "Example" to "Default" to match the format below. We should do this for all sections.

Signed-off-by: sferna1 <[email protected]>

jniesz

LGTM

* Update config parameters Signed-off-by: Santhosh Fernandes <[email protected]> Co-authored-by: Jason Niesz <[email protected]>

sanfern requested review from charleskbliu0, jniesz and dthaler as code owners September 30, 2022 18:32

Update config parameters

8bf64aa

Signed-off-by: sanfern <[email protected]> Signed-off-by: sferna1 <[email protected]>

sanfern force-pushed the sanfern-dev-config-update branch from 08786ea to 8bf64aa Compare September 30, 2022 18:33

jniesz reviewed Sep 30, 2022

View reviewed changes

config/l3afd.cfg Outdated Show resolved Hide resolved

update review comments

a00c81a

Signed-off-by: sferna1 <[email protected]>

jniesz reviewed Oct 3, 2022

View reviewed changes

config/l3afd.cfg Outdated Show resolved Hide resolved

jniesz reviewed Oct 3, 2022

View reviewed changes

config/l3afd.cfg Outdated Show resolved Hide resolved

sanfern force-pushed the sanfern-dev-config-update branch from 60fda53 to e40337c Compare October 4, 2022 17:54

updatre review comments

20d3dfb

Signed-off-by: sferna1 <[email protected]>

sanfern force-pushed the sanfern-dev-config-update branch from e40337c to 20d3dfb Compare October 4, 2022 18:08

jniesz added the breaking-change label Oct 4, 2022

dthaler reviewed Oct 5, 2022

View reviewed changes

sanfern removed the breaking-change label Oct 6, 2022

sanfern added 2 commits October 6, 2022 21:53

update review comments

c502c67

Signed-off-by: sferna1 <[email protected]>

Merge branch 'main' into sanfern-dev-config-update

451e454

jniesz reviewed Oct 19, 2022

View reviewed changes

Update review comments

caaf361

Signed-off-by: sferna1 <[email protected]>

sanfern force-pushed the sanfern-dev-config-update branch from 9fd4713 to caaf361 Compare October 25, 2022 15:28

jniesz approved these changes Oct 25, 2022

View reviewed changes

charleskbliu0 approved these changes Oct 26, 2022

View reviewed changes

jaysheth2 approved these changes Oct 26, 2022

View reviewed changes

sanfern merged commit b2c9249 into l3af-project:main Oct 26, 2022

sanfern added a commit to sanfern/l3afd that referenced this pull request Mar 6, 2023

Update config parameters (l3af-project#120)

ff0fdc7

* Update config parameters Signed-off-by: Santhosh Fernandes <[email protected]> Co-authored-by: Jason Niesz <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update config parameters #120

Update config parameters #120

sanfern commented Sep 30, 2022 •

edited

Loading

jniesz left a comment

jniesz left a comment

dthaler Oct 5, 2022

jniesz Oct 5, 2022

dthaler Oct 5, 2022

dthaler Oct 5, 2022

jniesz left a comment

jniesz Oct 19, 2022

jniesz Oct 25, 2022

jniesz Oct 19, 2022

jniesz Oct 19, 2022

jniesz Oct 19, 2022

jniesz left a comment

		\|kf-poll-interval\|`"30s"`\|Periodic interval at which to scrape metrics using Prometheus\| No \|
		\|n-metric-samples\|`"20"`\|Number of Metric Samples\| No \|

	\|enabled\| `"true"` \| Boolean to check mtls enabled or not on REST API exposed by l3afd\| No \|
	\|enabled\| `"true"` \| Boolean controlling whether mTLS is enabled or not on the REST API exposed by l3afd\| No \|

	\|cert-dir\|`"/etc/l3af/certs"`\|Absolute path of ca certificates. On Linux this points to a filesystem directory, but on Windows it can point to [certificate store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores) \| No \|
	\|cert-dir\|`"/etc/l3af/certs"`\|Absolute path of CA certificates. On Linux this points to a filesystem directory, but on Windows it can point to a [certificate store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores) \| No \|

Update config parameters #120

Update config parameters #120

Conversation

sanfern commented Sep 30, 2022 • edited Loading

jniesz left a comment

Choose a reason for hiding this comment

jniesz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jniesz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jniesz left a comment

Choose a reason for hiding this comment

sanfern commented Sep 30, 2022 •

edited

Loading