Skip to content

Conversation

@grams
Copy link

@grams grams commented Dec 11, 2025

🔌 Plugin Information

This PR adds the readonly plugin to krew-index.

📖 What is readonly?

readonly is a kubectl wrapper that restricts commands to read-only operations. It's designed for giving AI assistants (like Claude, Cursor, or other LLM-based tools) access to explore Kubernetes clusters while reducing the risk of accidental modifications.

✨ Features

  • 📋 Allowlist-based: Only explicitly allowed commands can run
  • 🔒 Secrets protection: Can list secrets but blocks viewing their values
  • 👀 Read-only by design: Allowed commands are limited to read-only operations
  • 🛠️ Allowed commands: get, describe, logs, top, explain, api-resources, api-versions, cluster-info, version, events, wait, diff, and subcommands of config, auth, and rollout

🎯 Use Cases

  • 🤖 Give AI coding assistants controlled access to Kubernetes clusters for debugging and exploration
  • 🧪 Add a client-side safety layer when exploring production clusters
  • 📚 Learning and documentation: explore cluster resources without fear of typos

🔗 Release Assets

@ahmetb
Copy link
Member

ahmetb commented Dec 11, 2025

🤖 Beep beep! I’m a robot speaking on behalf of @ahmetb. 🤖


Thanks for submitting your kubectl plugin to Krew!
One of the krew-index maintainers will review it soon. Note that the reviews for new plugin submissions may take a few days.

In the meanwhile, here are a few tips to make your plugin manifest better:

  • Make sure your plugin follows the best practices.
  • Eliminate redundant wording form shortDescription (it should be max 50 characters).
  • Try to word wrap your description to 80-character lines (no usage examples, please).

Thanks for your patience!
/kind new-plugin

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: grams
Once this PR has been reviewed and has the lgtm label, please assign chriskim06 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 11, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: grams / name: Guillaume Rams (a377b60)

@k8s-ci-robot
Copy link
Contributor

Welcome @grams!

It looks like this is your first PR to kubernetes-sigs/krew-index 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/krew-index has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. kind/new-plugin size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 11, 2025
@grams grams force-pushed the add-readonly-plugin branch from 44d7e07 to b03a64c Compare December 15, 2025 07:48
@grams grams force-pushed the add-readonly-plugin branch from b03a64c to a377b60 Compare January 12, 2026 08:20
Allowed commands include: get, describe, logs, top, explain, api-resources,
api-versions, cluster-info, version, events, wait, diff, and read-only subcommands
of config, auth, and rollout.
caveats: |
Copy link
Member

Choose a reason for hiding this comment

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

Can you please delete this section? It doesn't list anything noteworthy and it's not a place to list usage string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/new-plugin size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants