pulp / pulp/pulpcore

Document what actions cause change under /var/lib/pulp

Open
#2,809 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Task
Dominant language
Python
Stars
598
Forks
168
Avg merge
1d 4h
Merged PRs (30d)
86

Description

Main questions for documentation:

  1. What are the actions that cause files to change under /var/lib/pulp?
  2. What files change due to these actions?

For context, in Foreman+Katello, users may opt to use our online backup via Foreman Maintain. During online backup, if Foreman Maintain detects file changes under /var/lib/pulp, the directory is re-archived (https://github.com/theforeman/foreman_maintain/blob/master/definitions/procedures/backup/pulp.rb#L60). It would be helpful for users to know what content actions in Katello can trigger these changes.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by investigating which Katello content actions change files under /var/lib/pulp and which files each action affects. Use Foreman Maintain's definitions/procedures/backup/pulp.rb as context for the re-archive behavior, then document the action-to-file relationships so users can understand when an online backup is triggered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.