Skip to content

Add admin endpoint to list Kubernetes objects in Hive-managed AKS clusters#4559

Merged
cadenmarchese merged 25 commits intomasterfrom
k8s-objectslist-ARO-RP
Mar 20, 2026
Merged

Add admin endpoint to list Kubernetes objects in Hive-managed AKS clusters#4559
cadenmarchese merged 25 commits intomasterfrom
k8s-objectslist-ARO-RP

Conversation

@sravyanimmala
Copy link
Copy Markdown
Collaborator

This PR introduces a "new admin-only endpoint" in ARO-RP that allows listing Kubernetes objects from "Hive-managed AKS clusters" without SSH or break-glass.

Right now, if we want to debug a Hive-managed AKS cluster in prod, the only option is:
• SSH into RP VMSS
• Login to Azure
• Get kubeconfig
• Install kubectl
• Use break-glass / elevated JIT

  1. Adds a new admin API handler that lists Kubernetes objects for:
    • a specific region
    • an optional namespace
    • a given resource type (pods, nodes, deployments, etc.)

  2. A new abstraction called HiveK8sObjectManager:
    • Handles all logic for fetching k8s objects from Hive clusters
    • Keeps Hive-specific logic out of the frontend handlers
    • Makes the code easier to test and extend later

  3. The manager is wired into the frontend:
    • Passed into NewFrontend as a dependency
    • Treated as nil when it’s not configured or not needed

  4. Updates to existing frontend tests:
    • Added nil placeholders where this new dependency isn’t required
    • Ensures there is no behavior change for existing admin or customer APIs

What this PR does NOT do (out of scope)

  1. Does not create or publish a Geneva Action
  2. Does not expose this functionality to customers
  3. Does not enable access in production by default

Follow-up steps after merge

  1. Merge and release RP to all regions
  2. Onboard a Geneva Action that calls this admin endpoint
  • TEST environment first
  • Then promote to PROD
  1. Use Geneva Actions to list k8s objects in Hive AKS clusters safely

@sravyanimmala sravyanimmala changed the title add admin hive k8s objects list support Add admin endpoint to list Kubernetes objects in Hive-managed AKS clusters Jan 19, 2026
Copy link
Copy Markdown
Member

@cadenmarchese cadenmarchese left a comment

Choose a reason for hiding this comment

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

This is a good start! It looks like you've configured the endpoint and are validating the request. Now we will need to implement this HiveK8sObjectManager so that it will LIST or GET the k8s objects in the regional AKS clusters on behalf of the RP. Once you've done that, you will be able to set up some unit testing.

To do the implementation, I would follow the same pattern as the /kubernetesobjects / List or Get Kubernetes Objects geneva action (currently in prod) where we can pass a kind, namespace, and name. From there, the action would do a list if no name is provided, or alternately do a get if a name is provided.

Check out pkg/frontend/admin_openshiftcluster_kubernetesobjects.go for a good example to use here.

Comment thread pkg/frontend/frontend.go Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
Comment thread .DS_Store Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
Comment thread pkg/frontend/hive_k8s_object_manager.go Outdated
@sravyanimmala
Copy link
Copy Markdown
Collaborator Author

This is a good start! It looks like you've configured the endpoint and are validating the request. Now we will need to implement this HiveK8sObjectManager so that it will LIST or GET the k8s objects in the regional AKS clusters on behalf of the RP. Once you've done that, you will be able to set up some unit testing.

To do the implementation, I would follow the same pattern as the /kubernetesobjects / List or Get Kubernetes Objects geneva action (currently in prod) where we can pass a kind, namespace, and name. From there, the action would do a list if no name is provided, or alternately do a get if a name is provided.

Check out pkg/frontend/admin_openshiftcluster_kubernetesobjects.go for a good example to use here.

Comment thread go.mod Outdated
Comment thread pkg/frontend/hive_k8s_object_manager.go Outdated
@cadenmarchese cadenmarchese added the chainsaw Pull requests or issues owned by Team Chainsaw label Jan 28, 2026
Copy link
Copy Markdown
Member

@cadenmarchese cadenmarchese left a comment

Choose a reason for hiding this comment

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

