Skip to content

Commit 753cf8b

Browse files
committed
review updates
Signed-off-by: Jordan Keister <[email protected]>
1 parent f0df800 commit 753cf8b

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

docs/draft/project/personas.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
OLM Personas
1+
# OLM Personas
22

3-
# About this doc
43
This document attempts to identify essential roles in the OLM lifecycle and associate the duties logically performed by each role. Though some roles can be (and even may typically be) performed by the same actor, they are logically distinct roles with different goals.
54

6-
# Framework
7-
OLM roles are broadly categorized here as **Producers** or **Consumers**, depicting whether that role typically is producing content for use in the ecosystem or is using (consuming) content.
8-
9-
# Terminology
10-
Some terminology exists outside of this document in different contexts, so where a common term has a specific meaning in the context of OLMv1, it is noted below. Where possible, generic terms are used instead of, for e.g. specific to registry+v1.
11-
- **extension**: a representation of any OLMv1 installable
12-
- **FBC**: [file-based catalog](https://olm.operatorframework.io/docs/reference/file-based-catalogs/), a composite YAML schema for expressing extensions and their related upgrade graphs
13-
5+
OLM roles are broadly categorized here as **Producers** or **Consumers**, indicating whether that role typically is producing content for use in the ecosystem or is using (consuming) content.
146

157
# Consumers
168
## Cluster Admin
@@ -29,6 +21,7 @@ This role encompasses the basic full-permissions-required creation/maintenance o
2921
*Who is it?*
3022

3123
This role encompasses privileged operations required for OLMv1 and associated operators to deploy workloads to the cluster. This role may exist as a set of activities executed by a cluster admin, but also may operate independently of that role, depending on the necessary privileges.
24+
Here `extension` represents any individual OLMv1 installable, including (but not limited to) `registry+v1` bundles.
3225

3326
*What does it do?*
3427

@@ -65,7 +58,7 @@ This role represents any actor which monitors the status of the cluster and inst
6558
## Extension Author
6659
*Who is it?*
6760

68-
This role encompasses folks who want to create an extension. It interacts with other **Producer** roles by generating a _catalog contribution_ to make extensions available on-cluster to **Cluster Extension Admins**. For example, a catalog contribution for a registry+v1 bundle is one/more bundle image and the upgrade graph expressed in FBC.
61+
This role encompasses folks who want to create an extension. It interacts with other **Producer** roles by generating a _catalog contribution_ to make extensions available on-cluster to **Cluster Extension Admins**. For example, a catalog contribution for a registry+v1 bundle is one/more bundle image and the upgrade graph expressed in [FBC](https://olm.operatorframework.io/docs/reference/file-based-catalogs/).
6962

7063
*What does it do?*
7164
- Creates extension

0 commit comments

Comments
 (0)