From ef4154e3f44db3034f70511c4295c8a8c7c966c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B0=D0=B2=D0=B5=D0=BB=20=D0=96=D1=83=D0=BA=D0=BE?= =?UTF-8?q?=D0=B2?= <33721692+LeaveMyYard@users.noreply.github.com> Date: Wed, 22 Mar 2023 18:11:24 +0200 Subject: Set template --- README.md | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 258 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b68d47..192418a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,258 @@ -# robusta-krr -Robusta's Resource Recommendation Engine for Kubernetes + + + + + + + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + +
+
+ + Logo + + +

Best-README-Template

+ +

+ An awesome README template to jumpstart your projects! +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ + + +## About The Project + +[![Product Name Screen Shot][product-screenshot]](https://example.com) + +There are many great README templates available on GitHub; however, I didn't find one that really suited 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. + +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 implement DRY principles to the rest of your life :smile: + +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 contributed to expanding this template! + +Use the `BLANK_README.md` to get started. + +

(back to top)

+ +### Built With + +This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. + +- [![Next][next.js]][next-url] +- [![React][react.js]][react-url] +- [![Vue][vue.js]][vue-url] +- [![Angular][angular.io]][angular-url] +- [![Svelte][svelte.dev]][svelte-url] +- [![Laravel][laravel.com]][laravel-url] +- [![Bootstrap][bootstrap.com]][bootstrap-url] +- [![JQuery][jquery.com]][jquery-url] + +

(back to top)

+ + + +## 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. + +### 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 + ``` + +### Installation + +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ + +1. Get a free API Key at [https://example.com](https://example.com) +2. Clone the repo + ```sh + git clone https://github.com/your_username_/Project-Name.git + ``` +3. Install NPM packages + ```sh + npm install + ``` +4. Enter your API in `config.js` + ```js + const API_KEY = "ENTER YOUR API"; + ``` + +

(back to top)

+ + + +## Usage + +Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. + +_For more examples, please refer to the [Documentation](https://example.com)_ + +

(back to top)

+ + + +## Roadmap + +- [x] Add Changelog +- [x] Add back to top links +- [ ] Add Additional Templates w/ Examples +- [ ] Add "components" document to easily copy & paste sections of the readme +- [ ] Multi-language Support + - [ ] Chinese + - [ ] Spanish + +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). + +

(back to top)

+ + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + +

(back to top)

+ + + +## Contact + +Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com + +Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) + +

(back to top)

+ + + +## Acknowledgments + +Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! + +- [Choose an Open Source License](https://choosealicense.com) +- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) +- [Malven's Grid Cheatsheet](https://grid.malven.co/) +- [Img Shields](https://shields.io) +- [GitHub Pages](https://pages.github.com) +- [Font Awesome](https://fontawesome.com) +- [React Icons](https://react-icons.github.io/react-icons/search) + +

(back to top)

