Skip to content

Commit 5a4868a

Browse files
mjpytlakmjpytlak
authored
Merge pull request #48577 from mjpytlak/osdocs-3029
OSDOCS-3029: Added Azure Marketplace install content
2 parents 7076e09 + 02a58b3 commit 5a4868a

File tree

5 files changed

+164
-0
lines changed

5 files changed

+164
-0
lines changed

‎installing/installing_azure/installing-azure-account.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ include::modules/installation-azure-service-principal.adoc[leveloffset=+1]
3333

3434
* For more information about CCO modes, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator].
3535
36+
include::modules/installation-azure-marketplace.adoc[leveloffset=+1]
37+
3638
include::modules/installation-azure-regions.adoc[leveloffset=+1]
3739

3840
== Next steps

‎installing/installing_azure/installing-azure-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
2424

2525
include::modules/ssh-agent-using.adoc[leveloffset=+1]
2626

27+
include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+1]
28+
2729
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
2830

2931
include::modules/installation-initializing.adoc[leveloffset=+1]

‎installing/installing_azure/installing-azure-user-infra.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ include::modules/installation-machine-requirements.adoc[leveloffset=+2]
7272
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
7373
include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2]
7474

75+
include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+1]
76+
7577
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
7678

7779
include::modules/ssh-agent-using.adoc[leveloffset=+1]

