Skip to content

docs(authz): authorization webhook documentation#1974

Merged
Zaggy21 merged 8 commits into
mainfrom
feat/authorization-webhook-documentation
May 27, 2026
Merged

docs(authz): authorization webhook documentation#1974
Zaggy21 merged 8 commits into
mainfrom
feat/authorization-webhook-documentation

Conversation

@Zaggy21
Copy link
Copy Markdown
Contributor

@Zaggy21 Zaggy21 commented May 7, 2026

Description

This PR adds user-facing documentation for the authorization webhook component, explaining how support-group-scoped access control works and how to properly configure resource ownership.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes

Copilot AI review requested due to automatic review settings May 7, 2026 12:31
@Zaggy21 Zaggy21 requested a review from a team as a code owner May 7, 2026 12:31
@Zaggy21 Zaggy21 linked an issue May 7, 2026 that may be closed by this pull request
4 tasks
@github-actions github-actions Bot added size/L documentation Improvements or additions to documentation feature labels May 7, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds user-facing documentation for Greenhouse’s authorization webhook (support-group-scoped access control), and links it from related RBAC/Teams/Ownership docs to help users configure greenhouse.sap/owned-by correctly and troubleshoot access issues.

Changes:

  • Adds a new documentation page describing the authorization webhook’s purpose, identity resolution, configuration steps, and troubleshooting.
  • Links the new page from the Ownership guide and the Teams core-concepts page.
  • Adds a cross-reference from the Team RBAC (remote clusters) guide to the authorization webhook docs for central Greenhouse resources.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
docs/user-guides/team/rbac.md Adds a “Related” section pointing readers to the authorization webhook docs for central-cluster Greenhouse resources.
docs/getting-started/operations/ownership.md Connects ownership labeling to authorization-webhook behavior via a new explanatory sentence/link.
docs/getting-started/operations/authorization-webhook.md Introduces the new end-user documentation page for the authorization webhook (overview, how it works, setup, troubleshooting).
docs/getting-started/core-concepts/teams.md Adds a short note linking support-groups to authorization-webhook enforcement.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/getting-started/operations/authorization-webhook.md
Comment thread docs/getting-started/operations/authorization-webhook.md Outdated
Comment thread docs/getting-started/operations/ownership.md Outdated
Comment thread docs/getting-started/core-concepts/teams.md Outdated
Comment thread docs/user-guides/team/rbac.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread docs/getting-started/operations/authorization-webhook.md Outdated
Comment thread docs/getting-started/operations/authorization-webhook.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread docs/getting-started/operations/authorization-webhook.md Outdated
Copy link
Copy Markdown
Contributor

@abhijith-darshan abhijith-darshan left a comment

Choose a reason for hiding this comment

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

this documentation shows up at top level -

Image

Who is the audience this documentation is being targeted? because authz is mentioned across 3 different sections, describing everything from "How it works?", to debugging. But has no section to say how to install this in our installation guide.

Should we focus on end-user documentation first and then slowly bring in the rest?

What I mean is condense the documentation to customer / end user focus -

Fine grained access on team owned resources? put under user guide?

  • How to work with resources using an SA
  • How to work with resources as a team user

etc. what are your thoughts @Zaggy21

@Zaggy21 Zaggy21 requested a review from a team as a code owner May 13, 2026 10:02
@Zaggy21
Copy link
Copy Markdown
Contributor Author

Zaggy21 commented May 13, 2026

@abhijith-darshan You're right. I've split the docs for different audiences and added installation section (based on authz chart readme; fixed some links) - should I include the AuthorizationConfiguration here as well?

@abhijith-darshan
Copy link
Copy Markdown
Contributor

abhijith-darshan commented May 13, 2026

@abhijith-darshan You're right. I've split the docs for different audiences and added installation section (based on authz chart readme; fixed some links) - should I include the AuthorizationConfiguration here as well?

Let’s Skip the installation docs for now as it should be handled in #1864

Let’s focus on one section for Team / end user docs so that they understand elevated authorization to interact with greenhouse resources owned by a team.

i would recommend to put it under team management as a separate section. Does that sound good? @Zaggy21

@Zaggy21 Zaggy21 requested a review from abhijith-darshan May 18, 2026 13:51
Comment thread charts/authz/README.md Outdated
Comment thread charts/authz/README.md Outdated
Comment thread charts/authz/README.md Outdated
@Zaggy21 Zaggy21 requested a review from abhijith-darshan May 25, 2026 20:56
@abhijith-darshan abhijith-darshan force-pushed the feat/authorization-webhook-documentation branch from 56ffc6b to 0c7179d Compare May 26, 2026 13:18
Zaggy21 added 6 commits May 27, 2026 11:39
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
… guide and team user guide

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
…authz install section

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
Zaggy21 added 2 commits May 27, 2026 11:39
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
@Zaggy21 Zaggy21 force-pushed the feat/authorization-webhook-documentation branch from 0c7179d to 2b6e642 Compare May 27, 2026 09:39
@Zaggy21 Zaggy21 merged commit 2df7261 into main May 27, 2026
10 checks passed
@Zaggy21 Zaggy21 deleted the feat/authorization-webhook-documentation branch May 27, 2026 09:42
k-fabryczny pushed a commit that referenced this pull request May 29, 2026
* add documentation for authorization webhook

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: clarify authz webhook scope and RBAC interaction

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: scope webhook capabilities and add SA creation prerequisites

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: reconcile support-group multiplicity with teams docs

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: restructure authorization webhook docs by audience, add install guide and team user guide

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs(authz): split team-owned resources into dedicated guide, remove authz install section

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change remaining reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

---------

Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
k-fabryczny pushed a commit that referenced this pull request May 29, 2026
* add documentation for authorization webhook

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: clarify authz webhook scope and RBAC interaction

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: scope webhook capabilities and add SA creation prerequisites

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: reconcile support-group multiplicity with teams docs

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: restructure authorization webhook docs by audience, add install guide and team user guide

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs(authz): split team-owned resources into dedicated guide, remove authz install section

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change remaining reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

---------

Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
Signed-off-by: Klaudiusz Fabryczny <klaudiusz.fabryczny@sap.com>
k-fabryczny pushed a commit that referenced this pull request May 29, 2026
* add documentation for authorization webhook

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: clarify authz webhook scope and RBAC interaction

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: scope webhook capabilities and add SA creation prerequisites

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: reconcile support-group multiplicity with teams docs

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: restructure authorization webhook docs by audience, add install guide and team user guide

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs(authz): split team-owned resources into dedicated guide, remove authz install section

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change remaining reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

---------

Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
k-fabryczny pushed a commit that referenced this pull request May 29, 2026
* add documentation for authorization webhook

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: clarify authz webhook scope and RBAC interaction

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: scope webhook capabilities and add SA creation prerequisites

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: reconcile support-group multiplicity with teams docs

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs: restructure authorization webhook docs by audience, add install guide and team user guide

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* docs(authz): split team-owned resources into dedicated guide, remove authz install section

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

* fix(docs): change remaining reversed to HA VPN tunnel

On-behalf-of: @SAP krzysztof.zagorski@sap.com
Signed-off-by: Zaggy21 <k.zaggy@gmail.com>

---------

Signed-off-by: Zaggy21 <k.zaggy@gmail.com>
Signed-off-by: Klaudiusz Fabryczny <klaudiusz.fabryczny@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature helm-charts size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEAT] - Authorization Webhook Documentation

3 participants