Skip to content

Commit

Permalink
[OSDOCS-5344]: Adding concepts and personas for hosted control planes
Browse files Browse the repository at this point in the history
  • Loading branch information
lahinson committed Jun 29, 2023
1 parent 9e85b16 commit 0e4fc0d
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 2 deletions.
2 changes: 1 addition & 1 deletion architecture/control-plane.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes for Red Hat OpenShift Container Platform (Technology Preview)]
include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+2]
include::modules/hosted-control-planes-version-support.adoc[leveloffset=+2]

[role="_additional-resources"]
Expand Down
2 changes: 1 addition & 1 deletion hosted_control_planes/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1]
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes for Red Hat OpenShift Container Platform (Technology Preview)]
include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+1]
include::modules/hosted-control-planes-version-support.adoc[leveloffset=+1]

[role="_additional-resources"]
Expand Down
43 changes: 43 additions & 0 deletions modules/hosted-control-planes-concepts-personas.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Module included in the following assemblies:
//
// * architecture/control-plane.adoc
// * hosted-control-planes/index.adoc


:_content-type: CONCEPT
[id="hosted-control-planes-concepts-personas_{context}"]
= Glossary of common concepts and personas for hosted control planes

When you use hosted control planes for {product-title}, it is important to understand its key concepts and the personas that are involved.

[id="hosted-control-planes-concepts_{context}"]
== Concepts

hosted cluster:: An {product-title} API endpoint for the tenant cluster that is managed by the HyperShift Operator.

hosted cluster infrastructure:: Network, compute, and storage resources that exist in the tenant or end-user cloud account.

hosted control plane:: An {product-title} control plane that runs on the management cluster, which is exposed by the API endpoint of a hosted cluster. The components of a control plane include etcd, the Kubernetes API server, the Kubernetes controller manager, and a VPN.

hosting cluster:: See _management cluster_.

management cluster:: An {product-title} cluster where the HyperShift Operator is deployed and where the control planes for tenant clusters are hosted. The management cluster is synonymous with the _hosting cluster_.

management cluster infrastructure:: Network, compute, and storage resources of the management cluster.

[id="hosted-control-planes-personas_{context}"]
== Personas

cluster instance administrator:: Users who assume this role are the equivalent of administrators in standalone {product-title}. This user has the `cluster-admin` role in the provisioned cluster, but might not have power over when or how the cluster is updated or configured. This user might have read-only access to see some configuration projected into the cluster.

cluster instance user:: Users who assume this role are the equivalent of developers in standalone {product-title}. This user does not have a view into OperatorHub or machines.

cluster service consumer:: Users who assume this role can request control planes and worker nodes, drive updates, or modify externalized configurations. Typically, this user does not manage or access cloud credentials or infrastructure encryption keys. The cluster service consumer persona can request hosted clusters and interact with node pools. Users who assume this role have RBAC to create, read, update, or delete hosted clusters and node pools within a logical boundary.

cluster service provider:: Users who assume this role typically have the `cluster-admin` role on the management cluster and have RBAC to monitor and own the availability of the HyperShift Operator as well as the control planes for the tenant's hosted clusters. The cluster service provider persona is responsible for several activities, including the following examples:
** Owning service-level objects for control plane availability, uptime, and stability
** Configuring the cloud account for the management cluster to host control planes
** Configuring the user-provisioned infrastructure, which includes the host awareness of available compute resources



0 comments on commit 0e4fc0d

Please sign in to comment.