From 26f13a47634327ddeb63752f3b27aa92ff70e699 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Wed, 4 Oct 2023 14:46:26 +0530
Subject: [PATCH 1/7] Update README.md
---
README.md | 38 ++++++++++++++++++++++++--------------
1 file changed, 24 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 3848e9fba..9a80538cd 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@
+Komiser is an open-source cloud-agnostic resource manager designed to analyze and manage cloud cost, usage, security, and governance all in one place. It integrates seamlessly with multiple cloud providers, including AWS, Azure, Civo, Digital Ocean, OCI, Linode, Tencent, Scaleway and [more](#supported-cloud-providers).
+
Discord |
Tailwarden Cloud |
@@ -25,7 +27,7 @@
[![Price](https://img.shields.io/badge/price-FREE-0098f7.svg)](https://github.com/tailwarden/komiser/blob/master/LICENSE) [![Docker Stars](https://img.shields.io/docker/pulls/mlabouardy/komiser.svg)](https://hub.docker.com/r/mlabouardy/komiser)
[![ELv2 License](https://img.shields.io/badge/license-ELv2-green)](LICENSE) [![Docker Stars](https://img.shields.io/github/issues/tailwarden/komiser.svg)](https://github.com/tailwarden/komiser/issues) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.tailwarden.com/)
-Komiser is an open-source cloud-agnostic resource manager. It integrates with multiple cloud providers (including AWS, Azure, Civo, Digital Ocean, OCI, Linode, Tencent and Scaleway), builds a cloud asset inventory, and helps you break down your cost at the resource level ๐ฐ
+
@@ -72,7 +74,7 @@ brew install komiser
-# What is Komiser? ๐คท
+## What is Komiser? ๐คท
Komiser is an open source project created to **analyse** and **manage cloud cost**, **usage**, **security** and **governance** all in one place. With komiser you can also:
* Build an inventory of your cloud infrastructure assets.
* Control your **resource usage** and gain visibility across all used services to achieve maximum cost-effectiveness.
@@ -85,6 +87,10 @@ Komiser is an open source project created to **analyse** and **manage cloud cost
## Who is using it?
Komiser was built with every Cloud Engineer, Developer, DevOps engineer and SRE in mind. We understand that tackling cost savings, security improvements and resource usage analyse efforts can be hard, sometimes just knowing where to start, can be the most challenging part at times. Komiser is here to help those cloud practitioners see their cloud resources and accounts much more clearly. Only with clear insight can timely and efficient actions take place.
+## Supported cloud providers
+
+
+
# Getting started ๐
## Download
@@ -107,7 +113,7 @@ Watch the installation [video here](https://www.youtube.com/watch?v=4veDmJpui44&
## Installation on Azure
-Connect a local deployment of Komiser CLI to you [**Azure**](https://docs.komiser.io/docs/cloud-providers/azure?utm_source=github&utm_medium=social) account.
+Connect a local deployment of Komiser CLI to you [**Azure**](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social) account.
## Installation on GCP
@@ -139,13 +145,13 @@ Connect a local deployment of Komiser CLI to you [**Tencent**](https://docs.komi
Connect a local deployment of Komiser CLI to you [**Scaleway**](https://docs.komiser.io/docs/cloud-providers/scaleway?utm_source=github&utm_medium=social) account.
-# Documentation ๐
+## Documentation ๐
Head over to the official `Komiser` documentation at [docs.komiser.io](https://docs.komiser.io?utm_source=github&utm_medium=social). The source repository for the documentation website is [tailwarden/docs.komiser.io](https://github.com/tailwarden/docs.komiser.io).
We know that writing docs isn't usually at the top of too many peoples "What I like to do for fun" list, but if you feel so inclined, by all means, consider [contributing](https://docs.komiser.io/docs/contributing/contribute?utm_source=github&utm_medium=social) to our documentation repository, we will be very grateful. It's built using [Docusaurus](https://docusaurus.io/).
-## Jump right in:
+### Jump right in:
* [Documentation overview](https://docs.komiser.io/docs/intro?utm_source=github&utm_medium=social)
* [Installation](https://docs.komiser.io/docs/introduction/getting-started?utm_source=github&utm_medium=social)
* [FAQs](https://docs.komiser.io/docs/faqs?utm_source=github&utm_medium=social)
@@ -153,33 +159,37 @@ We know that writing docs isn't usually at the top of too many peoples "What I l
* [How to: Komiser](https://www.youtube.com/watch?v=9pCimmIT-HQ&list=PLFIcIMmOFDZeMzcvOi7bPd4I6xUNq3A5R/alerts)
* [Installation videos](https://www.youtube.com/watch?v=urxi9z2IUf4&list=PLFIcIMmOFDZfaO_WmUF_qnF8akCII7Uk_)
-# Bugs and feature requests ๐
+## Bugs and feature requests ๐
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/tailwarden/komiser/issues).
-# Roadmap and Contributing ๐ฃ๏ธ
+## Roadmap and Contributing ๐ฃ๏ธ
We are very excited about what is in store in the coming weeks and months, take a look at the [public roadmap](https://roadmap.tailwarden.com/) to stay on top of what's coming down the pipeline.
-Komiser is written in `Golang` and is `Elv2 licensed` - contributions are always welcome whether that means providing feedback, be it through GitHub, through the `#feedback` channel on our [Discord server](https://discord.tailwarden.com) or testing existing and new features. Feel free to check out our [contributor guidelines](./CONTRIBUTING.md) and consider becoming a **contributor** today.
+Komiser is written in `Golang` and is `Elv2 licensed` - contributions are always welcome whether that means providing feedback through GitHub, through the `#feedback` channel on our [Discord server](https://discord.tailwarden.com), testing existing features or suggesting new ones. Feel free to check out our [contributor guidelines](./CONTRIBUTING.md) and consider becoming a **contributor** today.
Learn how to contribute with these walkthrough videos:
- [How to contribute to Komiser engine](https://www.youtube.com/watch?v=Vn5uc2elcVg)
- [How to contribute to Komiser dashboard](https://www.youtube.com/watch?v=uwxj11-eRt8)
-# Users ๐งโ๐คโ๐ง
+## Users ๐งโ๐คโ๐ง
If you'd like to have your company represented and are using `Komiser` please give formal written permission below via email to contact@tailwarden.com.
We will need a URL to an SVG or png logo, a text title, and a company URL.
-# Versioning ๐งฎ
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tailwarden/komiser/tags).
-
-# Contributors
+## Contributors
+
+## Versioning ๐งฎ
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tailwarden/komiser/tags).
+
+## License
+
+Komiser is licensed under the terms of [Elastic License 2.0 (ELv2)](https://github.com/tailwarden/komiser/blob/release/LICENSE).
From cb7b2eb1aa1a0e6d06ac2f226a0cc3109eee2da0 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Thu, 5 Oct 2023 05:38:33 +0530
Subject: [PATCH 2/7] Update README.md
---
README.md | 107 +++++++++++++++++++++++++++++++-----------------------
1 file changed, 61 insertions(+), 46 deletions(-)
diff --git a/README.md b/README.md
index 9a80538cd..817f42387 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,26 @@
-Komiser is an open-source cloud-agnostic resource manager designed to analyze and manage cloud cost, usage, security, and governance all in one place. It integrates seamlessly with multiple cloud providers, including AWS, Azure, Civo, Digital Ocean, OCI, Linode, Tencent, Scaleway and [more](#supported-cloud-providers).
+Komiser is an open-source cloud-agnostic resource manager designed to analyze and manage cloud cost, usage, security, and governance all in one place. It integrates seamlessly with multiple cloud providers, including AWS, Azure, Civo, Digital Ocean, OCI, Linode, Tencent, Scaleway and [more](#supported-cloud-providers). Interested? read more about Komiser on our [website](https://komiser.io?utm_source=github&utm_medium=social).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Discord |
Tailwarden Cloud |
- Website
Guide |
How to Komiser |
Community Events
@@ -23,11 +37,6 @@ Komiser is an open-source cloud-agnostic resource manager designed to analyze an
-[![Build and Test komiser](https://github.com/tailwarden/komiser/actions/workflows/build_test.yml/badge.svg)](https://github.com/tailwarden/komiser/actions/workflows/build_test.yml)
-[![Price](https://img.shields.io/badge/price-FREE-0098f7.svg)](https://github.com/tailwarden/komiser/blob/master/LICENSE) [![Docker Stars](https://img.shields.io/docker/pulls/mlabouardy/komiser.svg)](https://hub.docker.com/r/mlabouardy/komiser)
-[![ELv2 License](https://img.shields.io/badge/license-ELv2-green)](LICENSE) [![Docker Stars](https://img.shields.io/github/issues/tailwarden/komiser.svg)](https://github.com/tailwarden/komiser/issues) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.tailwarden.com/)
-
-
@@ -89,52 +98,67 @@ Komiser was built with every Cloud Engineer, Developer, DevOps engineer and SRE
## Supported cloud providers
+## Getting started
+### Installation
-# Getting started ๐
-
-## Download
-
-You can run Komiser locally, as a Docker container or by running it inside a Kubernetes cluster.
-Below are the available downloads for the latest version of Komiser. Please [download](https://docs.komiser.io/docs/introduction/getting-started?utm_source=github&utm_medium=social) the appropriate package for your operating system and architecture.
+#### Linux
-## Installation on AWS
+```
+wget https://cli.komiser.io/latest/komiser_Linux_x86_64 -O komiser
+```
-### Connect Komiser CLI to your AWS account.
-* Connect a [local deployment](https://docs.komiser.io/docs/cloud-providers/aws/#local-komiser-cli) of Komiser CLI to you AWS account
+#### Windows
-### Deploy Komiser to single account access EKS cluster (Helm chart)
-* If you want to connect a single AWS account follow the documentation [here](https://docs.komiser.io/docs/cloud-providers/aws/#eks-installation-single-account).
+```
+wget https://cli.komiser.io/latest/komiser_Windows_x86_64.zip
+tar -xf komiser_Windows_x86_64.zip
+```
-Watch the installation [video here](https://www.youtube.com/watch?v=4veDmJpui44&t)
+#### Mac OS X
-### Deploy Komiser to a multi account access EKS cluster (Helm chart)
-* If you would like to connect various AWS accounts to a Komiser deployment in a Management EKS cluster, follow the steps [here](https://docs.komiser.io/docs/cloud-providers/aws/#multiple-account-eks-helm-chart-installation).
+ARM architecture (M1 & M2 Chip)
+```
+wget https://cli.komiser.io/latest/komiser_Darwin_arm64 -O komiser
+```
-## Installation on Azure
+AMD architecture (Intel Chip)
+```
+wget https://cli.komiser.io/latest/komiser_Darwin_x86_64 -O komiser
+```
-Connect a local deployment of Komiser CLI to you [**Azure**](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social) account.
+#### Homebrew
+```
+brew update
+brew tap tailwarden/komiser
+brew install komiser
-## Installation on GCP
+# Make sure you are running the newest version of Komiser:
+brew update
+brew reinstall komiser
+```
-Connect a local deployment of Komiser CLI to you [**GCP**](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social) account.
+### Configuration
-## Installation on Civo
+| Providers | Documentation |
+| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Kubernetes documentation link](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=organic&utm_campaign=readme) |
+| [![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=organic&utm_campaign=readme) | [AWS documentation link ](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=organic&utm_campaign=readme) |
+| [![Azure](https://img.shields.io/badge/azure-%230078D4.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Azure documentation link](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=organic&utm_campaign=readme) |
+| [![Civo](https://img.shields.io/badge/Civo-%23239DFF.svg?style=for-the-badge&logo=civo&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Civo documentation link](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=organic&utm_campaign=readme) |
+| [![Digital Ocean](https://img.shields.io/badge/DigitalOcean-%230080FF.svg?style=for-the-badge&logo=digitalocean&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Digital Ocean documentation link](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=organic&utm_campaign=readme) |
+| [![Akamai (Linode)](https://img.shields.io/badge/Akamai-%230096D6.svg?style=for-the-badge&logo=akamai&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Akamai (Linode) documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-Connect a local deployment of Komiser CLI to your [**Civo**](https://docs.komiser.io/docs/cloud-providers/civo?utm_source=github&utm_medium=social) account.
-Watch the installation [video here](https://www.youtube.com/watch?v=NBbEpoW-kVs)
-## Installation on OCI
-Connect a local deployment of Komiser CLI to your [**OCI**](https://docs.komiser.io/docs/cloud-providers/oci?utm_source=github&utm_medium=social) account.
-## Installation on Digital Ocean
+## Installation on GCP
-Connect a local deployment of Komiser CLI to you [**Digital Ocean**](https://docs.komiser.io/docs/cloud-providers/digital-ocean?utm_source=github&utm_medium=social) account.
+Connect a local deployment of Komiser CLI to you [**GCP**](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social) account.
-## Installation on Linode
+## Installation on OCI
-Connect a local deployment of Komiser CLI to you [**Linode**](https://docs.komiser.io/docs/cloud-providers/linode?utm_source=github&utm_medium=social) account.
+Connect a local deployment of Komiser CLI to your [**OCI**](https://docs.komiser.io/docs/cloud-providers/oci?utm_source=github&utm_medium=social) account.
## Installation on Tencent Cloud
@@ -145,19 +169,10 @@ Connect a local deployment of Komiser CLI to you [**Tencent**](https://docs.komi
Connect a local deployment of Komiser CLI to you [**Scaleway**](https://docs.komiser.io/docs/cloud-providers/scaleway?utm_source=github&utm_medium=social) account.
-## Documentation ๐
-
-Head over to the official `Komiser` documentation at [docs.komiser.io](https://docs.komiser.io?utm_source=github&utm_medium=social). The source repository for the documentation website is [tailwarden/docs.komiser.io](https://github.com/tailwarden/docs.komiser.io).
+## Resources ๐
-We know that writing docs isn't usually at the top of too many peoples "What I like to do for fun" list, but if you feel so inclined, by all means, consider [contributing](https://docs.komiser.io/docs/contributing/contribute?utm_source=github&utm_medium=social) to our documentation repository, we will be very grateful. It's built using [Docusaurus](https://docusaurus.io/).
+* [Documentation](https://docs.komiser.io?utm_source=github&utm_medium=social)
-### Jump right in:
-* [Documentation overview](https://docs.komiser.io/docs/intro?utm_source=github&utm_medium=social)
-* [Installation](https://docs.komiser.io/docs/introduction/getting-started?utm_source=github&utm_medium=social)
-* [FAQs](https://docs.komiser.io/docs/faqs?utm_source=github&utm_medium=social)
-* Video series: ๐น
- * [How to: Komiser](https://www.youtube.com/watch?v=9pCimmIT-HQ&list=PLFIcIMmOFDZeMzcvOi7bPd4I6xUNq3A5R/alerts)
- * [Installation videos](https://www.youtube.com/watch?v=urxi9z2IUf4&list=PLFIcIMmOFDZfaO_WmUF_qnF8akCII7Uk_)
## Bugs and feature requests ๐
From ea3f6c4b9d4575f1af13567e4871c2f477c4f6c6 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Thu, 5 Oct 2023 15:44:24 +0530
Subject: [PATCH 3/7] Update README.md
---
README.md | 41 ++++++++++++++---------------------------
1 file changed, 14 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index 817f42387..4eda74622 100644
--- a/README.md
+++ b/README.md
@@ -140,38 +140,25 @@ brew reinstall komiser
### Configuration
-| Providers | Documentation |
-| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Kubernetes documentation link](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-| [![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=organic&utm_campaign=readme) | [AWS documentation link ](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-| [![Azure](https://img.shields.io/badge/azure-%230078D4.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Azure documentation link](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-| [![Civo](https://img.shields.io/badge/Civo-%23239DFF.svg?style=for-the-badge&logo=civo&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Civo documentation link](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-| [![Digital Ocean](https://img.shields.io/badge/DigitalOcean-%230080FF.svg?style=for-the-badge&logo=digitalocean&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Digital Ocean documentation link](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-| [![Akamai (Linode)](https://img.shields.io/badge/Akamai-%230096D6.svg?style=for-the-badge&logo=akamai&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=organic&utm_campaign=readme) | [Akamai (Linode) documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=organic&utm_campaign=readme) |
-
-
-
-
-## Installation on GCP
-
-Connect a local deployment of Komiser CLI to you [**GCP**](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social) account.
-
-## Installation on OCI
-
-Connect a local deployment of Komiser CLI to your [**OCI**](https://docs.komiser.io/docs/cloud-providers/oci?utm_source=github&utm_medium=social) account.
-
-## Installation on Tencent Cloud
-
-Connect a local deployment of Komiser CLI to you [**Tencent**](https://docs.komiser.io/docs/cloud-providers/tencent?utm_source=github&utm_medium=social) account.
-
-## Installation on Scaleway
-
-Connect a local deployment of Komiser CLI to you [**Scaleway**](https://docs.komiser.io/docs/cloud-providers/scaleway?utm_source=github&utm_medium=social) account.
+| Providers | Documentation | Video |
+| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
+| [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | [Kubernetes documentation link](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | [AWS documentation link ](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Azure](https://img.shields.io/badge/azure-%230078D4.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social&utm_campaign=readme) | [Azure documentation link](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Civo](https://img.shields.io/badge/Civo-%23239DFF.svg?style=for-the-badge&logo=civo&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | [Civo documentation link](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Digital Ocean](https://img.shields.io/badge/DigitalOcean-%230080FF.svg?style=for-the-badge&logo=digitalocean&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=social&utm_campaign=readme) | [Digital Ocean documentation link](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Akamai (Linode)](https://img.shields.io/badge/Akamai-%230096D6.svg?style=for-the-badge&logo=akamai&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | [Akamai (Linode) documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![GCP](https://img.shields.io/badge/GCP-%234285F4.svg?style=for-the-badge&logo=googlecloud&logoColor=white)](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social&utm_campaign=readme) | [GCP documentation link](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![OCI](https://img.shields.io/badge/OCI-%23F80000.svg?style=for-the-badge&logo=oracle&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/oracle?utm_source=github&utm_medium=social&utm_campaign=readme) | [Oracle Cloud Infrastructure documentation link](https://docs.komiser.io/configuration/cloud-providers/oracle?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Tencent Cloud](https://img.shields.io/badge/Tencent-%230096D6.svg?style=for-the-badge&logo=tencentcloud&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | [Tencent Cloud documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Scaleway](https://img.shields.io/badge/Scaleway-%234F0599.svg?style=for-the-badge&logo=scaleway&logoColor=white)](https://docs.komiser.io/docs/cloud-providers/scaleway?utm_source=github&utm_medium=social&utm_campaign=readme) | [Scaleway documentation link](https://docs.komiser.io/docs/cloud-providers/scaleway?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![MongoDB Atlas](https://img.shields.io/badge/MongoDB-%2347A248.svg?style=for-the-badge&logo=mongodb&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | [MongoDB Atlas documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | |
## Resources ๐
* [Documentation](https://docs.komiser.io?utm_source=github&utm_medium=social)
+* [Videos](https://www.youtube.com/@tailwarden/videos)
## Bugs and feature requests ๐
From 5e453377c55f5f4075ae057e00341a25da629cd1 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Thu, 5 Oct 2023 18:27:42 +0530
Subject: [PATCH 4/7] Update README.md
---
README.md | 38 +++++++++++---------------------------
1 file changed, 11 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index 4eda74622..f461e43e2 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
Komiser is an open-source cloud-agnostic resource manager designed to analyze and manage cloud cost, usage, security, and governance all in one place. It integrates seamlessly with multiple cloud providers, including AWS, Azure, Civo, Digital Ocean, OCI, Linode, Tencent, Scaleway and [more](#supported-cloud-providers). Interested? read more about Komiser on our [website](https://komiser.io?utm_source=github&utm_medium=social).
+If youโre using Komiser or if you like the project, please โญ this repository to show your support! ๐คฉ
+
@@ -22,6 +24,8 @@ Komiser is an open-source cloud-agnostic resource manager designed to analyze an
+
+
Tailwarden Cloud |
Guide |
@@ -31,28 +35,6 @@ Komiser is an open-source cloud-agnostic resource manager designed to analyze an
Roadmap
-
-
-
-
-
-
-
-
-
-The fastest and most reliable way to get started with Komiser is signing up for free to [Tailwarden Cloud](https://cloud.tailwarden.com?utm_source=github&utm_medium=social)
-
-[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40Komiser)](https://twitter.com/komiserdotio) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Optimize%20Cost%20and%20Security%20on%20AWS&url=https://github.com/tailwarden/komiser&via=mlabouardy&hashtags=komiser,aws,gcp,cloud,serverless,devops)
-
-## Komiser CLI, try it out! ๐
----
-The easiest way to get started with Komiser is to install the [Komiser CLI](https://docs.komiser.io/docs/introduction/getting-started?utm_source=github&utm_medium=social) by running the `Homebrew` commands below. Don't have Homebrew? Install it [here](https://docs.brew.sh/Installation).
-
-```
-brew tap tailwarden/komiser
-brew install komiser
-```
-
**Table of Contents**
@@ -96,12 +78,14 @@ Komiser is an open source project created to **analyse** and **manage cloud cost
## Who is using it?
Komiser was built with every Cloud Engineer, Developer, DevOps engineer and SRE in mind. We understand that tackling cost savings, security improvements and resource usage analyse efforts can be hard, sometimes just knowing where to start, can be the most challenging part at times. Komiser is here to help those cloud practitioners see their cloud resources and accounts much more clearly. Only with clear insight can timely and efficient actions take place.
-## Supported cloud providers
-
## Getting started
### Installation
+#### Tailwarden Cloud (Free & Recommended)
+
+Head over to [Tailwarden](https://cloud.tailwarden.com?utm_source=github&utm_medium=social&utm_campaign=readme).
+
#### Linux
```
@@ -142,10 +126,10 @@ brew reinstall komiser
| Providers | Documentation | Video |
| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
-| [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | [Kubernetes documentation link](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | |
-| [![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | [AWS documentation link ](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | [Kubernetes documentation link](https://docs.komiser.io/configuration/cloud-providers/k8s?utm_source=github&utm_medium=social&utm_campaign=readme) | [Komiser + k8s](https://youtu.be/hSiVFjD0u3I) |
+| [![AWS](https://img.shields.io/badge/AWS-%23FF9900.svg?style=for-the-badge&logo=amazon-aws&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | [AWS documentation link ](https://docs.komiser.io/configuration/cloud-providers/aws?utm_source=github&utm_medium=social&utm_campaign=readme) | [Komiser + AWS EKS](https://youtu.be/4veDmJpui44) |
| [![Azure](https://img.shields.io/badge/azure-%230078D4.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social&utm_campaign=readme) | [Azure documentation link](https://docs.komiser.io/configuration/cloud-providers/azure?utm_source=github&utm_medium=social&utm_campaign=readme) | |
-| [![Civo](https://img.shields.io/badge/Civo-%23239DFF.svg?style=for-the-badge&logo=civo&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | [Civo documentation link](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | |
+| [![Civo](https://img.shields.io/badge/Civo-%23239DFF.svg?style=for-the-badge&logo=civo&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | [Civo documentation link](https://docs.komiser.io/configuration/cloud-providers/civo?utm_source=github&utm_medium=social&utm_campaign=readme) | [Komiser + Civo](https://youtu.be/NBbEpoW-kVs) |
| [![Digital Ocean](https://img.shields.io/badge/DigitalOcean-%230080FF.svg?style=for-the-badge&logo=digitalocean&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=social&utm_campaign=readme) | [Digital Ocean documentation link](https://docs.komiser.io/configuration/cloud-providers/digital-ocean?utm_source=github&utm_medium=social&utm_campaign=readme) | |
| [![Akamai (Linode)](https://img.shields.io/badge/Akamai-%230096D6.svg?style=for-the-badge&logo=akamai&logoColor=white)](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | [Akamai (Linode) documentation link](https://docs.komiser.io/configuration/cloud-providers/linode?utm_source=github&utm_medium=social&utm_campaign=readme) | |
| [![GCP](https://img.shields.io/badge/GCP-%234285F4.svg?style=for-the-badge&logo=googlecloud&logoColor=white)](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social&utm_campaign=readme) | [GCP documentation link](https://docs.komiser.io/docs/cloud-providers/google-cloud-platform?utm_source=github&utm_medium=social&utm_campaign=readme) | |
From 7e865c5778759ede1bf8081b7f667e6bb49d7997 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Thu, 5 Oct 2023 18:29:26 +0530
Subject: [PATCH 5/7] Update README.md
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index f461e43e2..0a93190b5 100644
--- a/README.md
+++ b/README.md
@@ -143,6 +143,7 @@ brew reinstall komiser
* [Documentation](https://docs.komiser.io?utm_source=github&utm_medium=social)
* [Videos](https://www.youtube.com/@tailwarden/videos)
+* [Blog](https://www.tailwarden.com/blog)
## Bugs and feature requests ๐
From 92f9e092934a97c320d3800c3be0cfd69c3992f8 Mon Sep 17 00:00:00 2001
From: Azanul
Date: Mon, 9 Oct 2023 09:52:42 +0530
Subject: [PATCH 6/7] doctoc
Signed-off-by: Azanul
---
README.md | 39 +++++++++++++++++----------------------
1 file changed, 17 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 0a93190b5..459a4a253 100644
--- a/README.md
+++ b/README.md
@@ -39,29 +39,24 @@ If youโre using Komiser or if you like the project, please โญ this repository
**Table of Contents**
-- [What is Komiser? ๐คท](#what-is-komiser-)
+- [](#)
+ - [What is Komiser? ๐คท](#what-is-komiser-)
- [Who is using it?](#who-is-using-it)
-- [Getting started ๐](#getting-started-)
- - [Download](#download)
- - [Installation on AWS](#installation-on-aws)
- - [Connect Komiser CLI to your AWS account.](#connect-komiser-cli-to-your-aws-account)
- - [Deploy Komiser to single account access EKS cluster (Helm chart)](#deploy-komiser-to-single-account-access-eks-cluster-helm-chart)
- - [Deploy Komiser to a multi account access EKS cluster (Helm chart)](#deploy-komiser-to-a-multi-account-access-eks-cluster-helm-chart)
- - [Installation on Azure](#installation-on-azure)
- - [Installation on GCP](#installation-on-gcp)
- - [Installation on Civo](#installation-on-civo)
- - [Installation on OCI](#installation-on-oci)
- - [Installation on Digital Ocean](#installation-on-digital-ocean)
- - [Installation on Linode](#installation-on-linode)
- - [Installation on Tencent Cloud](#installation-on-tencent-cloud)
- - [Installation on Scaleway](#installation-on-scaleway)
-- [Documentation ๐](#documentation-)
- - [Jump right in:](#jump-right-in)
-- [Bugs and feature requests ๐](#bugs-and-feature-requests-)
-- [Roadmap and Contributing ๐ฃ๏ธ](#roadmap-and-contributing-๏ธ)
-- [Users ๐งโ๐คโ๐ง](#users-)
-- [Versioning ๐งฎ](#versioning-)
-- [Contributors](#contributors)
+ - [Getting started](#getting-started)
+ - [Installation](#installation)
+ - [Tailwarden Cloud (Free & Recommended)](#tailwarden-cloud-free--recommended)
+ - [Linux](#linux)
+ - [Windows](#windows)
+ - [Mac OS X](#mac-os-x)
+ - [Homebrew](#homebrew)
+ - [Configuration](#configuration)
+ - [Resources ๐](#resources-)
+ - [Bugs and feature requests ๐](#bugs-and-feature-requests-)
+ - [Roadmap and Contributing ๐ฃ๏ธ](#roadmap-and-contributing-)
+ - [Users ๐งโ๐คโ๐ง](#users-)
+ - [Contributors](#contributors)
+ - [Versioning ๐งฎ](#versioning-)
+ - [License](#license)
From 94881a18422cdefd2fb9644b0bca00864b16ea76 Mon Sep 17 00:00:00 2001
From: Azanul Haque <42029519+Azanul@users.noreply.github.com>
Date: Mon, 9 Oct 2023 17:41:36 +0530
Subject: [PATCH 7/7] remove OVH from README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 459a4a253..ce3a84c85 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,7 @@ Komiser is an open source project created to **analyse** and **manage cloud cost
* Build an inventory of your cloud infrastructure assets.
* Control your **resource usage** and gain visibility across all used services to achieve maximum cost-effectiveness.
* Detect **potential vulnerabilities** that could put your cloud environment at risk.
-* Get a deep understanding of **how you spend** on the AWS, Azure, GCP, Civo, OVH, DigitalOcean and OCI.
+* Get a deep understanding of **how you spend** on the AWS, Azure, GCP, Civo, DigitalOcean and OCI.
* Uncover idle and untagged resources, ensuring that no resource goes unnoticed.