Issue #6958
closedpulp_installer doesn't document required variables correctly or provide clear errors if they are unset
Description
I am using a single issue for the playbook changes, default settings changes, and the docs changes.
Problems include:
-
Sometimes a role README's say variable pulp_default_admin_password has a default value of "password", other times we do not specify that it does.
-
The docs seem to imply that the empty dict for pulp_install_plugins is OK. The installer will actually fail, and pulpcore is incapable of functioning without 1 content plugin installed.
-
Sometimes the default value is an empty string or dict, which is just as bad as no default value, but even more explicit & verbose.
-
The error messages are the default provided by ansible, and therefore unclear to novice users with no pointers.
-
The failed tasks occur well into the middle of the install for some variables, rather than at the very beginning.
Updated by pulpbot about 4 years ago
- Status changed from NEW to POST
Updated by pulpbot about 4 years ago
Updated by dkliban@redhat.com about 4 years ago
- Triaged changed from No to Yes
- Sprint set to Sprint 75
Added by Mike DePaulo about 4 years ago
Added by Mike DePaulo about 4 years ago
Revision ea408130 | View on GitHub
problem: pulp_installer doesn't document required variables
correctly or provide clear errors if they are unset
Solution:
- Error early if they are null, unset an empty string, or an empty dict with a clearer error message.
- Remove pointless setting of some to empty values.
- Correct the documentation: They have no default values.
fixes: #6958
Test vars:
pulp_install_plugins: {}
# galaxy-ng: {}
# pulp-ansible: {}
# pulp-certguard: {}
# pulp-container: {}
# pulp-cookbook: {}
# pulp-deb: {}
# pulp-file: {}
# pulp-gem: {}
# pulp-maven: {}
# pulp-npm: {}
# pulp-python: {}
# pulp-rpm:
# prereq_role: "pulp.pulp_rpm_prerequisites" # RPM needs a prereq_role: https://galaxy.ansible.com/pulp/pulp_rpm_prerequisites
pulp_settings:
secret_key:
content_origin: ""
Updated by Anonymous about 4 years ago
- Status changed from POST to MODIFIED
Applied in changeset ansible-pulp|ea4081300aa9993aaac2ca21f38082d3cf6b88d4.
Updated by Anonymous about 4 years ago
Applied in changeset ansible-pulp3|ea4081300aa9993aaac2ca21f38082d3cf6b88d4.
Updated by fao89 about 4 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
problem: pulp_installer doesn't document required variables
correctly or provide clear errors if they are unset
Solution:
fixes: #6958
Test vars: