Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CCOLLOT committed Dec 21, 2023
1 parent fe321da commit 062cb93
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# Description
# Upgrade-Manager
![Go Report Card](https://goreportcard.com/badge/github.com/qonto/upgrade-manager)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/qonto/upgrade-manager)

An autodiscovery tool to help you know what and when to update.

![boat](doc/image/grafana-dashboard.png "dashboard")
*Grafana Dashboard displaying upgrade-manager's metrics, pointing out which apps need to be upgrading and their associated versions*

---

Key Features:
+ **Service discovery**: finds softwares deployed (see software sources supported)
+ **Obsolescence Score SLI (Service Level Indicator) Calculation**: compute each software’s obsolescence score and expose it as a prometheus metric
+ **New eligible release detection**: automatically find the version corresponding to a tailor-made selection logic


---

### Managing IT system obsolescence is like being in a boat full of holes
![boat](doc/image/boat.png "Boat")
Expand Down Expand Up @@ -74,7 +78,7 @@ http:
## Required AWS Privileges when running AWS sources
To automatically discover AWS resources and their newer versions, upgrade-manager needs the following AWS privileges (represented in Terraform HCL):
```json
```hcl
data "aws_iam_policy_document" "upgrade-manager" {
statement {
sid = "elasticache"
Expand Down

0 comments on commit 062cb93

Please sign in to comment.