Skip to content

Commit 2dccf6a

Browse files
authored
docs: add reference architecture docs for new ROKS Quickstart pattern (#731)
* docs: new roks quickstart diagram * docs: add new roks quickstart ref arch doc
1 parent 7afe476 commit 2dccf6a

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed

patterns/roks-quickstart/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Red Hat OpenShift Container Platform on VPC landing zone (QuickStart pattern)
22

3+
![Architecture diagram for the QuickStart variation of ROKS on VPC landing zone](https://raw.githubusercontent.com/terraform-ibm-modules/terraform-ibm-landing-zone/main/reference-architectures/roks-quickstart.drawio.svg)
4+
35
This pattern deploys the following infrastructure:
46

57
- Management VPC with one subnet, allow-all ACL and Security Group
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
3+
copyright:
4+
years: 2024
5+
lastupdated: "2024-03-04"
6+
7+
keywords:
8+
9+
subcollection: deployable-reference-architectures
10+
11+
authors:
12+
- name: "Vincent Burckhardt"
13+
14+
# The release that the reference architecture describes
15+
version: 5.16.0
16+
17+
# Whether the reference architecture is published to Cloud Docs production.
18+
# When set to false, the file is available only in staging. Default is false.
19+
production: false
20+
21+
# Use if the reference architecture has deployable code.
22+
# Value is the URL to land the user in the IBM Cloud catalog details page
23+
# for the deployable architecture.
24+
# See https://test.cloud.ibm.com/docs/get-coding?topic=get-coding-deploy-button
25+
deployment-url: unknown
26+
27+
docs: https://cloud.ibm.com/docs/secure-infrastructure-vpc
28+
29+
image_source: https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone/blob/main/reference-architectures/roks-quickstart.drawio.svg
30+
31+
related_links:
32+
- title: "Red Hat OpenShift Container Platform on VPC landing zone"
33+
url: "https://cloud.ibm.com/docs/secure-infrastructure-vpc?topic=secure-infrastructure-vpc-ocp-ra"
34+
description: "Red Hat OpenShift Container Platform on VPC landing zone is a deployable architecture solution that is based on the IBM Cloud for Financial Services reference architecture. It creates secure and compliant Red Hat OpenShift Container Platform workload clusters on a Virtual Private Cloud (VPC) network."
35+
36+
use-case: Cybersecurity
37+
industry: Banking,FinancialSector
38+
39+
content-type: reference-architecture
40+
41+
---
42+
43+
{{site.data.keyword.attribute-definition-list}}
44+
45+
# Red Hat OpenShift Container Platform on VPC landing zone - QuickStart variation
46+
{: #roks-ra-qs}
47+
{: toc-content-type="reference-architecture"}
48+
{: toc-industry="Banking,FinancialSector"}
49+
{: toc-use-case="Cybersecurity"}
50+
{: toc-version="5.16.0"}
51+
52+
The QuickStart variation of the Red Hat OpenShift Container Platform on VPC landing zone deployable architecture creates a fully customizable Virtual Private Cloud (VPC) environment in a single region. The solution provides a single Red Hat OpenShift cluster in a secure VPC for your workloads. The QuickStart variation is designed to deploy quickly for demonstration and development.
53+
54+
## Architecture diagram
55+
{: #ra-roks-qs-architecture-diagram}
56+
57+
![Architecture diagram for the QuickStart variation of Red Hat OpenShift Container Platform on VPC landing zone](roks-quickstart.drawio.svg "Architecture diagram of QuickStart variation of Red Hat OpenShift Container Platform on VPC landing zone deployable architecture"){: caption="Figure 1. QuickStart variation of Red Hat OpenShift Container Platform on VPC landing zone" caption-side="bottom"}{: external download="roks-quickstart.drawio.svg"}
58+
59+
## Design concepts
60+
{: #ra-roks-qs-design-concepts}
61+
62+
![Design requirements for Red Hat OpenShift Container Platform on VPC landing zone](heat-map-deploy-arch-slz-roks-quickstart.svg "Design concepts"){: caption="Figure 2. Scope of the design concepts" caption-side="bottom"}
63+
64+
## Requirements
65+
{: #ra-roks-qs-requirements}
66+
67+
The following table outlines the requirements that are addressed in this architecture.
68+
69+
| Aspect | Requirements |
70+
|---|---|
71+
| Compute | Red Hat OpenShift cluster deployment with minimal machine size and nodes, suitable for low-cost demonstration and development |
72+
| Storage | Red Hat OpenShift required storage only, no additional storage supplied |
73+
| Networking | * Two VPCs deployed to demonstrate the concept of a "management-workload" relationship with a transit gateway. \n * All inbound and outbound traffic is allowed to VPCs. \n * Red Hat OpenShift cluster deployed with public administration endpoint to allow easy access to APIs and web console. \n * Load Balancer for cluster workload services. \n * Public Gateways on workload subnets to facilitate outbound internet access from cluster. \n * Transit Gateway to connect the management and workload VPCs. |
74+
| Security | * Encrypt all application data in transit and at rest to protect from unauthorized disclosure. \n * Encryption keys stored in IBM Cloud Key Protect service. * \n Protect cluster administration access through IBM Cloud security protocols. |
75+
| Service Management | Automated deployment of infrastructure with IBM Cloud catalog |
76+
{: caption="Table 1. Requirements" caption-side="bottom"}
77+
78+
## Components
79+
{: #ra-roks-qs-components}
80+
81+
The following table outlines the products or services used in the architecture for each aspect.
82+
83+
| Aspects | Architecture components | How the component is used |
84+
|---|---|---|
85+
| Compute | Red Hat OpenShift Container Platform | Container execution |
86+
| Storage | Cloud Object Storage | Requirement for Red Hat OpenShift deployment |
87+
| Networking | * VPC Load Balancers \n * Public Gateway \n * Transit Gateway | * Application load Balancing for cluster workloads \n * For cluster access to the internet \n * For private network connectivity between VPCs |
88+
| Security | * IAM \n * Key Protect | * IBM Cloud Identity & Access Management \n * Key Management Service |
89+
{: caption="Table 2. Components" caption-side="bottom"}

reference-architectures/heat-map-deploy-arch-slz-roks-quickstart.svg

Lines changed: 4 additions & 0 deletions
Loading

reference-architectures/roks-quickstart.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)