Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command line option to list active config parameters #3456

Open
mmattel opened this issue Apr 4, 2022 · 9 comments
Open

Command line option to list active config parameters #3456

mmattel opened this issue Apr 4, 2022 · 9 comments
Labels
Category:Enhancement Add new functionality

Comments

@mmattel
Copy link
Contributor

mmattel commented Apr 4, 2022

Is your feature request related to a problem? Please describe.

Identified when documenting ocis config.

When reading the dev docs about the configuration arithemtics, you get a clear warning that if you do not take very much care, a misconfiguration can sneak in resulting in a different behaviour than expected. This can happen because of the way a final configuration gets assembled (the configuration arithmetics) out of different yaml files. The issue is, that you have a bunch of yaml files, but currently you cant tell how the final assembled configuration looks like.

Describe the solution you'd like

Have a command line option when calling ocis like --print-config which prints the final assembled and active configuration. It would be beneficial if such a print out is seperated by comments based on which extension it belongs.

Describe alternatives you've considered

There is no alternative.

Additional context

Points to be considered:

  1. This is benificial when you want to review your final config AND
    you can export the config for testing purposes
  2. Any secret parameters need to stay secret - like we do in classic server when printing the config
  3. Needs documentation in dev docs and in docs-ocis

Note, please file a docs-ocis issue when this gets implemented so we can update the documentation accordingly.

@butonic @wkloucek @dragonchaser (as discussed) @micbar @pmaier1
@EParzefall fyi

@mmattel mmattel added the Category:Enhancement Add new functionality label Apr 4, 2022
@wkloucek
Copy link
Contributor

wkloucek commented Apr 6, 2022

see also #2672

@dragonchaser
Copy link
Contributor

Ok #3646 is a duplicate, it would be nice to take over the auto redaction I described there.

@stale
Copy link

stale bot commented Jul 2, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 10 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status:Stale label Jul 2, 2022
@mmattel
Copy link
Contributor Author

mmattel commented Jul 2, 2022

dont close

@stale stale bot closed this as completed Jul 14, 2022
@mmattel
Copy link
Contributor Author

mmattel commented Jul 14, 2022

bot, reopen

@mmattel mmattel reopened this Jul 14, 2022
@stale stale bot removed Status:Stale labels Jul 14, 2022
@d7oc
Copy link
Contributor

d7oc commented Apr 20, 2023

@micbar @kobergj Would it be possible to include this? This feature would have same us some time in today's debugging session as this would have shows directly that the policies service has not correctly read his config part.

@wkloucek
Copy link
Contributor

@micbar @kobergj Would it be possible to include this? This feature would have same us some time in today's debugging session as this would have shows directly that the policies service has not correctly read his config part.

The "proxy" service already has a config report http endpoint. Others are not implementing it.

@mmattel
Copy link
Contributor Author

mmattel commented Apr 21, 2023

The "proxy" service already has a config report http endpoint. Others are not implementing it.

Means we have some action points:

  • Implement the config report http endpoint in all services where missing.
  • Add this task to the "new service" documentation in owncloud.dev.
  • Per service documentation in the readme's.

@wkloucek
Copy link
Contributor

The "proxy" service already has a config report http endpoint. Others are not implementing it.

Means we have some action points:

  • Implement the config report http endpoint in all services where missing.
  • Add this task to the "new service" documentation in owncloud.dev.
  • Per service documentation in the readme's.

Don't know if it was agreed that this http endpoint on the debug server of the proxy is the way to go for all other services. I think this was more of a POC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category:Enhancement Add new functionality
Projects
None yet
Development

No branches or pull requests

4 participants