Skip to content

docs: resource and group assigning to the client within LS AAI - #30

Merged
xpavlic merged 2 commits into
devfrom
xpavlic/client_registration
Nov 11, 2026
Merged

xpavlic merged 2 commits into
devfrom
xpavlic/client_registration

Conversation

@xpavlic

@xpavlic xpavlic commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documentation for resources and groups assigning to clients.

Closes #9

Verification

Process verified with Elixir VO admins.

Checklist

  • Tests are added or updated where the change affects behaviour, and
    pass.
  • The documentation is updated where the change affects it.
  • The title follows Conventional
    Commits
    (at most 50 characters,
    imperative mood, no trailing period).

Summary by Sourcery

Document the resource and group assignment workflow for client setup in LS AAI, including delegated VO-admin responsibilities and entitlement verification.

Enhancements:

  • Clarify how client resources and VO groups are assigned, including the roles and permissions required for group assignment.
  • Document the VO-admin delegation workflow for assigning groups and verifying released entitlements across services.
  • Update group testing guidance to account for VO-admin involvement and self-service permission limitations.

Documentation:

  • Expand client registration and group testing documentation with resource setup, group assignment, entitlement verification, and T3 validation procedures.

@xpavlic
xpavlic requested a review from uniqueg November 10, 2026 13:27
@xpavlic xpavlic self-assigned this Nov 10, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Update the LS AAI resource and group-assignment workflow across the client-registration and T3 documentation, including who assigns groups, how to verify released entitlements, and the testbed’s intentional orchestrator omission.

  • docs/setup/client-registration.md L47-73
  • docs/tests/t3-groups.md L83-85

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

@read-the-docs-community

read-the-docs-community Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 token-exchange-flow-testbed | 🛠️ Build #35810939 | 📁 Comparing e9bc6fd against latest (7585c99)

  🔍 Preview build  

2 files changed
± setup/client-registration/index.html
± tests/t3-groups/index.html

@sourcery-ai

sourcery-ai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Linked issues

Checked at commit e9bc6fd

#9 chore: find out how to assign test groups · 2 of 3 met · 1 to check by hand

# Requirement Status Notes
1 Find out which role is needed. ✅ Met The docs identify TrustedFacilityAdmin within the relevant VO as enabling group assignment.
2 Assign the test group. 👀 Check by hand (external system) Check in Perun that the test group was actually assigned to the intended resource or resources; the docs describe asking VO admins to assign it but do not record that the assignment occurred.
3 Record the steps on the Client registration page. ✅ Met The page documents resource creation, delegating group assignment to VO admins, and verifying the assigned groups and released entitlements.

@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 found 2 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/setup/client-registration.md" line_range="63-68" />
<code_context>
+The VO admins perform group assignments to the resource. The client maintainer creates the resources, then sends the VO admins links to the resource and to groups he wants to assign to the resource.
</code_context>
<issue_to_address>
**Group assignment instructions conflict**

When the maintainer follows the setup checklist in order, the maintainer following the earlier “For the test” checklist is told to assign the group themselves, then this section says VO admins perform that assignment. They may try the unavailable assignment themselves instead of handing it off, delaying resource setup.

Update the earlier checklist to say the maintainer creates each resource and the VO admins assign the group.
</issue_to_address>

### Comment 2
<location path="docs/setup/client-registration.md" line_range="63" />
<code_context>
+
+Being able to open a facility and create a resource does not establish permission to assign a VO's groups. A greyed-out Next button under "Assign groups" may indicate missing permissions.
+
+The VO admins perform group assignments to the resource. The client maintainer creates the resources, then sends the VO admins links to the resource and to groups he wants to assign to the resource.
+
+### Assigning groups and verifying release
</code_context>
<issue_to_address>
**Required Perun role remains unknown**

When an operator needs to request the permission to assign groups rather than delegate the work to VO admins, operators who need to identify which Perun permission to request still get no answer: the new instructions identify VO admins as the people to delegate to, while T3 continues to mark the required role as unresolved. They cannot determine which role enables group assignment.

Name the verified Perun role, or explicitly state that it is still unknown and that operators should delegate assignments to VO admins.
</issue_to_address>

Sourcery assessment

Approval pending. 2 findings to address first.

Blocking findings: docs/setup/client-registration.md:68, docs/setup/client-registration.md:63


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/setup/client-registration.md Resolved
Comment thread docs/setup/client-registration.md Resolved

@uniqueg uniqueg left a comment

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.

Thanks @xpavlic - looks good to me, but please address the Sourcery comments 🙏

@xpavlic
xpavlic force-pushed the xpavlic/client_registration branch from 4cdb566 to dcbdacb Compare November 11, 2026 09:13

@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.

Sourcery assessment

Approved.

@xpavlic
xpavlic merged commit c232c8b into dev Nov 11, 2026
7 checks passed
@xpavlic
xpavlic deleted the xpavlic/client_registration branch November 11, 2026 11:23
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.

chore: find out how to assign test groups

2 participants