Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MeNsaaH committed Oct 7, 2020
1 parent 26a56ec commit de12c79
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 181 deletions.
37 changes: 16 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,30 @@ A Cloud Infrastructure Management Tool to stop, resume, clean and destroy resour
### Project Name
`REKA` is derived from a Native Nigerian Language, Igbo, meaning `Reap`.

Currently Supports:
#### AWS
- EC2
- S3

### TODO
- [x] Bootstrap application architecture
- [x] get resources with specified tags for destruction
- [ ] Schedule tasks for destruction
- [ ] Schedule resource refreshing
- [ ] Create Web Dashboard
- [ ] Allow users to specify tags/resources to track from reka UI with reaping Details
- [ ] Support Manual Trigger of resources reaping from Dashboard/CLI
- [ ] Allow authentication username and password set in config file
- [ ] Create Kubernetes Manifests and Helm Charts
- [ ] Create CLI

#### AWS
- [x] EC2: Stop|Resume| Destroy
- [x] S3: Destroy
- [ ] EKS : Stop|Resume: by Resizing | Destroy
- [ ] RDS : Stop | resume | Destroy
- [ ] EBS : Destroy | Unused EBS Volumes
- [ ] Elastic IPs : Destroy | Unused IPs
- [ ] VPCs : Destroy | Unused VPCs
#### Supported Resources
- AWS: https://github.com/MeNsaaH/reka/issues/1
- GCP: https://github.com/MeNsaaH/reka/issues/2


## Development
```bash
# Web UI
cd web
go run main.go
```

#### GCP
- [ ] Compute : Stop|Resume: by Resizing | Destroy
- [ ] Cloud SQL: Stop | resume | Destroy
- [ ] EBS : Destroy | Unused EBS Volumes
- [ ] Cloud Storage : Destroy
- [ ] IPs : Destroy | Unused IPs
- [ ] VPCs : Destroy | Unused VPCs
using [air](https://github.com/cosmtrek/air) with autoreload UI features
```bash
air -c .air.toml
```
20 changes: 2 additions & 18 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,16 @@ module github.com/mensaah/reka
go 1.14

require (
github.com/0xAX/notificator v0.0.0-20191016112426-3962a5ea8da1 // indirect
github.com/aws/aws-sdk-go-v2 v0.23.0
github.com/claudiu/gocron v0.0.0-20151103142354-980c96bf412b
github.com/codegangsta/envy v0.0.0-20141216192214-4b78388c8ce4 // indirect
github.com/codegangsta/gin v0.0.0-20171026143024-cafe2ce98974 // indirect
github.com/cosmtrek/air v1.21.2 // indirect
github.com/creack/pty v1.1.11 // indirect
github.com/denisbakhtin/ginblog v0.0.0-20200314093558-9711ee9e2de3
github.com/fatih/color v1.9.0 // indirect
github.com/fiam/gounidecode v0.0.0-20150629112515-8deddbd03fec
github.com/gin-contrib/sessions v0.0.3
github.com/fsnotify/fsnotify v1.4.9 // indirect
github.com/gin-gonic/gin v1.6.3
github.com/go-co-op/gocron v0.3.1
github.com/imdario/mergo v0.3.11 // indirect
github.com/jinzhu/gorm v1.9.16
github.com/jinzhu/now v1.1.1
github.com/mattn/go-colorable v0.1.7 // indirect
github.com/mattn/go-shellwords v1.0.10 // indirect
github.com/microcosm-cc/bluemonday v1.0.4 // indirect
github.com/mitchellh/go-homedir v1.1.0
github.com/pelletier/go-toml v1.8.1 // indirect
github.com/sirupsen/logrus v1.4.2
github.com/spf13/cobra v1.0.0
github.com/spf13/viper v1.7.0
golang.org/x/sys v0.0.0-20200918174421-af09f7315aff // indirect
gopkg.in/urfave/cli.v1 v1.20.0 // indirect
gopkg.in/yaml.v2 v2.3.0 // indirect
gorm.io/driver/postgres v1.0.0
gorm.io/driver/sqlite v1.1.2
gorm.io/gorm v1.20.0
Expand Down
Loading

0 comments on commit de12c79

Please sign in to comment.