Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST API endpoint /v1/spec/lint to extend automation in remote environments (oslo CLI extension) #21

Open
3 tasks
dnsmichi opened this issue Jun 11, 2021 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@dnsmichi
Copy link

Problem to solve

The oslo CLI as validation is a great first step to automate everything. We can build a container image, and it gets used in CI/CD workflows and deployments.

Thinking of schema validation in (cloud) IDEs, such schema spec should be available online. Hosting the YML or JSON representation somewhere as single source of truth is easy. Building a plugin which locally validates the spec with live linting is a little harder.

The hardest part is to lint and validate, and build a request-response model which can be automated. The idea is to provide a REST API endpoint for OpenSLO where you'll POST the OpenSLO config file against, and get feedback from the parser/linter.

Future iterations of the spec may allow things like include or more DSL related stuff. Building a unique interface (CLI and API )

Proposal

  • Extend oslo to run a webserver which accepts a POST request to /v1/spec/lint
  • Build a public server which responds to requests (may need fleet scaling behind a fleet to ensure availability)
  • Document how to build your own API host / proxy e.g. in a Kubernetes cluster

Inspiration

@dnsmichi dnsmichi changed the title REST API endpoint /v1/spec/lint to extend automation remote environments (oslo CLI extension) REST API endpoint /v1/spec/lint to extend automation in remote environments (oslo CLI extension) Jun 11, 2021
@embano1
Copy link

embano1 commented Jun 11, 2021

related: OpenSLO/OpenSLO#20

@ian-bartholomew ian-bartholomew added enhancement New feature or request help wanted Extra attention is needed labels Jul 15, 2021
@programmer04 programmer04 transferred this issue from OpenSLO/OpenSLO Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants