Skip to content

Commit f46ec85

Browse files
committed
add red hat marketplace for osd
1 parent 4d34f2f commit f46ec85

File tree

2 files changed

+194
-0
lines changed

2 files changed

+194
-0
lines changed
Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="osd-create-cluster-rhm-gcp-account_{context}"]
7+
= Creating a cluster on GCP with Red Hat Marketplace
8+
9+
When creating an {product-title} (OSD) cluster on Google Cloud through the OpenShift Cluster Manager Hybrid Cloud Console, customers can select Red Hat Marketplace as their preferred billing model.
10+
OSD pricing is consumption-based and customers are billed directly through their Red Hat Marketplace account.
11+
12+
.Procedure
13+
14+
. Log in to {cluster-manager-url} and click *Create cluster*.
15+
16+
. In the *Cloud* tab, click *Create cluster* in the *Red Hat OpenShift Dedicated* row.
17+
18+
. Under *Billing model*, configure the subscription type and infrastructure type:
19+
.. Select the *On-Demand* subscription type.
20+
.. From the drop-down menu, select *Red Hat Marketplace*.
21+
.. Click *Next*.
22+
. On the *Cloud provider* page:
23+
.. Select *Google Cloud* as your cloud provider.
24+
.. Click the checkbox indicating that you have read and completed all the prerequisites necessary to continue creating your cluster.
25+
.. Add your service account key.
26+
+
27+
[NOTE]
28+
====
29+
For more information about service account keys, click the information icon located next to *Service account key*.
30+
====
31+
.. Click *Next* to validate your cloud provider account and go to the *Cluster details* page.
32+
. On the *Cluster details* page, provide a name for your cluster and specify the cluster details:
33+
.. Add a *Cluster name*.
34+
.. Select a cluster version from the *Version* drop-down menu.
35+
.. Select a cloud provider region from the *Region* drop-down menu.
36+
.. Select a *Single zone* or *Multi-zone* configuration.
37+
+
38+
.. Optional: Select *Enable Secure Boot for Shielded VMs* to use Shielded VMs when installing your cluster. For more information, see link:https://cloud.google.com/security/products/shielded-vm[Shielded VMs].
39+
+
40+
[IMPORTANT]
41+
====
42+
To successfully create a cluster, you must select *Enable Secure Boot support for Shielded VMs* if your organization has the policy constraint `constraints/compute.requireShieldedVm` enabled. For more information regarding GCP organizational policy constraints, see link:https://cloud.google.com/resource-manager/docs/organization-policy/org-policy-constraints[Organization policy constraints].
43+
====
44+
+
45+
.. Leave *Enable user workload monitoring* selected to monitor your own projects in isolation from Red Hat Site Reliability Engineer (SRE) platform metrics. This option is enabled by default.
46+
47+
. Optional: Expand *Advanced Encryption* to make changes to encryption settings.
48+
49+
.. Select *Use Custom KMS keys* to use custom KMS keys. If you prefer not to use custom KMS keys, leave the default setting *Use default KMS Keys*.
50+
+
51+
[IMPORTANT]
52+
====
53+
To use custom KMS keys, the IAM service account `osd-ccs-admin` must be granted the *Cloud KMS CryptoKey Encrypter/Decrypter* role. For more information about granting roles on a resource, see link:https://cloud.google.com/kms/docs/iam#granting_roles_on_a_resource[Granting roles on a resource].
54+
====
55+
+
56+
With *Use Custom KMS keys* selected:
57+
58+
... Select a key ring location from the *Key ring location* drop-down menu.
59+
... Select a key ring from the *Key ring* drop-down menu.
60+
... Select a key name from the *Key name* drop-down menu.
61+
... Provide the *KMS Service Account*.
62+
63+
+
64+
.. Optional: Select *Enable additional etcd encryption* if you require etcd key value encryption.
65+
With this option, the etcd key values are encrypted, but not the keys. This option is in addition to the control plane storage encryption that encrypts the etcd volumes in {product-title} clusters by default.
66+
+
67+
[NOTE]
68+
====
69+
By enabling etcd encryption for the key values in etcd, you incur a performance overhead of approximately 20%. The overhead is a result of introducing this second layer of encryption, in addition to the default control plane storage encryption that encrypts the etcd volumes. Consider enabling etcd encryption only if you specifically require it for your use case.
70+
====
71+
+
72+
.. Optional: Select *Enable FIPS cryptography* if you require your cluster to be FIPS validated.
73+
+
74+
. Click *Next*.
75+
76+
. On the *Machine pool* page, select a *Compute node instance type* and a *Compute node count*. The number and types of nodes that are available depend on your {product-title} subscription. If you are using multiple availability zones, the compute node count is per zone.
77+
+
78+
[NOTE]
79+
====
80+
After your cluster is created, you can change the number of compute nodes, but you cannot change the compute node instance type in a created machine pool. You can add machine pools after installation that use a customized instance type. The number and types of nodes available to you depend on your {product-title} subscription.
81+
====
82+
83+
. Optional: Expand *Add node labels* to add labels to your nodes. Click *Add additional label* to add more node labels.
84+
85+
. Click *Next*.
86+
87+
. In the *Cluster privacy* dialog, select *Public* or *Private* to use either public or private API endpoints and application routes for your cluster.
88+
+
89+
. Optional: To install the cluster in an existing GCP Virtual Private Cloud (VPC):
90+
.. Select *Install into an existing VPC*.
91+
.. If you are installing into an existing VPC and you want to enable an HTTP or HTTPS proxy for your cluster, select *Configure a cluster-wide proxy*.
92+
93+
+
94+
. Click *Next*.
95+
+
96+
97+
. Optional: To install the cluster into a GCP Shared VPC:
98+
+
99+
[IMPORTANT]
100+
====
101+
102+
To install a cluster into a Shared VPC, you must use {product-title} version 4.13.15 or above. Additionally, the VPC owner of the host project must enable a project as a host project in their Google Cloud console. For more information, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#set-up-shared-vpc[Enable a host project].
103+
====
104+
105+
.. Select *Install into GCP Shared VPC*.
106+
.. Specify the *Host project ID*. If the specified host project ID is incorrect, cluster creation fails.
107+
+
108+
[IMPORTANT]
109+
====
110+
Once you complete the steps within the cluster configuration wizard and click *Create Cluster*, the cluster will go into the "Installation Waiting" state. At this point, you must contact the VPC owner of the host project, who must assign the dynamically-generated service account the following roles: *Computer Network Administrator*, *Compute Security Administrator*, and *DNS Administrator*.
111+
The VPC owner of the host project has 30 days to grant the listed permissions before the cluster creation fails.
112+
For information about Shared VPC permissions, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#migs-service-accounts[Provision Shared VPC].
113+
====
114+
+
115+
. If you opted to install the cluster in an existing GCP VPC, provide your *Virtual Private Cloud (VPC) subnet settings* and select *Next*.
116+
You must have created the Cloud network address translation (NAT) and a Cloud router. See the "Additional resources" section for information about Cloud NATs and Google VPCs.
117+
// +
118+
// [NOTE]
119+
// ====
120+
// You must ensure that your VPC is configured with a public and a private subnet for each availability zone that you want the cluster installed into. If you opted to use PrivateLink, only private subnets are required.
121+
// ====
122+
+
123+
[NOTE]
124+
====
125+
If you are installing a cluster into a Shared VPC, the VPC name and subnets are shared from the host project.
126+
====
127+
+
128+
. Click *Next*.
129+
. If you opted to configure a cluster-wide proxy, provide your proxy configuration details on the *Cluster-wide proxy* page:
130+
+
131+
--
132+
.. Enter a value in at least one of the following fields:
133+
** Specify a valid *HTTP proxy URL*.
134+
** Specify a valid *HTTPS proxy URL*.
135+
** In the *Additional trust bundle* field, provide a PEM encoded X.509 certificate bundle. The bundle is added to the trusted certificate store for the cluster nodes. An additional trust bundle file is required unless the identity certificate for the proxy is signed by an authority from the {op-system-first} trust bundle.
136+
+
137+
If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional certificate authorities (CAs), you must provide the MITM CA certificate.
138+
+
139+
[NOTE]
140+
====
141+
If you upload an additional trust bundle file without specifying an HTTP or HTTPS proxy URL, the bundle is set on the cluster but is not configured to be used with the proxy.
142+
====
143+
.. Click *Next*.
144+
--
145+
+
146+
For more information about configuring a proxy with {product-title}, see _Configuring a cluster-wide proxy_.
147+
148+
+
149+
. In the *CIDR ranges* dialog, configure custom classless inter-domain routing (CIDR) ranges or use the defaults that are provided.
150+
+
151+
[IMPORTANT]
152+
====
153+
CIDR configurations cannot be changed later. Confirm your selections with your network administrator before proceeding.
154+
155+
If the cluster privacy is set to *Private*, you cannot access your cluster until you configure private connections in your cloud provider.
156+
====
157+
158+
. On the *Cluster update strategy* page, configure your update preferences:
159+
.. Choose a cluster update method:
160+
** Select *Individual updates* if you want to schedule each update individually. This is the default option.
161+
** Select *Recurring updates* to update your cluster on your preferred day and start time, when updates are available.
162+
+
163+
[NOTE]
164+
====
165+
You can review the end-of-life dates in the update lifecycle documentation for {product-title}. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_dedicated/4/html/introduction_to_openshift_dedicated/policies-and-service-definition#osd-life-cycle[OpenShift Dedicated update life cycle].
166+
====
167+
+
168+
.. Provide administrator approval based on your cluster update method:
169+
** Individual updates: If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*.
170+
** Recurring updates: If you selected recurring updates for your cluster, provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment.
171+
+
172+
For information about administrator acknowledgment, see xref:./../upgrading/osd-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_osd-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
173+
.. If you opted for recurring updates, select a preferred day of the week and upgrade start time in UTC from the drop-down menus.
174+
.. Optional: You can set a grace period for *Node draining* during cluster upgrades. A *1 hour* grace period is set by default.
175+
.. Click *Next*.
176+
+
177+
[NOTE]
178+
====
179+
In the event of critical security concerns that significantly impact the security or stability of a cluster, Red Hat Site Reliability Engineering (SRE) might schedule automatic updates to the latest z-stream version that is not impacted. The updates are applied within 48 hours after customer notifications are provided. For a description of the critical impact security rating, see link:https://access.redhat.com/security/updates/classification[Understanding Red Hat security ratings].
180+
====
181+
182+
. Review the summary of your selections and click *Create cluster* to start the cluster installation. The installation takes approximately 30-40 minutes to complete.
183+
184+
.Verification
185+
186+
* You can monitor the progress of the installation in the *Overview* page for your cluster. You can view the installation logs on the same page. Your cluster is ready when the *Status* in the *Details* section of the page is listed as *Ready*.
187+
188+
ifeval::["{context}" == "osd-creating-a-cluster-on-aws"]
189+
:!osd-on-aws:
190+
endif::[]
191+
ifeval::["{context}" == "osd-creating-a-cluster-on-gcp"]
192+
:!osd-on-gcp:
193+
endif::[]

osd_install_access_delete_cluster/creating-a-gcp-cluster.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can install {product-title} on {GCP} by using your own GCP account through t
1818
include::modules/osd-create-cluster-ccs.adoc[leveloffset=+1]
1919
include::modules/osd-create-cluster-gcp-account.adoc[leveloffset=+1]
2020
include::modules/osd-create-cluster-red-hat-account.adoc[leveloffset=+1]
21+
include::modules/osd-create-cluster-rhm-gcp-account.adoc[leveloffset=+1]
2122
[id="additional-resources_{context}"]
2223
== Additional resources
2324

0 commit comments

Comments
 (0)