observatorium
Add documentation
There is a need for more documentation:
- What is this repo about? High level description.
- What are the APIs exposed and how to use them. (Metrics read/receive, Logs...)
- RBAC - tenants.
- TLS, mTLS
Also we need instructions about how to configure the tenants/RBAC in Openshift.
Configuring rbac in OpenShift doesn't change at all, but you mean how to configure the API to use the OpenShift authentication server for OIDC?
I'm assuming that the tenant/user configuration needs to be fully independent of the OpenShift installation that the application is sitting on top of since this is intended to be used for tenants/workloads external of the existing OpenShift deployment. Is that correct?
I feel like this issue should be moved to observatorium/deployments repository as well. It would be ideal that the documentation lives in a single location. Might even consider moving to a documentation repository and using asciidoc so that it's later easier to import into downstream documentation stream.
@leifmadsen This project is completely agnostic to OpenShift and even to Kubernetes; it knows nothing about any underlying scheduler or orchestration. The tenants file is simply a mapping of organization names to OIDC configurations. That said, a tenant can be configured to use the OpenShift authentication server as its identity provider.
This org actually already has a documentation repo, you can find it at github.com/observatorium/docs. The final output of this issue will be a document that lives in that repo. I prefer not to make a second issue for this to avoid duplication and spreading comments around where they will get lost.