Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(WIP) doc(xoa): Add documentation for authentication with auth-oidc plugin #8230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thomas-dkmt
Copy link
Contributor

Description

The documentation now explains how to set up authentication in Xen Orchestra using the OpenID Connect plugin.

It includes both admin-side configuration and user-side login steps, and should address this issue: #8225

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

@thomas-dkmt thomas-dkmt force-pushed the doc-auth-oidc-plugin branch from 83459b5 to 17a95e1 Compare January 9, 2025 06:53
The documentation now explains how to set up authentication in
Xen Orchestra using the OpenID Connect plugin. It includes both
admin-side configuration and user-side login steps.

Signed-off-by: Thomas Moraine <[email protected]>

users.md: Simplify label description

Signed-off-by: Thomas Moraine <[email protected]>
@thomas-dkmt thomas-dkmt force-pushed the doc-auth-oidc-plugin branch from 17a95e1 to 60d277a Compare January 9, 2025 06:54
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.

3 participants