We're getting closer, but we're not functional yet. Here are a few specific things we need for this PR:

  • Since you're opening your first PR here, you will need to accept the CLA.
  • You will need to test your code by running a local RP. The instructions can be found here.
    • Ensure that Hive environment variables (ARO_INSTALL_VIA_HIVE, HIVE_KUBE_CONFIG_PATH) are set and valid before you run the binary. You'll also need to connect to the Hive AKS VPN so that your RP can talk to the AKS cluster.
    • You can test other admin actions by curling the ARO-RP directly as shown here - in your case, it will be something like curl -X GET -k "https://localhost:8443/admin/hive/k8sobjects/namespaces" and so on. You don't actually need to create a dev cluster to test your changes because we're querying an already-existing AKS cluster.
    • Once you have locally verified that your route is working and successfully returning the k8s objects, you'll have to resolve any failing CI. We can do that by investigating logs from any failed jobs. Here's an example from the most recent run: https://github.com/Azure/ARO-RP/pull/4559/checks?check_run_id=61528339305

If you get stuck on anything along the way please feel free to reach out in the team channel and we'll be happy to assist!

Comment thread pkg/frontend/hive_k8s_object_manager.go Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
Comment thread pkg/frontend/frontend.go Outdated
@cadenmarchese cadenmarchese marked this pull request as draft January 29, 2026 15:19
@sravyanimmala
Copy link
Copy Markdown
Collaborator Author

@sravyanimmala please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@sravyanimmala
Copy link
Copy Markdown
Collaborator Author

@sravyanimmala please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree company="redhat"

@sravyanimmala sravyanimmala reopened this Jan 30, 2026
@sravyanimmala sravyanimmala marked this pull request as ready for review January 30, 2026 01:52
@github-actions
Copy link
Copy Markdown

Please rebase pull request.

@github-actions github-actions Bot added the needs-rebase branch needs a rebase label Feb 10, 2026
@sravyanimmala sravyanimmala force-pushed the k8s-objectslist-ARO-RP branch from 4ef342a to 723c2bc Compare March 2, 2026 16:22
@sravyanimmala sravyanimmala force-pushed the k8s-objectslist-ARO-RP branch from 83f983c to 6a5815d Compare March 16, 2026 16:20
@github-actions github-actions Bot removed the needs-rebase branch needs a rebase label Mar 16, 2026
Comment thread pkg/frontend/adminactions/kubeactions.go Outdated
Comment thread pkg/frontend/adminactions/kubeactions.go Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go
Comment thread pkg/frontend/adminactions/kubeactions.go Outdated
Copy link
Copy Markdown
Member

@cadenmarchese cadenmarchese left a comment

Choose a reason for hiding this comment

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

nice work!

@rajdeepc2792
Copy link
Copy Markdown
Collaborator

@copilot please review

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 18, 2026

@rajdeepc2792 I've opened a new pull request, #4694, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link
Copy Markdown
Contributor

@kimorris27 kimorris27 left a comment

Choose a reason for hiding this comment

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

LGTM! Rajdeep had mentioned that there's potential for an E2E test, but I could go either way on that.

Copy link
Copy Markdown
Collaborator

@rajdeepc2792 rajdeepc2792 left a comment

Choose a reason for hiding this comment

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

The functionality looks good, the dynamicClient initialization seems repetitive as we already have the client under the frontend object. It would be great to move the list/get functions to the hiveclustermanager and use the exisiting client to reach Hive AKS Cluster.

Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
Comment thread pkg/frontend/admin_hive_k8s_objects_list.go Outdated
@cadenmarchese cadenmarchese merged commit 4e50da3 into master Mar 20, 2026
29 of 31 checks passed
@cadenmarchese cadenmarchese deleted the k8s-objectslist-ARO-RP branch March 20, 2026 16:08
ventifus pushed a commit that referenced this pull request Apr 1, 2026
…sters (#4559)

Authored-by: b-lnimmala <b-lnimmala@microsoft.com>
Co-authored-by: Caden Marchese <56140267+cadenmarchese@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chainsaw Pull requests or issues owned by Team Chainsaw

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants