Skip to content

Add section on generate-metadata and generate-listing commands #3721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rh-max wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add section on generate-metadata and generate-listing commands #3721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1d8209
Add section on generate-metadata and generate-listing commands
rh-max Mar 10, 2025
3521a3e
Implement feedback from review
rh-max Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions guides/common/assembly_synchronizing-content-between-servers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ include::modules/proc_using-upstream-server-to-sync-content-view-versions.adoc[l

include::modules/proc_synchronizing-a-single-repository.adoc[leveloffset=+2]

include::modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc[leveloffset=+2]

include::modules/proc_synchronizing-a-custom-repository.adoc[leveloffset=+1]

include::modules/proc_exporting-the-library-environment.adoc[leveloffset=+1]
Expand Down
27 changes: 27 additions & 0 deletions ...on/modules/proc_generating-metadata-and-listing-files-for-syncable-exports.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[id="generating-metadata-and-listing-files-for-syncable-exports"]
= Generating metadata and listing files for syncable exports

When exporting content in a syncable format, metadata and listing files are generated automatically.
Copy link
Contributor

@Lennonka Lennonka Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When exporting content in a syncable format, metadata and listing files are generated automatically.
When you export content in a syncable format, {Project} generates metadata and listing files automatically.

Avoid passive voice

However, you must manually trigger the generation of these files in the following circumstances:
Copy link
Contributor

@Lennonka Lennonka Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
However, you must manually trigger the generation of these files in the following circumstances:
Trigger the generation of these files manually under the following circumstances:

Reducing fluff.

Any of the circumstances or all of them at once?


* When a non-root user is doing the export.
* When the `--async` flag has been passed, for root or non-root user.
* When using the {Project} API or Ansible modules to do the exports.

.Prerequisites
* The syncable export directory is accessible on disk.
Copy link
Contributor

@Lennonka Lennonka Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The syncable export directory is accessible on disk.
* You can access the syncable export directory for writing.

Avoid passive voice + clarity


.Procedure
. Generate metadata for a syncable export:
+
[options="nowrap" subs="+quotes"]
----
$ hammer content-export generate-metadata --path=/path/to/syncable/export
Copy link
Contributor

@maximiliankolb maximiliankolb Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this command on Foreman/Katello 3.14/4.16 but failed:

$ hammer content-export complete repository --organization "Example" --product-id 6 --name "Client" --format=syncable
$ rm -fr /var/lib/pulp/exports/Example/Export-SYNCABLE-Client-40/2.0/2025-06-30T09-04-45-00-00/custom/AlmaLinux_10/Client/repodata/
$ hammer content-export generate-metadata --path=/var/lib/pulp/exports/Example/Export-SYNCABLE-Client-40/2.0/2025-06-30T09-04-45-00-00/
Error: Unrecognised option '--path'.

See: 'hammer content-export generate-metadata --help'.
$ rpm -qa "rubygem-hammer_cli_katello"
rubygem-hammer_cli_katello-1.16.1-1.el9.noarch

Refs SPEC file Hammer CLI plugin for katello

I also checked on Foreman 3.15/Katello 4.17, neither generate-metadata nor generate-listing commands have the --path option.

----

. Generate listing files for a syncable export directory:
+
[options="nowrap" subs="+quotes"]
----
$ hammer content-export generate-listing --path=/path/to/syncable/export
----