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

add kubectl-lr manisfest #4179

Closed

Conversation

mfenerich
Copy link

Title: Add kubectl-lr plugin to Krew index

Description:

This PR adds the kubectl-limitrange plugin to the Krew plugin index.

Plugin Name: kubectl-limitrange

Plugin Repository: https://github.com/mfenerich/kubectl-lr

Overview

kubectl-limitrange is a kubectl plugin that simplifies the creation of LimitRange resources in Kubernetes namespaces. It provides an easy and efficient way to set CPU and memory limits, helping cluster administrators enforce resource constraints and optimize cluster performance.

Key Features

  • Easy Creation of LimitRanges: Streamlines the process of creating LimitRange resources without the need to write YAML manifests manually.
  • Configurable Resource Limits: Allows users to specify minimum and maximum CPU and memory limits according to their requirements.
  • Namespace Support: Can target specific namespaces, making it flexible for multi-tenant environments.
  • Cross-Platform Availability: Binaries are available for macOS (darwin), Linux, and Windows on amd64 architectures.

Why This Plugin Should Be Accepted

  • Enhances Productivity: Automates repetitive tasks, saving time and reducing the potential for human error in resource configuration.
  • Promotes Best Practices: Encourages the use of LimitRanges, which are essential for resource management and ensuring fair resource allocation among pods.
  • Community Benefit: Fills a gap in the current plugin ecosystem by providing a dedicated tool for managing LimitRanges.

Compliance with Krew Guidelines

  • Manifest Validation: The plugin manifest has been validated and complies with Krew's plugin manifest specification.
  • License: The plugin is open-sourced under the Apache License 2.0, aligning with Krew's licensing requirements.
  • Naming Convention: The plugin name follows the kubectl-<plugin-name> format, adhering to the recommended naming conventions.

Testing and Verification

  • Installation: Successfully tested installation via Krew on macOS and Linux systems.
  • Functionality: Verified that the plugin correctly creates LimitRange resources with specified CPU and memory limits.
  • Documentation: Usage instructions and examples are provided in the plugin's README.

Example Usage

# Create a LimitRange in the 'development' namespace with custom limits
kubectl lr create limitrange --cpu-min=100m --cpu-max=500m --memory-min=128Mi --memory-max=1Gi

Related Links

Copy link

linux-foundation-easycla bot commented Nov 1, 2024

CLA Signed


The committers listed above are authorized under a signed CLA.

@ahmetb
Copy link
Member

ahmetb commented Nov 1, 2024

🤖 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: mfenerich
Once this PR has been reviewed and has the lgtm label, please assign ahmetb for approval. For more information see the Kubernetes Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 1, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @mfenerich!

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 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 Nov 1, 2024
@mfenerich mfenerich closed this Nov 1, 2024
@mfenerich mfenerich deleted the mfenerich-patch-1 branch November 1, 2024 16:50
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