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

docs(clusters): remote cluster onboarding with oidc configuration #973

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

abhijith-darshan
Copy link
Contributor

@abhijith-darshan abhijith-darshan commented Mar 6, 2025

Description

Documentation for Remote Cluster Onboarding with OIDC configuration

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 6, 2025
@abhijith-darshan abhijith-darshan changed the title docs(cluster): remote cluster onboarding with oidc configuration docs(clusters): remote cluster onboarding with oidc configuration Mar 6, 2025
@abhijith-darshan abhijith-darshan marked this pull request as ready for review March 6, 2025 23:14
@abhijith-darshan abhijith-darshan requested a review from a team as a code owner March 6, 2025 23:14
@abhijith-darshan abhijith-darshan self-assigned this Mar 6, 2025
Copy link
Contributor

@kengou kengou left a comment

Choose a reason for hiding this comment

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

Nice πŸš€

@kengou kengou self-requested a review March 7, 2025 13:16
kengou
kengou previously approved these changes Mar 7, 2025

This guide describes how to onboard an existing Kubernetes cluster to your Greenhouse organization with OIDC
configuration.
If you don't have an organization yet, please reach out to the Greenhouse administrators.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's link to the Organization docs here:
https://cloudoperators.github.io/greenhouse/docs/user-guides/organization/creation/

While they need an overhaul as well, they should be the single point to get information on how to get an org.

`the server has asked for the client to provide credentials`,
in such cases verify the `Structured Authentication Configuration` and ensure the `issuer` and `audiences` are correct.

The `API Server` logs in the remote cluster will provide more information on the authentication errors
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `API Server` logs in the remote cluster will provide more information on the authentication errors
The `API Server` logs in the remote cluster will provide more information on the authentication errors.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please provide the diagram as mermaid.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] - Onboarding of Cluster with StructuredAuth
3 participants