‎modules/installation-azure-marketplace-subscribe.adoc

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_aws/installing-azure-customizations.adoc
4+
// * installing/installing_aws/installing-azure-user-infra.adoc
5+
6+
ifeval::["{context}" == "installing-azure-customizations"]
7+
:ipi:
8+
endif::[]
9+
ifeval::["{context}" == "installing-azure-user-infra"]
10+
:upi:
11+
endif::[]
12+
13+
//mpytlak: The procedure differs depending on whether this module is used in an IPI or UPI assembly.
14+
15+
:_content-type: PROCEDURE
16+
[id="installation-azure-marketplace-subscribe_{context}"]
17+
= Selecting an Azure Marketplace image
18+
If you are deploying an {product-title} cluster using the Azure Marketplace offering, you must first obtain the Azure Marketplace image. The installation program uses this image to deploy worker nodes. When obtaining your image, consider the following:
19+
20+
* While the images are the same, the Azure Marketplace publisher is different depending on your region. If you are located in North America, specify `redhat` as the publisher. If you are located in EMEA, specify `redhat-limited` as the publisher.
21+
* The offer includes a `rh-ocp-worker` SKU and a `rh-ocp-worker-gen1` SKU. The `rh-ocp-worker` SKU represents a Hyper-V generation version 2 VM image. The default instance types used in {product-title} are version 2 compatible. If you are going to use an instance type that is only version 1 compatible, use the image associated with the `rh-ocp-worker-gen1` SKU. The `rh-ocp-worker-gen1` SKU represents a Hyper-V version 1 VM image.
22+
23+
.Prerequisites
24+
25+
* You have installed the Azure CLI client `(az)`.
26+
* Your Azure account is entitled for the offer and you have logged into this account with the Azure CLI client.
27+
28+
.Procedure
29+
30+
. Display all of the available {product-title} images by running one of the following commands:
31+
** North America:
32+
+
33+
--
34+
[source,terminal]
35+
----
36+
$ az vm image list --all --offer rh-ocp-worker --publisher redhat -o table
37+
----
38+
.Example output
39+
[source,terminal]
40+
----
41+
Offer Publisher Sku Urn Version
42+
------------- -------------- ------------------ -------------------------------------------------------------- --------------
43+
rh-ocp-worker RedHat rh-ocp-worker RedHat:rh-ocp-worker:rh-ocpworker:4.8.2021122100 4.8.2021122100
44+
rh-ocp-worker RedHat rh-ocp-worker-gen1 RedHat:rh-ocp-worker:rh-ocp-worker-gen1:4.8.2021122100 4.8.2021122100
45+
----
46+
--
47+
** EMEA:
48+
+
49+
--
50+
[source,terminal]
51+
----
52+
$ az vm image list --all --offer rh-ocp-worker --publisher redhat-limited -o table
53+
----
54+
.Example output
55+
[source,terminal]
56+
----
57+
Offer Publisher Sku Urn Version
58+
------------- -------------- ------------------ -------------------------------------------------------------- --------------
59+
rh-ocp-worker redhat-limited rh-ocp-worker redhat-limited:rh-ocp-worker:rh-ocp-worker:4.8.2021122100 4.8.2021122100
60+
rh-ocp-worker redhat-limited rh-ocp-worker-gen1 redhat-limited:rh-ocp-worker:rh-ocp-worker-gen1:4.8.2021122100 4.8.2021122100
61+
----
62+
--
63+
64+
+
65+
[NOTE]
66+
====
67+
Regardless of the version of {product-title} you are installing, the correct version of the Azure Marketplace image to use is 4.8.x. If required, as part of the installation process, your VMs are automatically upgraded.
68+
====
69+
. Inspect the image for your offer by running one of the following commands:
70+
** North America:
71+
+
72+
[source,terminal]
73+
----
74+
$ az vm image show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>
75+
----
76+
** EMEA:
77+
+
78+
[source,terminal]
79+
----
80+
$ az vm image show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>
81+
----
82+
. Review the terms of the offer by running one of the following commands:
83+
** North America:
84+
+
85+
[source,terminal]
86+
----
87+
$ az vm image terms show --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>
88+
----
89+
** EMEA:
90+
+
91+
[source,terminal]
92+
----
93+
$ az vm image terms show --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>
94+
----
95+
. Accept the terms of the offering by running one of the following commands:
96+
** North America:
97+
+
98+
[source,terminal]
99+
----
100+
$ az vm image terms accept --urn redhat:rh-ocp-worker:rh-ocp-worker:<version>
101+
----
102+
** EMEA:
103+
+
104+
[source,terminal]
105+
----
106+
$ az vm image terms accept --urn redhat-limited:rh-ocp-worker:rh-ocp-worker:<version>
107+
----
108+
ifdef::ipi[]
109+
. Record the image details of your offer. You must update the `compute` section in the `install-config.yaml` file with values for `publisher`, `offer`, `sku`, and `version` before deploying the cluster.
110+
endif::ipi[]
111+
ifdef::upi[]
112+
. Record the image details of your offer. If you use the Azure Resource Manager (ARM) template to deploy your worker nodes, you can update `storageProfile.imageReference` by deleting the `id` parameter and adding the `offer`, `publisher`, `sku`, and `version` parameters using the values from your offer.
113+
endif::upi[]
114+
115+
ifdef::ipi[]
116+
.Sample `install-config.yaml` file with the Azure Marketplace worker nodes
117+
118+
[source,yaml]
119+
----
120+
apiVersion: v1
121+
baseDomain: example.com
122+
compute:
123+
- hyperthreading: Enabled
124+
name: worker
125+
platform:
126+
azure:
127+
type: Standard_D4s_v5
128+
osImage:
129+
publisher: redhat
130+
offer: rh-ocp-worker
131+
sku: rh-ocp-worker
132+
version: 4.8.2021122100
133+
replicas: 3
134+
----
135+
endif::ipi[]
136+
137+
ifeval::["{context}" == "installing-azure-customizations"]
138+
:!ipi:
139+
endif::[]
140+
ifeval::["{context}" == "installing-azure-user-infra"]
141+
:!upi:
142+
endif::[]

‎modules/installation-azure-marketplace.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_aws/installing-azure-account.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="installation-azure-marketplace_{context}"]
7+
= Supported Azure Marketplace regions
8+
9+
Installing a cluster using the Azure Marketplace image is available to customers who purchase the offer in North America and EMEA.
10+
11+
While the offer must be purchased in North America or EMEA, you can deploy the cluster to any of the Azure public partitions that {product-title} supports.
12+
13+
[NOTE]
14+
====
15+
Deploying a cluster using the Azure Marketplace image is not supported for the Azure Government regions.
16+
====

0 commit comments

Comments
 (0)