Rest API to provide services like inventory, cluster registry, tenant management and GitOps helper.
Please note that this project is in it's early stages and under active development.
This repository is part of Project Syn. For documentation on Project Syn and this component, see https://syn.tools.
Documentation for this component is written using Asciidoc and Antora. It is located in the docs/ folder. The Divio documentation structure is used to organize its content.
You can preview the documentation using the make antora command, and then opening a browser to http://localhost:2020.
The API is specified in OpenAPI 3 format. It's available in the file openapi.yaml in the root folder of this project.
To run the API on your local workstation, follow these steps:
export KUBECONFIG=~/.kube/myconfig
export NAMESPACE=syn-lieutenant
make run
The kubeconfig must grant access to the cluster.
Check with curl localhost:8080/healthz if the API is responding.
Done with HTTPie, but also works with plain curl.
Create Tenant
http localhost:8080/tenants Authorization:"Bearer $(kubectl get secrets test-token-zzzzz -o json | jq ".data.token" -r | base64 --decode)" displayName="Syn Corp"
Query Tenants
http localhost:8080/tenants Authorization:"Bearer $(kubectl get secrets test-token-zzzzz -o json | jq ".data.token" -r | base64 --decode)"
test-token-zzzzzis the token of a ServiceAccount with all the needed RBAC rights on the underlying Kubernetes cluster
There is no API versioning exposed. Internally the "API Evolution" approach is used which is described in this excellent blog post: API Versioning Has No "Right Way".
To test the API before writing actual code, API mocking can be used. One cool tool to do that is Prism. Example:
docker run --init --rm -p 4010:4010 -v $(pwd):/tmp stoplight/prism:3 mock -h 0.0.0.0 "/tmp/openapi.yaml"
curl http://localhost:4010/tenants
As the API spec is written with OpenAPI, the OpenAPI Generator is used to generate the Go boilerplate code.
Some API endpoints store data in Kubernetes objects. These objects must be named like this:
pwgen -A -B 6 1
Some good links which help with OpenAPI development:
- OpenAPI.Tools
- OpenAPI (Swagger) Editor (Visual Studio Code Extension)
- OpenAPI Preview (Visual Studio Code Extension)
This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.