Document foremanctl impact on Pulp import/export paths

[aneta-petrova]

What changes are you introducing?

• Updating existing information on allowed import paths for foremanctl
• Adding a snippet with information on export paths

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

theforeman/foremanctl#455
https://github.com/theforeman/foremanctl/blob/744ba31fd0ee4e4a74eef97e2c705acca1b2961d/src/roles/pulp/defaults/main.yaml#L29-L30
theforeman/foremanctl#445

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Assisted-by: Cursor

Contributor checklists

• I am okay with my commits getting squashed when you merge this PR.
• I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

• Foreman 3.19/Katello 4.21
• Foreman 3.18/Katello 4.20 (Satellite 6.19)
• Foreman 3.17/Katello 4.19
• Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
• Foreman 3.15/Katello 4.17
• Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
• Foreman 3.13/Katello 4.15 (EL9 only)
• Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
• We do not accept PRs for Foreman older than 3.12.

[github-actions]

The PR preview for d8df5b5 is available at theforeman-foreman-documentation-preview-pr-4905.surge.sh

No diff compared to the current base

show diff

[aneta-petrova]

Hi @aidenfine, can you please take a look at this PR and let me know if you think these are the changes needed to cover theforeman/foremanctl#455?

Note that the preview links in #4905 (comment) include containerized and non-containerized docs preview builds. So for example to review the foremanctl changes, the right HTML builds to look at would be mainly https://theforeman-foreman-documentation-preview-pr-4905.surge.sh/nightly/Managing_Content/index-containerized-katello.html.

[vsedmik]

Left one note bellow which is going to be addressed by another PR I have been told, so ACK here, looks good to me. 👍

[maximiliankolb]

Two minor suggestion, overall LGTM style-wise.

I also suggest to swap the order in the snippet file name:

$ fd snip_ | rg prereq
guides/common/modules/snip_prerequisite-activation-key-available.adoc
guides/common/modules/snip_prerequisite-configured-smart-proxy-registration-provisioning.adoc
guides/common/modules/snip_prerequisite-networking-for-provisioning.adoc
guides/common/modules/snip_prerequisite-project-client-repository-ak.adoc
guides/common/modules/snip_prerequisite-project-client-repository-enabled.adoc
guides/common/modules/snip_prerequisite-repositories-with-oscap.adoc
guides/common/modules/snip_prerequisites-common-compute-resource.adoc
guides/common/modules/snip_prerequisites-configuring-smartproxyservers-for-load-balancing.adoc
guides/common/modules/snip_prerequisites-deploying-ca-cert-rex.adoc
guides/common/modules/snip_registering-a-host-prerequisites.adoc

So maybe "snip_prerequisite-allowed-export-paths.adoc`.

[maximiliankolb]

Tech wise, I think that foreman-installer can already configure those paths in some cases, so I would appreciated it someone double-checked this:

# foreman-installer --full-help | grep -i import
    --foreman-proxy-puppet                                                               Enable Puppet module for environment imports and Puppet runs (current: true)
    --foreman-proxy-content-pulpcore-additional-import-paths                             Additional allowed paths that Pulpcore can use for content imports, or sync from using file:// protocol (current: [])
    --reset-foreman-proxy-content-pulpcore-additional-import-paths                       Reset pulpcore_additional_import_paths to the default value ([])
    --foreman-proxy-content-pulpcore-import-workers-percent                              What percentage of available-workers will pulpcore use for import tasks at a time (current: UNDEF)
    --reset-foreman-proxy-content-pulpcore-import-workers-percent                        Reset pulpcore_import_workers_percent to the default value (UNDEF)
# foreman-installer --full-help | grep -i export
    --foreman-proxy-content-pulpcore-additional-export-paths                             Additional allowed paths that Pulpcore can use for content exports (current: [])
    --reset-foreman-proxy-content-pulpcore-additional-export-paths                       Reset pulpcore_additional_export_paths to the default value ([])

Tested on Foreman 3.18/Katello 4.20.

[ekohl]

Please keep the installer and foremanctl commands in sync as much as possible. I realize it was already wrong before, but this is a good opportunity to fix it. Note that users who manually modify settings.py will lose the value on the next installer run and we also can't migrate them from non-containerized to containerized. For that latter part is exactly why we maintain the parameter mapping.

[aidenfine]

Hi @aidenfine, can you please take a look at this PR and let me know if you think these are the changes needed to cover theforeman/foremanctl#455?

Note that the preview links in #4905 (comment) include containerized and non-containerized docs preview builds. So for example to review the foremanctl changes, the right HTML builds to look at would be mainly https://theforeman-foreman-documentation-preview-pr-4905.surge.sh/nightly/Managing_Content/index-containerized-katello.html.

Sorry for late reply. I would agree with what @ekohl is saying.

[aneta-petrova]

The Unused modules failure is probably due to https://github.com/theforeman/foreman-documentation/pull/4899/changes having been merged: Because the containerized guide's preview is empty, the new module seems unused. And it is unused right now, but won't be when we start exposing and publishing the containerized contents.

[aneta-petrova]

The Unused modules failure is probably due to https://github.com/theforeman/foreman-documentation/pull/4899/changes having been merged: Because the containerized guide's preview is empty, the new module seems unused. And it is unused right now, but won't be when we start exposing and publishing the containerized contents.

By the way, this is also the reason why the diff in #4905 (comment) is empty, so to review this type of change, there is no preview and looking at the changed lines should be enough.

[aneta-petrova]

Hi @aidenfine and/or @ekohl, can you please re-review?

[aidenfine]

LGTM matches PR I created. Please have @ekohl also review since he may know in depth details about this :)

[maximiliankolb]

style-wise LGTM

[aneta-petrova]

@maximiliankolb I extended the script and raised #4964 to track the exception. Can you please re-review?

[maximiliankolb]

Thank you Anet, LGTM!

[ekohl]

Noting down my thought and don't feel you need to implement this now. I wondered if we could force the cleanup of this somehow. Should be relatively straight forward by checking it actually deleted something.

Suggested change

	unused.delete('guides/common/modules/snip_allowed-export-paths-prerequisite.adoc')
	unless unused.delete('guides/common/modules/snip_allowed-export-paths-prerequisite.adoc')
	puts "Close https://github.com/theforeman/foreman-documentation/issues/4964"
	exit 1
	end

[aneta-petrova]

Thanks, everyone!