Project

Profile

Help

Issue #8552

closed

Issue #8477: As a new Pulp user, I would like well-described getting started information about using the Pulp installer

pulp_installer docs need a better explanation of variables

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

Status:
MODIFIED
Priority:
Normal
Category:
Installer - Moved to GitHub issues
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:
Quarter:

Description

mcorr: The next section is titled Variables https://pulp-installer.readthedocs.io/en/latest/#variables. Nowhere does it tell users why this is the second topic in the Installer guide. I propose we change this to "Customizing your installation to suit your environment" and give a list of popular and known changes that you can pass through to the Ansible installer via the variables. In this way, the user has been inspired to think about possible options they might need.

mikedep333: I suggest we make this an entire page. It should list:

  1. Note on how Ansible lets you specify variables in multiple ways, and how we use files/playbooks in the example.
  2. Explanation of customization variables (like pulp_install_plugins) vs accommodating IT environments variables (like firewall)
  3. Move the "Recommended Workflows for Pulpcore & Plugin Versioning" section to it.
  4. List the most commonly used vars, with some examples
  5. Reference the roles for more info.
  6. Clarify pulp_settings vs other vars. And that users using the installer should only set pulp-settings via the installer.
Actions #1

Updated by mdepaulo@redhat.com almost 3 years ago

  • Description updated (diff)
Actions #2

Updated by mdepaulo@redhat.com almost 3 years ago

  • Description updated (diff)
Actions #3

Updated by mdepaulo@redhat.com almost 3 years ago

  • Triaged changed from No to Yes
Actions #4

Updated by mdepaulo@redhat.com almost 3 years ago

  • Subject changed from pulp_installer docs needs a better explanation of variables to pulp_installer docs need a better explanation of variables

Added by Mike DePaulo almost 3 years ago

Revision 38f309a5 | View on GitHub

pulp_installer docs need a better explanation of variables

Also moved Object Storage into a seperate doc.

fixes: #8552 https://pulp.plan.io/issues/8552

Added by Mike DePaulo almost 3 years ago

Revision 38f309a5 | View on GitHub

pulp_installer docs need a better explanation of variables

Also moved Object Storage into a seperate doc.

fixes: #8552 https://pulp.plan.io/issues/8552

Actions #5

Updated by Anonymous almost 3 years ago

  • Status changed from NEW to MODIFIED
Actions #6

Updated by dalley almost 3 years ago

  • Sprint/Milestone set to 3.13.0

Also available in: Atom PDF