Glossary

General

Organization

A unit that groups together Users, Teams and Namespaces. It’s the entity that owns the associated resources and the business connection. Billing is done on this level.

Team

A group of users. Always belongs to exactly one organization.

Role

A collection of permissions a subject has within an object (subjects would be User and Team, objects would be Organization, Team and Namespace).

Namespace

A Kubernetes namespace (in OpenShift also an object type "Project").

APPUiO Cloud specific

APPUiO Cloud Instance

An instance of an APPUiO Cloud installation, consisting of a APPUiO Cloud Global instance and a number of Zones.

Zone

A single OpenShift cluster that is part of an APPUiO Cloud offering.

Control API

An API endpoint that exposes certain APPUiO Cloud features to users. Specifically, this consists of:

  • API that users write to with various clients (for example frontend or CLI) and thus configure their organizations

  • API that users read with various clients that is usually the result of APPUiO Cloud components (for example read-only access to invoices)

APPUiO Cloud Portal

Web application which exposes the functionality of the Control API in a graphical way.

Adapter API

A subset of Control API that is specifically targeted for Adapters. This specification may not only be technical, but may also contain a "behavioral contract" that is in documentation only. It basically defines how Adapters should behave and interact with APPUiO Cloud.

This term is introduced to better distinguish between APPUiO Cloud internal API and API interacting with Adapters.

Adapter

A component or system that is foreign to the core of APPUiO Cloud, but implements the functionalities through a Adapter API that completes APPUiO Cloud.

APPUiO Cloud itself doesn’t contain an invoicing system. Generating and maintaining the lifecycle of invoices is the task of an invoicing or ERP system. Since there are countless systems already available, APPUiO Cloud will only define a Adapter API but not otherwise enforce resellers to use a certain ERP software.

Personas

User

A human that interacts with APPUiO Cloud.

Developer

A user which interacts with APPUiO Cloud (the Kubernetes API) in a specified namespace.

Organization Owner

A user which interacts with APPUiO Cloud (the Kubernetes API).

Instance Owner

Owner of the particular APPUiO Cloud instance.

Instance Admin

Administrator of the particular APPUiO Cloud instance. On a APPUiO Zone it’s the cluster admin, on the global level it’s the admin.

Roles

OpenShift default roles are documented in the upstream documentation.

Admin

A project manager. If used in a local binding, an admin has rights to view any resource in the project and modify any resource in the project except for quota.
— OpenShift default role

Editor

> A user that can modify most objects in a project but does not have the power to view or modify roles or bindings.
— OpenShift default role

Viewer

> A user who cannot make any modifications, but can see most objects in a project. They cannot view or modify roles or bindings.
— OpenShift default role