User Story: Adding a Cluster in Kube-OIDC-Proxy

[Bhoomiz01]

As an admin, I want to add a new cluster to the Kube-OIDC-Proxy so that users can access it securely through role-based access.

---

Steps to Validate the User Story

1. Prepare Cluster Details

   • Gather the required cluster information, including the cluster name, and any specific configuration details.
   • Ensure that the cluster is functional and accessible for integration.

2. Update YAML Configuration

   • Navigate to the Kube-OIDC-Proxy file in the release repository.
   • Locate the YAML file responsible for defining cluster configurations.
   • Add the new cluster’s details to the YAML file in the appropriate format.

3. Create Pull Request (PR)

   • Commit the changes to a new branch in the repository.
   • Create a pull request (PR) in the repository for the updated YAML file.
   • Add a detailed description of the changes in the PR, including the cluster name and purpose of the addition.

4. Review and Approve PR

   • Ensure the PR is reviewed by maintainers or authorized team members.
   • Address any comments or requested changes during the review process.
   • Approve and merge the PR into the main branch.

5. Trigger and Monitor CI/CD Pipeline

   • Verify that the CI/CD pipeline is triggered automatically after the PR merge.
   • Check the pipeline logs to ensure that:
     • The YAML configuration is validated successfully.
     • The proxy is built and deployed without errors.

6. Verify Cluster Integration

   • Validate that the new cluster is accessible through the Kube-OIDC-Proxy.
   • Use a valid user role in Keycloak to attempt access to the new cluster.
   • Check if the proxy correctly routes requests to the cluster.

7. User Access Validation

   • Assign roles in Keycloak to test users for the new cluster.
   • Test access to the cluster with users having the appropriate role.
   • Confirm access is restricted for users without the required permissions.

8. Documentation Update

   • Include steps for adding clusters, validation processes, and common troubleshooting tips.

---

Preconditions:

• The admin has appropriate permissions to update the proxy repository.
• The CI/CD pipeline is configured for the proxy repository and functional.
• The required cluster information is available.

[tapanbavaliya]

@Bhoomiz01 kudos! Very detailed.

Please make sure you test it personally, or do you take the demo first?

Ty