Documentation relating to Directory Structure & File Systems

[fao89]

Author: wibbit (wibbit)

Redmine Issue: 8297, https://pulp.plan.io/issues/8297

---

Good morning all.

TLDR: Should the documentation be updated to reference DEPLOY_ROOT, and recommend that it is on a single partition, further ammendments to MEDIA_ROOT, WORKING_DIRECTORY, CHUNKED_UPLOAD_DIR, STATIC_ROOT or FILE_UPLOAD_TEMP_DIR are limited/restrictred to where it's actually pertinent and detailed information as to why you might choose to make that change with associated risks and caveats supplied where appropriate for that deployment style.

And the rest...

Re-reading the installation instructions and settings for Pulp3, I think there is a hole in relation to recommended partition layout, and associated settings.

We appear to have 3 documented variables (suggesting, that these are things we want to consider setting)

MEDIA_ROOT '/var/lib/pulp/media'
WORKING_DIRECTORY PosixPath('/var/lib/pulp/tmp')
CHUNKED_UPLOAD_DIR 'upload'

Being the curious fellow that I am, looking through dynaconf I also find the following variables.

DEPLOY_ROOT PosixPath('/var/lib/pulp')
STATIC_ROOT PosixPath('/var/lib/pulp/assets')
FILE_UPLOAD_TEMP_DIR PosixPath('/var/lib/pulp/tmp')

This appears to indicate the following layout.

/var/lib/pulp
/var/lib/pulp/assets
/var/lib/pulp/media/
/var/lib/pulp/media/??? (artifacts? 1TB on my current test install)
/var/lib/pulp/media/upload
/var/lib/pulp/tmp

The below note recommends MEDIA_ROOT and WORKING_DIRECTORY share the same filesystem.

https://docs.pulpproject.org/pulpcore/settings.html#working-directory

The only other "documentation" that I can find is https://pulp.plan.io/issues/7178

This suggests that there is an expectation that at a minimum DEPLOY_ROOT is a single partition, sized appropriately to store all of pulp's content.

I'm purprosefully ignoring the question of whether CHUNKED_UPLOAD, WORKING_DIRECTORY or FILE_UPLOAD_TEMP_DIR would not be better suited to /var/spool or /var/cache