servala/servala-portal
3
0
Fork 0
Code Issues 22 Pull requests 1 Projects 1 Releases Packages 2 Activity Actions

document terminology
All checks were successful
Build and Deploy Antora Docs / build (push) Successful in 31s
Details
Build and Deploy Antora Docs / deploy (push) Successful in 5s
Details

Browse source
This commit is contained in:
Tobias Brunner 2025-03-10 16:28:22 +01:00
parent 9c9d435b04
commit bdbbfe0588
No known key found for this signature in database
2 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/modules/ROOT/nav.adoc
View file

@ -1 +1,2 @@
* xref:index.adoc[Home]
* xref:terminology.adoc[]

30
docs/modules/ROOT/pages/terminology.adoc Normal file
View file

@ -0,0 +1,30 @@
= Terminology
Web Portal (Portal)::
This is the aggregated view and entry point for the user.
It provides the mechanisms for the multi-tenant, multi-service-provider self-service portal.
Control Plane (CP)::
This runs Crossplane and the AppCat Control Plane (Kubernetes API) which manages all the service instances on worker clusters.
Each zone of a Service Provider runs at least one CP.
Worker Cluster::
Clusters running the actual workload, managed by the Control Plane.
Each zone of a CSP runs at least one Worker Cluster.
Services are directly exposed to the end-user.
Service::
A generic service like "PostgreSQL" or "Keycloak".
This doesn't include pricing or any other aspect of a managed service.
Plan::
A bundle of a service, a price, an SLA and other parameters to form an offering.
It can be instantiated (ordered) and parametrized according to the specification in the offering.
Crossplane specific terms::
* Compositions - A template to define how to create resources.
* Composite Resource Definition (`XRD`) - A custom API specification.
* Composite Resource (`XR`) - Created by using the custom API defined in a Composite Resource Definition. XRs use the Composition template to create new managed resources.
* Claims (`XRC`) - Like a Composite Resource, but with namespace scoping.
* Managed Resource (`MR`) - Represents an external service in a Provider.
* Providers enable Crossplane to provision infrastructure on an external service. Providers create new Kubernetes APIs and map them to external APIs.