Merge pull request #58 from OpenSLO/sumo-agaurav

Update readme and changelog for v1.0.0 release

Author: agaurav

CHANGELOG.md

@@ -1,3 +1,15 @@
+### [v1.0](https://github.com/OpenSLO/slogen/releases/tag/v1.0.0)
+
+- **Feature** : Support for OpenSLO v1 spec for `SLO`, `AlertPolicy` and `AlertNotificationTarget`
+- **Feature** : Support for sumologic native SLO & SLO based monitors.
+- **Feature** : Generates flow graph of which `SLO` are using which `AlertPolicy` and `AlertNotificationTarget`
+
+![dep-graph](misc/samples-flowchart.png)
+
+sample configs to try out the above features are available [here](samples/sumologic/v1)
+
+
+
 ### [v0.7](https://github.com/OpenSLO/slogen/milestone/2?closed=1)
 
 - **Feature** : Timeslice based budgeting (availability calculated w.r.t. good time windows)  

README.md

@@ -2,6 +2,8 @@
 
 CLI tool to generate SLO dashboards, monitors & SLI data
 from [OpenSLO](https://github.com/OpenSLO/OpenSLO#specification) configs. 
+The resources are generated via terraform which can be consumed on its as as well.
+
 
 Currently supported vendors/data sources.
 
@@ -10,10 +12,15 @@ Currently supported vendors/data sources.
 ![list](misc/sumo-sli-list.gif)
 ![panels](misc/sumo-slo-dashboard.png)
 
+A flow graph of `SLO` to `AlertPolicy` to `AlertNotificationTarget` is also generated in the output dir as `slo-dep-graph.png`.
+Flow graphs for sample configs [here](samples/sumologic/v1) (only supported for v1 onward specs).
+
+![dep-graph](misc/samples-flowchart.png)
+
 
 #### Getting the tool
 
-##### install with go1.17 as `go install github.com/OpenSLO/slogen@latest`
+##### install with go1.17 or above as `go install github.com/OpenSLO/slogen@v1.0.0`
 
 latest golang release can be installed by using the directions here : https://github.com/udhos/update-golang#usage.
 Add `$GOPATH/bin` to your `$PATH`.
@@ -24,20 +31,6 @@ It can be done with
 export PATH=`go env GOPATH`/bin:$PATH
 ```
 
-##### Get the latest binary from [release page](https://github.com/OpenSLO/slogen/releases) and put it in a directory in your `$PATH` (e.g. `$HOME/.local/bin` )
-
-###### For Linux
-
-``` shell
-wget -O - https://github.com/OpenSLO/slogen/releases/download/v0.7.11/slogen_0.7.11_Linux_x86_64.tar.gz | tar xvz -C /path/to/bin
-```
-
-###### For Mac
-
-``` shell
-wget -O - https://github.com/OpenSLO/slogen/releases/download/v0.7.11/slogen_0.7.11_Darwin_x86_64.tar.gz | tar xvz -C /path/to/bin
-```
-
 ### Using the tool
 
 ##### Set the sumologic auth as `ENV` variables as required by the [terraform provider](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs#environment-variables):
@@ -139,5 +132,5 @@ slogen list -c
 ```
 
 ### Change Log
-- [New feature and fixes in v0.7](CHANGELOG.md)
+- [New feature and fixes in v1.0](CHANGELOG.md)
 

go.mod

@@ -3,13 +3,13 @@ module github.com/OpenSLO/slogen
 go 1.18
 
 require (
-	github.com/OpenSLO/oslo v0.5.1
+	//github.com/OpenSLO/oslo v0.5.1
 	github.com/fatih/color v1.13.0
 	github.com/go-resty/resty/v2 v2.7.0
+	github.com/goccy/go-graphviz v0.0.9
 	github.com/hashicorp/go-version v1.6.0
 	github.com/hashicorp/hc-install v0.4.0
 	github.com/hashicorp/terraform-exec v0.17.2
-	github.com/kr/pretty v0.3.0
 	github.com/manifoldco/promptui v0.9.0
 	github.com/mattn/go-colorable v0.1.12
 	github.com/mitchellh/hashstructure/v2 v2.0.2
@@ -19,20 +19,24 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 )
 
+require github.com/OpenSLO/oslo v0.0.0-00010101000000-000000000000
+
 require (
 	github.com/chzyer/readline v1.5.1 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/fogleman/gg v1.3.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/hashicorp/terraform-json v0.14.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/kr/text v0.2.0 // indirect
 	github.com/magiconair/properties v1.8.6 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/rogpeppe/go-internal v1.8.1 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/spf13/afero v1.9.2 // indirect
@@ -44,11 +48,12 @@ require (
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/multierr v1.8.0 // indirect
 	golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa // indirect
+	golang.org/x/image v0.0.0-20200119044424-58c23975cae1 // indirect
 	golang.org/x/net v0.0.0-20220728211354-c7608f3a8462 // indirect
 	golang.org/x/sys v0.0.0-20220731174439-a90be440212d // indirect
 	golang.org/x/text v0.3.7 // indirect
 	gopkg.in/ini.v1 v1.66.6 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
 
-//replace github.com/OpenSLO/oslo => github.com/agaurav/oslo v0.3.3-0.20220712184915-bc307d389cf4
+replace github.com/OpenSLO/oslo => github.com/agaurav/oslo v0.5.13