Skip to content

docs: document role parameters in README.md [citest_skip]#33

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

docs: document role parameters in README.md [citest_skip]#33
richm merged 1 commit into
linux-system-roles:mainfrom
richm:doc-params

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@richm richm commented May 7, 2026

document role parameters in README.md

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

Summary by Sourcery

Documentation:

  • Add detailed documentation for all trustee client role variables, including behavior, defaults, and types, and relocate existing secure logging variable docs into this new section.

document role parameters in README.md

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm requested a review from spetrosi as a code owner May 7, 2026 16:57
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 7, 2026

Reviewer's Guide

Documents all role variables for the trustee_client Ansible role in README, including defaults, behavior, and types, and moves the secure logging variable docs into a consolidated Variables section.

File-Level Changes

Change Details Files
Document all trustee_client role variables in a new README "Variables" section, clarifying behavior, defaults, and types.
  • Add a Variables section describing trustee_client_trustee_gc behavior and its interaction with secret registration.
  • Document KBS-related variables (trustee_client_kbs_url, trustee_client_kbs_cert_content, trustee_client_kbs_cert_src), including how they update config.toml and certificates.
  • Document secret registration and disk encryption variables (trustee_client_secret_registration_enabled, trustee_client_encrypt_disk, trustee_client_encrypt_disk_mount_point) and their default behaviors.
  • Move trustee_client_secure_logging documentation from its own section into the consolidated Variables section and remove the old standalone section.
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

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


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.

@richm richm merged commit 9792173 into linux-system-roles:main May 7, 2026
12 checks passed
@richm richm deleted the doc-params branch May 7, 2026 20:14
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