Issue #6958: pulp_installer doesn't document required variables correctly or provide clear errors if they are unset - Pulp

Actions

Send by e-mail Copy link

Issue #6958

closed

pulp_installer doesn't document required variables correctly or provide clear errors if they are unset

Added by mdepaulo@redhat.com almost 4 years ago. Updated almost 4 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

mdepaulo@redhat.com

Category:

Installer - Moved to GitHub issues

Sprint/Milestone:

3.5.0

Start date:

Due date:

Estimated time:

Severity:

2. Medium

Version:

Platform Release:

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

Tags:

Documentation

Sprint:

Sprint 75

Quarter:

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.

Actions

Copy link

Updated by pulpbot almost 4 years ago

Status changed from NEW to POST

PR: https://github.com/pulp/pulp_installer/pull/328

Actions

Copy link

Updated by pulpbot almost 4 years ago

PR: https://github.com/pulp/pulp_installer/pull/329

Actions

Copy link

Updated by dkliban@redhat.com almost 4 years ago

Triaged changed from No to Yes
Sprint set to Sprint 75

Added by Mike DePaulo almost 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: ""

Added by Mike DePaulo almost 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: ""

Actions

Copy link