Skip to content

docs: document role parameters [citest_skip]#16

Merged
richm merged 1 commit into
linux-system-roles:mainfrom
richm:doc-parameters
May 7, 2026
Merged

docs: document role parameters [citest_skip]#16
richm merged 1 commit into
linux-system-roles:mainfrom
richm:doc-parameters

Conversation

@richm

@richm richm commented May 7, 2026

Copy link
Copy Markdown
Contributor

document role parameters in README.md

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Documentation:

  • Add detailed descriptions of trustee_server_trustee, trustee_server_secret_registration_enabled, trustee_server_secret_registration_listen_port, and trustee_server_secure_logging role variables in the README.

@richm richm requested a review from spetrosi as a code owner May 7, 2026 17:15
@sourcery-ai

sourcery-ai Bot commented May 7, 2026

Copy link
Copy Markdown

Reviewer's Guide

Updates README.md to document all role variables, including newly documented Trustee server parameters and reorganized secure logging documentation within a consolidated Variables section.

File-Level Changes

Change Details Files
Introduce and document a consolidated Variables section for the Ansible role.
  • Add a new 'Variables' section near the top of README.md
  • Move the existing trustee_server_secure_logging documentation into the new Variables section
  • Remove the old Variables section at the bottom that redundantly documented trustee_server_secure_logging
README.md
Document additional Trustee server role parameters for deployment and secret registration behavior.
  • Document trustee_server_trustee, including its default, type, and interaction with secret registration
  • Document trustee_server_secret_registration_enabled with its default, type, and dependency on trustee_server_trustee
  • Document trustee_server_secret_registration_listen_port, including its default value, type, and firewalld behavior
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the trustee_server_secret_registration_listen_port section, consider explicitly stating that the port is only relevant when trustee_server_secret_registration_enabled is true to make the dependency between variables clearer.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the `trustee_server_secret_registration_listen_port` section, consider explicitly stating that the port is only relevant when `trustee_server_secret_registration_enabled` is `true` to make the dependency between variables clearer.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

document role parameters in README.md

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm force-pushed the doc-parameters branch from e115531 to ab314bc Compare May 7, 2026 20:14
@richm richm changed the title doc: document role parameters [citest_skip] docs: document role parameters [citest_skip] May 7, 2026
@richm richm merged commit cc80288 into linux-system-roles:main May 7, 2026
11 of 12 checks passed
@richm richm deleted the doc-parameters branch May 7, 2026 20:15
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.

1 participant