Skip to content

Print proxy deployment commands after auth-bundle - #858

Open
jakduch wants to merge 1 commit into
theforeman:masterfrom
jakduch:fix/812-auth-bundle-guidance
Open

jakduch wants to merge 1 commit into
theforeman:masterfrom
jakduch:fix/812-auth-bundle-guidance

Conversation

@jakduch

@jakduch jakduch commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

Why are you introducing these changes? (Problem description, related links)

auth-bundle currently reports only the generated archive path. Users still have to reconstruct the scp and deploy-proxy commands, including both hostnames, by hand.

Fixes #812

What are the changes introduced in this pull request?

  • print ready-to-run scp and deploy-proxy commands after creating the bundle
  • shell-quote every generated command argument
  • select foreman-proxy-content for Katello and capsule for a persisted Satellite flavor
  • document the new output and cover it in the auth-bundle integration test

How to test this pull request

  • run foremanctl auth-bundle proxy.example.com after a server deployment
  • verify the output contains a complete scp command and a deploy-proxy command with the bundle path, proxy flavor, and Foreman FQDN
  • /tmp/foremanctl-846-venv/bin/ruff check tests/auth_bundle_test.py

Checklist

  • Tests added/updated
  • Documentation updated

This pull request was created with assistance from OpenAI Codex.

@coderabbitai

coderabbitai Bot commented Sep 24, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 44 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: e3bc1d7c-32b3-451f-bc0d-ee08000d52dc

📥 Commits

Reviewing files that changed from the base of the PR and between acdb0f7 and e0c6d70.

📒 Files selected for processing (5)
  • docs/user/certificates.md
  • src/playbooks/auth-bundle/auth-bundle.yaml
  • src/roles/auth_bundle/defaults/main.yml
  • src/roles/auth_bundle/tasks/main.yml
  • tests/auth_bundle_test.py

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@jakduch

jakduch commented Sep 25, 2026

Copy link
Copy Markdown
Contributor Author

The failing deployment job is caused by the shared development-memory issue, not by the auth-bundle output change: Candlepin is killed by the OOM killer. #865 contains the fix and has passed the complete CI matrix.

- role: auth_bundle
vars:
auth_bundle_hostname: "{{ hostname }}"
auth_bundle_proxy_flavor: >-

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't like this baking of the flavor into the playbooks if we can help it.

Then run this command on {{ auth_bundle_hostname }}:

foremanctl deploy-proxy \
--flavor {{ auth_bundle_proxy_flavor | quote }} \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder if we can have a mechanism by which to mark a flavor as the default or as the primary, then having someway that vendor overrides can set this and make the command less reliant on flavor directly. Just an idle thought.

msg: |
Auth bundle created: {{ _bundle_path }}

To finish the proxy installation, copy the bundle to the proxy:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I've previously wondered about making this output less specific and more like:

Next steps:

 1. Transfer auth bundle securely
 2. Run `deploy-proxy` command with these options

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Setting up a smart proxy requires more copying and pasting of hostnames than with foreman-installer

2 participants