Project

Profile

Help

Issue #3618

Issue #3981: Switch Pulp3 settings to Dynaconf

database configuration docs are confusing

Added by jsherril@redhat.com over 1 year ago. Updated 8 months ago.

Status:
MODIFIED
Priority:
Normal
Category:
Documentation
Sprint/Milestone:
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

The install docs here:

say: Databases can be configed in the databases section of your server.yaml. See the Django database settings documentation for more information on setting the databases values in settings.yam

Yet the syntax presented in the django documentation is different than that in server.yaml. The differences include commas vs no commas, quotes vs no quotes, (yaml vs python) and there seems to be an OPTIONS hash in the example that isn't used for postgresql but is used for sqlite?

Some of this may be less confusing when the defaults are closer to what i wanted (i.e. postgresql), but if the syntax isn't the same i'd suggest not relying on django docs.

Associated revisions

Revision e1fcdda1 View on GitHub
Added by Bruno Rocha about 1 year ago

Problem: Pulp can't be configured using environment variables

Solution: use dynaconf to manage all of Pulp configuration settings

This patch also adds pulpcore.rqconfig module that is dynamically generated from the Django settings
generated by dynaconf. The rq workers use this module for their configuration.

The default location of the config file is now at `/etc/pulp/settings.py`. Pulp can operate without by relying
on environment variables.

closes: #3981
https://pulp.plan.io/issues/3981

closes: #3879
https://pulp.plan.io/issues/3879

closes: #3980
https://pulp.plan.io/issues/3980

closes #3618
https://pulp.plan.io/issues/3618

closes: #3943
https://pulp.plan.io/issues/3943

Revision e1fcdda1 View on GitHub
Added by Bruno Rocha about 1 year ago

Problem: Pulp can't be configured using environment variables

Solution: use dynaconf to manage all of Pulp configuration settings

This patch also adds pulpcore.rqconfig module that is dynamically generated from the Django settings
generated by dynaconf. The rq workers use this module for their configuration.

The default location of the config file is now at `/etc/pulp/settings.py`. Pulp can operate without by relying
on environment variables.

closes: #3981
https://pulp.plan.io/issues/3981

closes: #3879
https://pulp.plan.io/issues/3879

closes: #3980
https://pulp.plan.io/issues/3980

closes #3618
https://pulp.plan.io/issues/3618

closes: #3943
https://pulp.plan.io/issues/3943

History

#1 Updated by dalley over 1 year ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 36
  • Tags Documentation added

#2 Updated by dalley over 1 year ago

  • Sprint deleted (Sprint 36)

#3 Updated by bmbouter over 1 year ago

I agree with the issue, it's confusing with the syntax differences. Here are two options, can someone comment on these or if another one would be better?

One option

1. Add a section that talks about the server.yaml file and explains that it "overlay's" onto a settings file. It would not go into details about what any given setting does.
2. Explain the syntax differences when overlaying?
3. Point to the django docs.

Another option is to switch the settings.yaml to settings.py somehow.

#4 Updated by bmbouter over 1 year ago

  • Parent task set to #3981

#5 Updated by amacdona@redhat.com about 1 year ago

  • Sprint set to Sprint 43

#6 Updated by bmbouter about 1 year ago

  • Sprint deleted (Sprint 43)

This will be resolved by the epic 3981.

#7 Updated by dkliban@redhat.com about 1 year ago

  • Status changed from NEW to POST
  • Assignee set to dkliban@redhat.com

#8 Updated by Anonymous about 1 year ago

  • Status changed from POST to MODIFIED

#9 Updated by daviddavis 8 months ago

  • Sprint/Milestone set to 3.0

#10 Updated by bmbouter 8 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF