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-envsubst #4302

Merged
merged 7 commits into from
Jan 1, 2025
Merged

Conversation

hashmap-kz
Copy link
Contributor

@hashmap-kz hashmap-kz commented Dec 31, 2024

A strict substitution of env-vars in Kubernetes manifests.

Project link: https://github.com/hashmap-kz/kubectl-envsubst

Features available:

  • Expand environment-variables in manifests passed to kubectl, before applying them
  • Uses prefixes, and allowed variables (you're able to be totally sure what it's going to be substituted)
  • Has a strict mode (if some variables are not expanded, it fails)
  • Uses all known kubectl args (by just proxying them as is, without any additional actions)
  • ZERO dependencies, and I mean literally zero

Tests:

  • All parts of plugin are heavily tested (substitution part, arguments handling, errors handling)

Notes:

The main difference from using external tools: like envsubst, and then piping to kubectl - is we're able to 100% control the variables lists that needs to be substituted, handle all errors, use --dry-run and other options available in kubectl out of the box, implement more robust and predictable logic than substitute all available variables. And also we're able to test each part, and optimize execution flow. Options like substitute variables if and only if their names start with prefixes we want - are not available in external tools too.

Happy New Year !!!

A strict substitution of env-vars in Kubernetes manifests.
Copy link

linux-foundation-easycla bot commented Dec 31, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@ahmetb
Copy link
Member

ahmetb commented Dec 31, 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 k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 31, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @hashmap-kz!

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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 31, 2024
hashmap-kz and others added 2 commits December 31, 2024 20:17
@k8s-ci-robot k8s-ci-robot added 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 31, 2024
@hashmap-kz
Copy link
Contributor Author

/approve

@hashmap-kz
Copy link
Contributor Author

/assign chriskim06

@hashmap-kz
Copy link
Contributor Author

/assign ahmetb

@ahmetb
Copy link
Member

ahmetb commented Jan 1, 2025

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 1, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, hashmap-kz

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

The pull request process is described 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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 1, 2025
@k8s-ci-robot k8s-ci-robot merged commit b4147cb into kubernetes-sigs:master Jan 1, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/new-plugin lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

4 participants