README
¶
oslo
CLI tool for the OpenSLO spec. For more information also check the website: openslo.com.
Prerequisites
Installation
From source
- Checkout this repository
- Install oslo with
go get github.com/OpenSLO/oslo
Homebrew
brew tap openslo/openslobrew install oslo
From Docker
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!
Usage
Right now, the only function is validate, which you can call with oslo validate
Testing
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
Documentation
¶
Overview ¶
Copyright © 2021 OpenSLO Team
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
pkg/fmt
Package fmt handles formatting of the provided input.
|
Package fmt handles formatting of the provided input. |
|
pkg
|
|
|
manifest
Package manifest provides foundational structs.
|
Package manifest provides foundational structs. |
|
manifest/v1
Package v1 contains all the types that are exported by the v1 API.
|
Package v1 contains all the types that are exported by the v1 API. |