Skip to content

Commit c398d39

Browse files
authored
Merge pull request #86242 from bscott-rh/OSDOCS-12755
OSDOCS-12755 adding admonition to only use marketplace images for compute nodes
2 parents 43857aa + 0ccdf8e commit c398d39

5 files changed

+35
-3
lines changed

modules/installation-aws-marketplace-subscribe.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ endif::[]
2727
= Obtaining an AWS Marketplace image
2828
If you are deploying an {product-title} cluster using an AWS Marketplace image, you must first subscribe through AWS. Subscribing to the offer provides you with the AMI ID that the installation program uses to deploy compute nodes.
2929

30+
:platform-abbreviation: an AWS
31+
:platform-abbreviation-short: AWS
32+
[NOTE]
33+
====
34+
include::snippets/installation-marketplace-note.adoc[]
35+
====
36+
3037
.Prerequisites
3138

3239
* You have an AWS account to purchase the offer. This account does not have to be the same account that is used to install the cluster.

modules/installation-azure-marketplace-subscribe.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,14 @@ endif::mapi[]
4141
* 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 plan 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.
4242
//What happens with control plane machines? "worker" SKU seems incorrect
4343
44+
:platform-abbreviation: an Azure
45+
:platform-abbreviation-short: Azure
46+
4447
[IMPORTANT]
4548
====
4649
Installing images with the Azure marketplace is not supported on clusters with 64-bit ARM instances.
50+
51+
include::snippets/installation-marketplace-note.adoc[]
4752
====
4853

4954
.Prerequisites

modules/installation-configuration-parameters.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1697,7 +1697,7 @@ within link:https://azure.microsoft.com/en-us/global-infrastructure/regions[a re
16971697
defaultMachinePlatform:
16981698
osImage:
16991699
publisher:
1700-
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane and compute machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for both types of machines.
1700+
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane and compute machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for both types of machines. Control plane machines do not contribute to licensing costs when using the default image, but if you apply an Azure Marketplace image for a control plane machine, usage costs will apply.
17011701
|String. The name of the image publisher.
17021702

17031703
|platform:
@@ -1793,7 +1793,7 @@ within link:https://azure.microsoft.com/en-us/global-infrastructure/regions[a re
17931793
azure:
17941794
osImage:
17951795
publisher:
1796-
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for control plane machines only.
1796+
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by using a custom {op-system} image that is available from the Azure Marketplace. The installation program uses this image for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image, but if you apply an Azure Marketplace image for a control plane machine, usage costs will apply.
17971797
|String. The name of the image publisher.
17981798

17991799
|controlPlane:
@@ -2133,7 +2133,7 @@ Additional GCP configuration parameters are described in the following table:
21332133
gcp:
21342134
osImage:
21352135
project:
2136-
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by specifying the location of a custom {op-system} image that the installation program is to use for control plane machines only.
2136+
|Optional. By default, the installation program downloads and installs the {op-system-first} image that is used to boot control plane machines. You can override the default behavior by specifying the location of a custom {op-system} image that the installation program is to use for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image, but if you apply a GCP Marketplace image for a control plane machine, usage costs will apply.
21372137
|String. The name of GCP project where the image is located.
21382138

21392139
|controlPlane:

modules/installation-gcp-marketplace.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ Using the GCP Marketplace offering lets you deploy an {product-title} cluster, w
1010

1111
By default, the installation program downloads and installs the {op-system-first} image that is used to deploy compute machines. To deploy an {product-title} cluster using an {op-system} image from the GCP Marketplace, override the default behavior by modifying the `install-config.yaml` file to reference the location of GCP Marketplace offer.
1212

13+
:platform-abbreviation: a GCP
14+
:platform-abbreviation-short: GCP
15+
16+
[NOTE]
17+
====
18+
include::snippets/installation-marketplace-note.adoc[]
19+
====
20+
1321
.Prerequisites
1422

1523
* You have an existing `install-config.yaml` file.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Text snippet included in the following modules:
2+
//
3+
// * modules/installation-aws-marketplace-subscribe.adoc
4+
// * modules/installation-azure-marketplace-subscribe.adoc
5+
// * modules/installation-gcp-marketplace.adoc
6+
7+
:_mod-docs-content-type: SNIPPET
8+
9+
You should only modify the {op-system} image for compute machines to use {platform-abbreviation} Marketplace image. Control plane machines and infrastructure nodes do not require an {product-title} subscription and use the public RHCOS default image by default, which does not incur subscription costs on your {platform-abbreviation-short} bill. Therefore, you should not modify the cluster default boot image or the control plane boot images. Applying the {platform-abbreviation-short} Marketplace image to them will incur additional licensing costs that cannot be recovered.
10+
11+
:!platform-abbreviation:
12+
:!platform-abbreviation-short:

0 commit comments

Comments
 (0)