Uploaded image for project: 'Satellite'
  1. Satellite
  2. SAT-24915

No documentation of generate-metadata or generate-listing commands in the Content Export documentation sections

XMLWordPrintable

    • Important
    • No Coverage
    • No

      Document URL:

      https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/managing_content/index#Synchronizing_Content_Between_Servers_content-management

      Section Number and Name:

      9.3. Exporting the Library Environment
      9.4. Exporting the Library Environment in a Syncable Format
      9.6. Exporting the Library Environment Incrementally
      9.7. Exporting the Library Environment Incrementally in a Syncable Format
      9.8. Exporting a Content View Version
      9.9. Exporting a Content View Version in a Syncable Format
      9.10. Exporting a Content View Version Incrementally
      9.11. Exporting a Content View Version Incrementally in a Syncable Format

      etc

      Describe the issue:

      There are two types of export format present i.e. importable and syncable

      To import a "importable" export, That export data needs to have valid metadata generated as well.

      To import a "syncable" export, That export data needs to have a valid metadata as well as listing files generated.

      Normally, when someone is doing the export operations as root user and using just the commands we have documented, They don't need to do anything extra.

      but under three circumstances, An user would need to trigger the metadata and listing file generations manually i.e.

      • When a non-root user is doing the export
      • When --async flag has been passed [ root or non-root user ]
      • When triggering API manually or via ansible modules to do the exports

      And users do run into these situations and then complains that our satellite documentation had no clear explanation provided about it.

      Suggestions for improvement:

      1. hammer content-export --help
        Usage:
        hammer content-export [OPTIONS] SUBCOMMAND [ARG] ...

      Parameters:
      SUBCOMMAND Subcommand
      [ARG] ... Subcommand arguments

      Subcommands:
      complete Prepare content for a full export to a disconnected Katello
      generate-listing Generates listing file on each directory of a syncable export. This command only
      needs to be used if the export was performed asynchronously or if the listing
      files were lost. Assumes the syncable export directory is accessible on disk
      generate-metadata Writes export metadata to disk for use by the importing Katello. This command
      only needs to be used if the export was performed asynchronously or if the
      metadata was lost
      incremental Prepare content for an incremental export to a disconnected Katello
      list View content view export histories

      Options:
      -h, --help Print help

      Document the usage of generate-metadata and generate-listing options under "hammer content-export" action, in a suitable place inside the product documentation.

      Additional information:

      NA

              jira-bugzilla-migration RH Bugzilla Integration
              rhn-support-saydas Sayan Das
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated: