Project

Profile

Help

Issue #3618

Issue #3981: Switch Pulp3 settings to Dynaconf

database configuration docs are confusing

Added by jsherril@redhat.com about 2 years ago. Updated about 1 month ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
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 almost 2 years 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 almost 2 years 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 about 2 years ago

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

#2 Updated by dalley about 2 years ago

  • Sprint deleted (Sprint 36)

#3 Updated by bmbouter about 2 years 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 almost 2 years ago

  • Parent task set to #3981

#5 Updated by amacdona@redhat.com almost 2 years ago

  • Sprint set to Sprint 43

#6 Updated by bmbouter almost 2 years ago

  • Sprint deleted (Sprint 43)

This will be resolved by the epic 3981.

#7 Updated by dkliban@redhat.com almost 2 years ago

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

#8 Updated by Anonymous almost 2 years ago

  • Status changed from POST to MODIFIED

#9 Updated by daviddavis about 1 year ago

  • Sprint/Milestone set to 3.0.0

#10 Updated by bmbouter about 1 year ago

  • Tags deleted (Pulp 3)

#11 Updated by bmbouter 7 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

#12 Updated by bmbouter about 1 month ago

  • Category deleted (23)

Please register to edit this issue

Also available in: Atom PDF