HYPERFLEET-1253 - docs: fix RabbitMQ URL and add skeleton deploy command

[Mischulee]

Summary

Fixes incomplete broker URL in the authoring guide and added copy-paste helm install command.

• Ticket: HYPERFLEET-1253

Test Plan

• docs/adapter-authoring-guide.md renders correctly

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign mbrudnoy for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 1a5845c4-e610-41bf-a32b-b9ac3406d283

📥 Commits

Reviewing files that changed from the base of the PR and between 1fe8a49 and c9c9e8b.

📒 Files selected for processing (1)

• docs/adapter-authoring-guide.md

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• openshift-hyperfleet/architecture (manual)
• openshift-hyperfleet/hyperfleet-api (manual)
• openshift-hyperfleet/hyperfleet-sentinel (manual)
• openshift-hyperfleet/hyperfleet-adapter (manual)
• openshift-hyperfleet/hyperfleet-broker (manual)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/adapter-authoring-guide.md

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated the RabbitMQ section of the adapter authoring deployment checklist to use a template-style AMQP URL with placeholders for credentials and namespace/vhost (instead of a static example).
  • Added an explicit Helm install snippet showing the recommended broker settings and exchange name, plus mounting the adapter task config via --set-file.
  • Removed duplicated/outdated “Deploy using the Helm chart” guidance so the checklist flows cleanly to the next step.

Walkthrough

The deployment checklist now uses placeholder-based RabbitMQ credentials, namespace, and vhost values. The Helm installation example includes RabbitMQ URL and exchange settings alongside the external task configuration file argument. The previous static AMQP URL example and duplicated deployment paragraph were removed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: rafabene, mbrudnoy

🚥 Pre-merge checks | ✅ 11

✅ Passed checks (11 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title matches the main change: fixing the RabbitMQ URL and adding a Helm deploy command.
Description check	✅ Passed	The description is directly related to the docs update and Helm install example.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Sec-02: Secrets In Log Output	✅ Passed	Docs-only diff; no slog/logr/zap/fmt.Print* code or secret-bearing log fields were added. CWE-532 not introduced.
No Hardcoded Secrets	✅ Passed	Only documentation samples use placeholder credentials in amqp://:@...; no real secrets or base64 blobs found. CWE-798 not triggered.
No Weak Cryptography	✅ Passed	Docs-only diff; no MD5/DES/RC4/SHA1/ECB or secret-compare code. No CWE-327/CWE-328 issue found.
No Injection Vectors	✅ Passed	Docs-only change; no SQL, exec.Command, template.HTML, or yaml.Unmarshal sinks were added (no CWE-89/CWE-78/CWE-79/CWE-502 risk).
No Privileged Containers	✅ Passed	Only docs/adapter-authoring-guide.md changed; no manifests, Helm templates, or Dockerfiles were modified, so no privileged settings were introduced (CWE-269).
No Pii Or Sensitive Data In Logs	✅ Passed	Docs-only change; no logging statements or data-exposing logs added. CWE-532/CWE-359 not applicable.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

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

[hyperfleet-ci-bot]

Risk Score: 0 — risk/low

Signal	Detail	Points
PR size	15 lines	+0
Sensitive paths	none	+0

_{Computed by hyperfleet-risk-scorer}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/adapter-authoring-guide.md`:
- Around line 1770-1771: Update the RabbitMQ configuration examples and
production checklist in the adapter authoring guide to reference a
chart-supported Kubernetes Secret for credentials instead of embedding them in
ConfigMap values or --set arguments. Use an amqps:// broker URL for production,
and clearly label any retained amqp:// plaintext example as
local-development-only while removing it from production guidance.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 9e2aee96-0df3-4620-a56f-317cb639a9fd

📥 Commits

Reviewing files that changed from the base of the PR and between c16e601 and 1fe8a49.

📒 Files selected for processing (1)

• docs/adapter-authoring-guide.md

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• openshift-hyperfleet/architecture (manual)
• openshift-hyperfleet/hyperfleet-api (manual)
• openshift-hyperfleet/hyperfleet-sentinel (manual)
• openshift-hyperfleet/hyperfleet-adapter (manual)
• openshift-hyperfleet/hyperfleet-broker (manual)