Skip to content

Commit f8ea8ff

Browse files
committed
Docs: updated README
1 parent 6885a02 commit f8ea8ff

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,16 @@ A Cloud Infrastructure Management Tool to stop, resume, clean and destroy resour
1515

1616
This tool is **HIGHLY DESTRUCTIVE** and can deletes all resources! This should be used in environments with **WITH CAUTION**.
1717

18+
## What Does this tool do?
19+
- Stop/Resume resources based on configuration (activeDuration) for instance stopping an EKS cluster would mean resizing all nodegroups to 0 and resuming will be restoring back to original size
20+
- Destroy resources that have specific tags/labels or after a certain Duration(terminationDate)
21+
- Clean Up unused resources (such as EBS volumes, Elastic IPs)
22+
1823
### TODO
1924
- [x] Schedule resource refreshing
2025
- [x] generate Sample Yaml config and load config
2126
- [ ] [Create Web Dashboard](https://github.com/MeNsaaH/reka/issues/3)
2227
- [ ] [Persist state to remote sources](https://github.com/MeNsaaH/reka/issues/4)
23-
- [ ] [Dockerize application](https://github.com/MeNsaaH/reka/issues/5)
2428
- [ ] [Add AWS Resources](https://github.com/MeNsaaH/reka/issues/1)
2529
- [ ] [Add GCP Resources](https://github.com/MeNsaaH/reka/issues/2)
2630
- [ ] [Add Azure Resources](https://github.com/MeNsaaH/reka/issues/6)
@@ -53,3 +57,6 @@ cp config/config.example.yaml config/config.yaml
5357
# resources dues for termination
5458
reka --config config/config.yaml
5559
```
60+
61+
### Authentication
62+
Reka uses the default authentication method for all providers

0 commit comments

Comments
 (0)