Issue #5304
closedPulp 3 publishes metadata outside of artifact storage
Description
The initial bug report has led to the identification of the following problems:
- pulp 3 cannot create PublishedMetadata files in /var/lib/pulp/published/ because POSIX permissions prevent it on a machine where Pulp 2 has already published content
- PublishedMetadata are the only files that are stored in /var/lib/pulp/published, everything else is stored in /var/lib/pulp/artifact
- Plugin API provides 2 ways to represent content: Content (made up of Artifacts) and PublishedMetadata
- content app has two code paths for serving PublishedMetada and Content
- metadata that is mirrored exactly as published is represented as a Content model and the same metadata generated by Pulp is represented as PublishedArtifcat
- any code that exports a publication to a filesystem needs to have 2 code paths to export the contents of a publication
The solution to all these problems is to make PublishedMetadata inherit from Content. This way the artifact backing the PublishedMetadata would be stored in artifact storage. The plugin writer experience can be simplified by providing a constructor that allows the plugin writer to pass in a file, a relative path, and a publication. The creation of Artifact, ContentArtifact, and PublishedArtifact is handled by the constructor. The constructor will also save the PublishedMetada to the database.
Here is some example code from the publish task in the File plugin:
with WorkingDirectory():
with FilePublication.create(repo_version, pass_through=True) as publication:
manifest = Manifest(manifest)
manifest.write(populate(publication))
metadata = PublishedMetadata(
relative_path=os.path.basename(manifest.relative_path),
publication=publication,
file=File(open(manifest.relative_path, "rb")),
)
metadata.save()
So the only difference for the plugin writer will be not having to call save():
with WorkingDirectory():
with FilePublication.create(repo_version, pass_through=True) as publication:
manifest = Manifest(manifest)
manifest.write(populate(publication))
metadata = PublishedMetadata(
relative_path=os.path.basename(manifest.relative_path),
publication=publication,
file=File(open(manifest.relative_path, "rb"))
)
The orphan cleanup query needs to be updated to consider content that is part of a publication to not be considered orphaned.
Related issues
Switch to using PublishedMetada.create_from_file()
Required PR: https://github.com/pulp/pulpcore/pull/303
re: #5304 https://pulp.plan.io/issues/5304