Skip to content

Commit 0c488c5

Browse files
authored
Merge pull request #365 from validatedpatterns/hypershift
HyperShift Doc Scaffolding
2 parents 76b6a54 + e604384 commit 0c488c5

File tree

3 files changed

+80
-0
lines changed

3 files changed

+80
-0
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: HyperShift
3+
date: 2023-11-15
4+
validated: false
5+
summary: This pattern is for deploying the Hosted Control Plane (HyperShift) service.
6+
products:
7+
- Red Hat OpenShift Container Platform
8+
- Red Hat MultiCluster Engine
9+
- AWS Controller for Kubernetes
10+
industries:
11+
- Infrastructure
12+
aliases: /hypershift/
13+
pattern_logo: medical-diagnosis.png
14+
links:
15+
16+
help: https://groups.google.com/g/validatedpatterns
17+
bugs: https://github.com/validatedpatterns-sandbox/hypershift/issues
18+
ci: hypershift
19+
---
20+
21+
:toc:
22+
:imagesdir: /images
23+
:_content-type: ASSEMBLY
24+
include::modules/comm-attributes.adoc[]
25+
26+
//Module to be included
27+
//:_content-type: CONCEPT
28+
//:imagesdir: ../../images
29+
[id="about-hcp-pattern"]
30+
= About the {hcp-pattern} ({hcp})
31+
32+
Background::
33+
34+
This pattern simplifies the deployment of an {hcp} or hosted control plane cluster. Use this pattern to create hosted control plane clusters.
35+
36+
Workflow::
37+
38+
* Install multicluster engine for Kubernetes Operator
39+
* Create an instance of the `MultiClusterEngine` to enable `hypershift`, which is a [technology preview feature](https://access.redhat.com/support/offerings/techpreview).
40+
* Install the AWS Controllers for Kubernetes - Amazon S3 Operator
41+
* Create an S3 bucket that hosted control plane will use for OpenID Connect (OIDC)
42+
* Create a buildconfig and imagestream that provide the HyperShift cli (`hypershift`) as an imagestream to be used in further automation if desired.
43+
44+
//This pipeline is showcased link:https://www.youtube.com/watch?v=zja83FVsm14[in this video].
45+
46+
image::hypershift/hypershift-high-level-architecture.png[link="/images/hypershift/hypershift-high-level-architecture.png",title="source: https://hypershift-docs.netlify.app/", align="center"]
47+
48+
[NOTE]
49+
====
50+
If you have any questions or concerns contact mailto:jrickard@redhat.com[Jonny Rickard].
51+
====
52+
53+
[id="about-solution-hcp"]
54+
== About the solution elements
55+
56+
The solution enables the rapid provisioning of {hcp}.
57+
58+
The {hcp-pattern} uses the following products and technologies:
59+
60+
* {rh-ocp} for container orchestration
61+
* {rh-gitops}, a GitOps continuous delivery (CD) solution
62+
* {rh-mce}, the multicluster-engine provider
63+
* {ack-s3}, a S3 storage controller
64+
65+
// All commented out by jrickard
66+
//== Recorded demo
67+
68+
//link:/videos/xray-deployment.svg[image:/videos/xray-deployment.svg[Demo\]]
69+
70+
//[id="next-steps_med-diag-index"]
71+
//== Next steps
72+
73+
//* Getting started link:getting-started[Deploy the Pattern]
74+
//We have relevant links on the patterns page

modules/comm-attributes.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
//Patterns
1414
:aeg-pattern: Ansible Edge GitOps pattern
1515
:aeg: Ansible Edge GitOps
16+
:hcp: hosted control plane
17+
:hcp-pattern: HyperShift pattern
1618
:ie-pattern: Industrial Edge pattern
1719
:ie: Industrial Edge
1820
:mcg-pattern: Multicloud GitOps pattern
@@ -81,6 +83,8 @@
8183
//ACM
8284
:rh-rhacm-first: Red{nbsp}Hat Advanced Cluster Management (RHACM)
8385
:rh-rhacm: RHACM
86+
:rh-mce: multicluster engine for Kubernetes
87+
:mce-short: multicluster engine
8488
//:rh-rhacm-version: 2.5
8589
//ACS
8690
:rh-acs-first: Red{nbsp}Hat Advanced Cluster Security for Kubernetes
@@ -121,6 +125,8 @@
121125
:quay-short: Quay
122126
// Red Hat Quay Container Security Operator
123127
:rhq-cso: Red{nbsp}Hat Quay Container Security Operator
128+
// OpenSource/Community Operators
129+
:ack-s3-op: AWS Controllers for Kubernetes - Amazon S3 Operator
124130
//Cloud platforms
125131
:AWS: Amazon Web Services (AWS)
126132
:GCP: Google Cloud Platform (GCP)
120 KB
Loading

0 commit comments

Comments
 (0)