-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from brunopadz/docs/prepare-for-release
docs: prepare for release
- Loading branch information
Showing
2 changed files
with
64 additions
and
51 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 |
|---|---|---|
| @@ -1,61 +1,22 @@ | ||
| # amictl | ||
|     | ||
|
|
||
| amictl is a super simple cli app to control your AMIs and Images | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| - There are a ton of features that still need to be implemented. Just check the [contributing guide](CONTRIBUTING.md) and the opened [issues](https://github.com/brunopadz/amictl/issues). | ||
|
|
||
| ## Configuring | ||
|
|
||
| ❗️ AWS is the only cloud provider supported to this date. | ||
|
|
||
| - Make sure AWS CLI is installed and properly configured. amictl uses access and secret keys to authenticate to AWS. | ||
| - You can configure it using [Environment Variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) or through [cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html). | ||
|
|
||
| More docs coming soon. | ||
|
|
||
| ## How to use | ||
|     | ||
|
|
||
| - Download the binary from [releases page](https://github.com/brunopadz/amictl/releases) or | ||
| - Download using go get: | ||
|
|
||
| `go get github.com/brunopadz/amictl` | ||
| ## Info | ||
|
|
||
| **List all AMIs** | ||
| - [How to use](docs/how_to_use.md) | ||
| - [Download it!](https://github.com/brunopadz/amictl/releases/latest) | ||
| - Feel free to [contribute](CONTRIBUTING.md) | ||
| - AWS is the only cloud provider supported to this date | ||
|
|
||
| ``` | ||
| $ amictl aws list-all --account 123456789012 --region us-east-1 | ||
| ami-00123asb820d84d9a | ||
| ami-01ee75aqwez39a298 | ||
| ami-02e6a65236aa8d0e7 | ||
| ami-0387a7987av1b328d | ||
| ami-039835c818ezxc21c | ||
| ami-0345df085fe686a54 | ||
| ami-03fd5464hdd14b864 | ||
| Total of 7 AMIs | ||
| ``` | ||
| ## What is amictl? | ||
|
|
||
| **List not used AMIs** | ||
| amictl is a super simple cli app to control your AMIs and Image IDs. | ||
|
|
||
| ``` | ||
| $ amictl aws list-unused --account 123456789012 --region us-east-1 | ||
| ami-00123asb820d84d9a | ||
| ami-01ee75aqwez39a298 | ||
| ami-02e6a65236aa8d0e7 | ||
| Total of 3 AMIs | ||
| ``` | ||
| ## And what does it do? | ||
|
|
||
| **Estimate costs** | ||
| So far, it shows how many AMIs/Image IDs you're not using and how much you could be saving. | ||
|
|
||
| ``` | ||
| amictl aws list-unused --account 123456789012 --region us-east-1 --cost | ||
| AMI-ID: ami-044ec27279a83e963 Size: 20 GB Estimated cost monthly: U$ 0.46 | ||
| AMI-ID: ami-09665078cc0a18084 Size: 8 GB Estimated cost monthly: U$ 0.18 | ||
| AMI-ID: ami-0c14b9433a78ac8f1 Size: 8 GB Estimated cost monthly: U$ 0.18 | ||
| ## Disclaimer | ||
|
|
||
| Estimated cost monthly: U$ 0.83 for 3 Unused AMI | ||
| ======= | ||
| Total of 3 not used AMIs | ||
| ``` | ||
| - There are a ton of features that still need to be implemented. Just check the [contributing guide](CONTRIBUTING.md) and the open [issues](https://github.com/brunopadz/amictl/issues). |
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 |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| ## First things first | ||
|
|
||
| AWS is the only cloud provider supported to this date. If you need support for another major cloud provider, feel free to open an issue. :) | ||
|
|
||
| ## Credentials | ||
|
|
||
| Currently amictl supports the same authentication method as AWS does. It can use the default credentials configured in `~/.aws/credentials` or [environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) such as `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. | ||
|
|
||
| ## How to use amictl | ||
|
|
||
| - Download the latest build from [releases page](https://github.com/brunopadz/amictl/releases) or download it as follows: | ||
| ``` | ||
| go get github.com/brunopadz/amictl | ||
| ``` | ||
| - All commands must have the flag `--account` (or `-a`) and `--region` (or `-r`) | ||
|
|
||
| To list all your AMIs: | ||
|
|
||
| ``` | ||
| amictl aws list-all --account 123456789012 --region us-east-1 | ||
| ami-00123asb820d84d9a | ||
| ami-01ee75aqwez39a298 | ||
| ami-02e6a65236aa8d0e7 | ||
| ami-0387a7987av1b328d | ||
| ami-039835c818ezxc21c | ||
| ami-0345df085fe686a54 | ||
| ami-03fd5464hdd14b864 | ||
| Total of 7 AMIs | ||
| ``` | ||
|
|
||
| To show how many AMIs are not being used: | ||
|
|
||
| ``` | ||
| $ amictl aws list-unused -a 123456789012 -r us-east-1 | ||
| ami-00123asb820d84d9a | ||
| ami-01ee75aqwez39a298 | ||
| ami-02e6a65236aa8d0e7 | ||
| Total of 3 AMIs | ||
| ``` | ||
|
|
||
| And you can just add the flag `--cost` and boom: | ||
|
|
||
| ``` | ||
| amictl aws list-unused --account 123456789012 --region us-east-1 --cost | ||
| AMI-ID: ami-044ec27279a83e963 Size: 20 GB Estimated cost monthly: U$ 0.46 | ||
| AMI-ID: ami-09665078cc0a18084 Size: 8 GB Estimated cost monthly: U$ 0.18 | ||
| AMI-ID: ami-0c14b9433a78ac8f1 Size: 8 GB Estimated cost monthly: U$ 0.18 | ||
| Estimated cost monthly: U$ 0.83 for 3 Unused AMI | ||
| ======= | ||
| Total of 3 not used AMIs | ||
| ``` |