+ + + + +[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 +[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 +[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 +[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 +[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 +[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 +[product-screenshot]: images/screenshot.png +[next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white +[next-url]: https://nextjs.org/ +[react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB +[react-url]: https://reactjs.org/ +[vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D +[vue-url]: https://vuejs.org/ +[angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white +[angular-url]: https://angular.io/ +[svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 +[svelte-url]: https://svelte.dev/ +[laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white +[laravel-url]: https://laravel.com +[bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white +[bootstrap-url]: https://getbootstrap.com +[jquery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white +[jquery-url]: https://jquery.com -- cgit v1.2.3 From f6a9b0dfd250a43d697f74a2e1382a757a91180a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B0=D0=B2=D0=B5=D0=BB=20=D0=96=D1=83=D0=BA=D0=BE?= =?UTF-8?q?=D0=B2?= <33721692+LeaveMyYard@users.noreply.github.com> Date: Wed, 22 Mar 2023 21:23:52 +0200 Subject: Template Readme.md --- README.md | 70 ++++++-------------------------------------------- images/logo.png | Bin 0 -> 1674317 bytes images/screenshot.png | Bin 0 -> 119829 bytes 3 files changed, 8 insertions(+), 62 deletions(-) create mode 100644 images/logo.png create mode 100644 images/screenshot.png diff --git a/README.md b/README.md index 192418a..0a59822 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,5 @@ - - - - - - - [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] @@ -29,26 +10,23 @@
- - Logo + + Logo - -

Best-README-Template

- +

Robusta-KRR

- An awesome README template to jumpstart your projects! + A robust knowledge representation and reasoning framework!
- Explore the docs » + Explore the docs »

- View Demo + View Demo · - Report Bug + Report Bug · - Request Feature + Request Feature

-
Table of Contents @@ -74,7 +52,6 @@
  • Acknowledgments
    • - ## About The Project @@ -95,21 +72,6 @@ Use the `BLANK_README.md` to get started.

    (back to top)

    -### Built With - -This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. - -- [![Next][next.js]][next-url] -- [![React][react.js]][react-url] -- [![Vue][vue.js]][vue-url] -- [![Angular][angular.io]][angular-url] -- [![Svelte][svelte.dev]][svelte-url] -- [![Laravel][laravel.com]][laravel-url] -- [![Bootstrap][bootstrap.com]][bootstrap-url] -- [![JQuery][jquery.com]][jquery-url] - -

    (back to top)

    - ## Getting Started @@ -240,19 +202,3 @@ Use this space to list resources you find helpful and would like to give credit [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 [product-screenshot]: images/screenshot.png -[next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white -[next-url]: https://nextjs.org/ -[react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB -[react-url]: https://reactjs.org/ -[vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D -[vue-url]: https://vuejs.org/ -[angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white -[angular-url]: https://angular.io/ -[svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 -[svelte-url]: https://svelte.dev/ -[laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white -[laravel-url]: https://laravel.com -[bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white -[bootstrap-url]: https://getbootstrap.com -[jquery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white -[jquery-url]: https://jquery.com diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..8e6d51d Binary files /dev/null and b/images/logo.png differ diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 0000000..0b5dc36 Binary files /dev/null and b/images/screenshot.png differ -- cgit v1.2.3 From 5f2e544665891748fcd201f5a7d54661d3c23ee8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B0=D0=B2=D0=B5=D0=BB=20=D0=96=D1=83=D0=BA=D0=BE?= =?UTF-8?q?=D0=B2?= <33721692+LeaveMyYard@users.noreply.github.com> Date: Wed, 22 Mar 2023 23:36:12 +0200 Subject: Edit content of Readme --- README.md | 129 ++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 62 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index 0a59822..3fba918 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@

    Robusta-KRR

    - A robust knowledge representation and reasoning framework! + Robusta's Kubernetes Resource Recommender
    Explore the docs »
    @@ -58,17 +58,9 @@ [![Product Name Screen Shot][product-screenshot]](https://example.com) -There are many great README templates available on GitHub; however, I didn't find one that really suited 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. +Robusta's Kubernetes Resource Recommender (KRR) is a tool that helps users to optimize the resource usage of their Kubernetes clusters. It is based on the Prometheus monitoring system and the Kubernetes API. It is designed to be used both as a CLI tool or as a Kubernetes operator. It is also designed to be easily integrated into Robusta UI, so if you are already using it you can easily start using KRR. -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 implement DRY principles to the rest of your life :smile: - -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 contributed to expanding this template! - -Use the `BLANK_README.md` to get started. +This tool is also designed to be easily extensible. It is possible to add additional calculation strategies yourself, if you want to use a different strategy than the ones provided by default.

    (back to top)

    @@ -79,58 +71,78 @@ Use the `BLANK_README.md` to get 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. -### Prerequisites +### Installation -This is an example of how to list things you need to use the software and how to install them. +_Depending on your operating system, select the appropriate installation method._ -- npm - ```sh - npm install npm@latest -g - ``` +#### Linux -### Installation +```sh +sudo apt install robusta-krr +``` -_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ - -1. Get a free API Key at [https://example.com](https://example.com) -2. Clone the repo - ```sh - git clone https://github.com/your_username_/Project-Name.git - ``` -3. Install NPM packages - ```sh - npm install - ``` -4. Enter your API in `config.js` - ```js - const API_KEY = "ENTER YOUR API"; - ``` +#### MacOS -

    (back to top)

    +```sh +brew install robusta-krr +``` - +#### Windows -## Usage +```sh +choco install robusta-krr +``` + +#### Debian + +```sh +sudo apt install robusta-krr +``` + +#### Docker + +```sh +docker pull robusta/krr +``` + +#### Manual + +1. Make sure you have [Python 3.11](https://www.python.org/downloads/) installed. +2. -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. +```sh +git clone https://github.com/robusta-dev/robusta-krr +``` -_For more examples, please refer to the [Documentation](https://example.com)_ +3. Install poetry (the package manager): + +```sh +pip install poetry +``` + +4. Install the dependencies: + +```sh +poetry install +``` + +5. Run the tool: + +```sh +poetry run krr +```

    (back to top)

    - + -## Roadmap +## Usage -- [x] Add Changelog -- [x] Add back to top links -- [ ] Add Additional Templates w/ Examples -- [ ] Add "components" document to easily copy & paste sections of the readme -- [ ] Multi-language Support - - [ ] Chinese - - [ ] Spanish +A simple exaple of how to run the "Simple" strategy: -See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). +```sh +krr simple +```

    (back to top)

    @@ -163,26 +175,9 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. ## Contact -Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com - -Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) - -

    (back to top)

    - - - -## Acknowledgments - -Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! +If you have any questions, feel free to contact support@robusta.dev -- [Choose an Open Source License](https://choosealicense.com) -- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) -- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) -- [Malven's Grid Cheatsheet](https://grid.malven.co/) -- [Img Shields](https://shields.io) -- [GitHub Pages](https://pages.github.com) -- [Font Awesome](https://fontawesome.com) -- [React Icons](https://react-icons.github.io/react-icons/search) +Project Link: [https://github.com/robusta-dev/robusta-krr](https://github.com/robusta-dev/robusta-krr)

    (back to top)

    -- cgit v1.2.3 From effa3de244f9bcd6f5abb5a9da4d1f8a437383bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B0=D0=B2=D0=B5=D0=BB=20=D0=96=D1=83=D0=BA=D0=BE?= =?UTF-8?q?=D0=B2?= <33721692+LeaveMyYard@users.noreply.github.com> Date: Wed, 22 Mar 2023 23:43:07 +0200 Subject: Upload a newer image --- images/screenshot.png | Bin 119829 -> 429610 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/images/screenshot.png b/images/screenshot.png index 0b5dc36..1ad5461 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ -- cgit v1.2.3 From a7e137633e895c0f167262c20fa409fccc4202e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9F=D0=B0=D0=B2=D0=B5=D0=BB=20=D0=96=D1=83=D0=BA=D0=BE?= =?UTF-8?q?=D0=B2?= <33721692+LeaveMyYard@users.noreply.github.com> Date: Sun, 26 Mar 2023 20:36:08 +0300 Subject: Change KRR to KubeKraken --- README.md | 4 ++-- robusta_krr/main.py | 2 +- robusta_krr/utils/logo.py | 12 ++++++------ 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3fba918..5533b76 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Logo -

    Robusta-KRR

    +

    Robusta's KubeKraken

    - Robusta's Kubernetes Resource Recommender + Prometheus-based Kubernetes Resource Recommendations
    Explore the docs »
    diff --git a/robusta_krr/main.py b/robusta_krr/main.py index f130259..48a415e 100644 --- a/robusta_krr/main.py +++ b/robusta_krr/main.py @@ -53,7 +53,7 @@ for strategy_name, strategy_type in BaseStrategy.get_all().items(): # type: ign quiet: bool = typer.Option(False, "--quiet", "-q", help="Enable quiet mode", rich_help_panel="Logging Settings"), {strategy_settings}, ) -> None: - '''Run KRR using the `{func_name}` strategy''' + '''Run KubeKraken using the `{func_name}` strategy''' config = Config( prometheus_url=prometheus_url, diff --git a/robusta_krr/utils/logo.py b/robusta_krr/utils/logo.py index a6b9641..a35f05c 100644 --- a/robusta_krr/utils/logo.py +++ b/robusta_krr/utils/logo.py @@ -1,11 +1,11 @@ ASCII_LOGO = r""" [bold magenta] - _____ _ _ _ _______ _____ - | __ \ | | | | | |/ / __ \| __ \ - | |__) |___ | |__ _ _ ___| |_ __ _ | ' /| |__) | |__) | - | _ // _ \| '_ \| | | / __| __/ _` | | < | _ /| _ / - | | \ \ (_) | |_) | |_| \__ \ || (_| | | . \| | \ \| | \ \ - |_| \_\___/|_.__/ \__,_|___/\__\__,_| |_|\_\_| \_\_| \_\ + _ __ _ _ __ _ +| | / / | | | | / / | | +| |/ / _ _| |__ ___| |/ / _ __ __ _| | _____ _ __ +| \| | | | '_ \ / _ \ \| '__/ _` | |/ / _ \ '_ \ +| |\ \ |_| | |_) | __/ |\ \ | | (_| | < __/ | | | +\_| \_/\__,_|_.__/ \___\_| \_/_| \__,_|_|\_\___|_| |_| [/bold magenta] """ -- cgit v1.2.3