CLI tool for the OpenSLO spec. For more information also check the website: openslo.com.
- Checkout this repository
- From the root of the project, run
make install
. This will build and install the binary into yourGOPATH
brew install openslo/openslo/oslo
docker run -v "$(pwd):/manifests" ghcr.io/openslo/oslo:latest <command> /manifests/<file>.yaml
For example, if you had an OpenSLO spec file in the current directory called myservice.yaml
,
and you wanted to validate it, the full command would be:
# docker run -v "$(pwd):/manifests" ghcr.io/openslo/oslo:latest validate /manifests/myservice.yaml
Valid!
oslo validate
will validate the provided OpenSLO YAML document
oslo convert
will convert the given OpenSLO YAML document to the provided
format.
example:
oslo convert -f file1.yaml -f file2.yaml -o nobl9
That will take the provided yaml files, convert them to Nobl9 formatted config format, and output to stdout.
NOTE: Currently only Nobl9 is supported for output. Additionally, deeply nested metric sources are not supported. For metric sources that might have a deeply nested structure, we support a flattened structure, e.g.
metricSource:
type: Instana
spec:
infrastructure.query: "myQuery"
infrastructure.metricRetrievalMethod: "myMetricRetrievalMethod"
To test out the features of oslo, from the root of the project run
oslo validate test/valid-service.yaml
That will validate against a valid yaml file. There are other files in that
directory to test out the functionality of oslo