Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brittandeyoung/ckia
ckia (cloud know it all), an open source tool for making recommendations for target cloud account. An open source alternative to AWS Trusted Advisor.
https://github.com/brittandeyoung/ckia
aws cost-optimization security
Last synced: 4 months ago
JSON representation
ckia (cloud know it all), an open source tool for making recommendations for target cloud account. An open source alternative to AWS Trusted Advisor.
- Host: GitHub
- URL: https://github.com/brittandeyoung/ckia
- Owner: brittandeyoung
- License: mpl-2.0
- Created: 2023-02-10T20:37:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-14T10:40:40.000Z (over 1 year ago)
- Last Synced: 2024-10-04T13:15:39.238Z (5 months ago)
- Topics: aws, cost-optimization, security
- Language: Go
- Homepage:
- Size: 266 KB
- Stars: 21
- Watchers: 6
- Forks: 5
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# CKIA
[](code_of_conduct.md)
> **Warning**
> This project is currently a very early Work In Progress. Please pay attention to releases for potential breaking changes. At this time we are not providing Cost Savings Estimations, we are still working out how to best provide these numbers in the most accurate manner with the given AWS apis.
\[SEE\] + \[KEE\] + \[UH\]
ckia (cloud know it all) is a open source command line tool that is intended to run opinionated checks against your cloud environment and provide recommendations. The full suite of AWS trusted advisor checks is the inspiration for this project, but we intend to support many cloud providers when the product has fully matured. Our current focus is providing check parity with the current AWS Trusted Advisor offerings.
The key features of CKIA are:
- **Cloud Auditing and Recomendations**: Audit your cloud configuration for:
1. best practices
2. cost optimizations
3. performance Improvements
4. security misconfigurations
5. Fault Tolerance recommendation
6. Service limits
Each Check additionally provides recommended actions for when a check is failing.
# Available Checks
We are currently focused on duplicating the AWS Trusted advisor checks, but are willing to accept contributions to any cloud provider.
[Current List of Available Checks](AVAILABLE_CHECKS.md)
# Contributing
Please refer to our [Contributors Guide](CONTRIBUTING.md)
# Installation Guide
Documentation is currently a work in progress. This README will contain the majority of the documentation for now.
To install the latest version of CKIA, download the correct package for your operating system and architecture from the latest release. Below is an example for automating this process for Linux. Modify this to match your OS and architecture:
```shell
LATEST_VERSION=$(wget -O - "https://api.github.com/repos/brittandeyoung/ckia/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/' | cut -c 2-)
wget "https://github.com/brittandeyoung/ckia/releases/download/v${LATEST_VERSION}/ckia_${LATEST_VERSION}_Linux_amd64.tar.gz"
tar xzf ckia_${LATEST_VERSION}_Linux_amd64.tar.gz
chmod +x ckia
sudo mv ckia /usr/local/bin
```
Then you can run the application:
```shell
✗ ckia
An open source tool for making recommendations for target cloud account.
Usage:
ckia [command]
Available Commands:
aws Checks related to the aws cloud.
completion Generate the autocompletion script for the specified shell
help Help about any command
Flags:
--config string config file (default is $HOME/.ckia.yaml)
-h, --help help for ckia
Use "ckia [command] --help" for more information about a command.
```
```shell
✗ ckia aws -h
Checks related to the aws cloud.
Usage:
ckia aws [flags]
ckia aws [command]
Available Commands:
check Run available checks for aws
list List available checks for aws
Flags:
-h, --help help for aws
Global Flags:
--config string config file (default is $HOME/.ckia.yaml)
Use "ckia aws [command] --help" for more information about a command.
```
When running checks for the AWS cloud, be sure to configure your credentials before running the application:
```shell
export AWS_ACCESS_KEY_ID="anaccesskey"
export AWS_SECRET_ACCESS_KEY="asecretkey"
export AWS_REGION="us-west-2"
ckia aws check
```
## License
[Mozilla Public License v2.0](https://github.com/brittandeyoung/ckia/blob/main/LICENSE)