-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
javier.juarez
authored and
javier.juarez
committed
May 31, 2021
1 parent
b28792b
commit 75b8f8b
Showing
1 changed file
with
25 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,6 @@ | |
| --> | ||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT SHIELDS --> | ||
| <!-- | ||
| *** I'm using markdown "reference style" links for readability. | ||
|
|
@@ -23,15 +22,9 @@ | |
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <p align="center"> | ||
| <a href="https://github.com/othneildrew/Best-README-Template"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Best-README-Template</h3> | ||
| <h3 align="center">IKS Context Cleaner</h3> | ||
|
|
||
| <p align="center"> | ||
| An awesome README template to jumpstart your projects! | ||
|
|
@@ -48,7 +41,6 @@ | |
| </p> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details open="open"> | ||
| <summary>Table of Contents</summary> | ||
|
|
@@ -71,7 +63,6 @@ | |
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgements">Acknowledgements</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
@@ -80,41 +71,38 @@ | |
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| [![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
| This project could help you to cleanup the default IKS kubernets kube config files to use them in combination with othe toolchain, | ||
| like kubectx, kubie, etc | ||
|
|
||
| There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. | ||
| By default the IBMCloud CLI tool (kubernetes service plugin) gathers the configuration (kubeconfig) to access to your cluster using | ||
| the human readable cluster's name + the cluster ID, which is completely useless for humans and makes very hard to work with other | ||
| tools, so this small utility clean all this stuff and will allow you to use directly the name of the cluster, for example using | ||
| kubie: | ||
|
|
||
| Here's why: | ||
| * Your time should be focused on creating something amazing. A project that solves a problem and helps others | ||
| * You shouldn't be doing the same tasks over and over like creating a README from scratch | ||
| * You should element DRY principles to the rest of your life :smile: | ||
| ```bash | ||
| kubie ctx the_human_readable_name_of_my_k8s_cluster -n kube-system | ||
| ``` | ||
|
|
||
| Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template! | ||
| in just one shot | ||
|
|
||
| A list of commonly used resources that I find helpful are listed in the acknowledgements. | ||
|
|
||
| ### Built With | ||
|
|
||
| This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. | ||
| * [Bootstrap](https://getbootstrap.com) | ||
| * [JQuery](https://jquery.com) | ||
| * [Laravel](https://laravel.com) | ||
|
|
||
| * [golang](https://golang.org) | ||
|
|
||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ```bash | ||
| make build && cat tests/data/kubeconfig_sample.yaml | ./bin/ikscc | ||
| ``` | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
| * npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
| You don't need extra requisite to use this program, just get the release for your OS and execute it | ||
|
|
||
| ### Installation | ||
|
|
||
|
|
@@ -173,43 +161,24 @@ Distributed under the MIT License. See `LICENSE` for more information. | |
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGEMENTS --> | ||
| ## Acknowledgements | ||
| * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| * [Img Shields](https://shields.io) | ||
| * [Choose an Open Source License](https://choosealicense.com) | ||
| * [GitHub Pages](https://pages.github.com) | ||
| * [Animate.css](https://daneden.github.io/animate.css) | ||
| * [Loaders.css](https://connoratherton.com/loaders) | ||
| * [Slick Carousel](https://kenwheeler.github.io/slick) | ||
| * [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) | ||
| * [Sticky Kit](http://leafo.net/sticky-kit) | ||
| * [JVectorMap](http://jvectormap.com) | ||
| * [Font Awesome](https://fontawesome.com) | ||
|
|
||
|
|
||
| Javier Juarez - [@thejtoken](https://twitter.com/thejtoken) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/jjuarez/iks-ctx-cleaner](https://github.com/jjuarez/iks-ctx-cleaner) | ||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors | ||
| [contributors-url]: https://github.com/jjuarez/iks-ctx-cleaner/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/othneildrew/Best-README-Template/network/members | ||
| [forks-url]: https://github.com/jjuarez/iks-ctx-cleaner/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| [stars-url]: https://github.com/jjuarez/iks-ctx-cleaner/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| [issues-url]: https://github.com/jjuarez/iks-ctx-cleaner/issues | ||
| [license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge | ||
| [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| [license-url]: https://github.com/jjuarez/iks-ctx-cleaner/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/in/othneildrew | ||
| [linkedin-url]: https://linkedin.com/in/javierjuarez | ||
| [product-screenshot]: images/screenshot.png | ||
|
|
||