Skip to content

Commit 7567b5f

Browse files
authored
Merge pull request #50943 from mjpytlak/osdocs-4151
OSDOCS-4151: Adding section on using custom machine types
2 parents dd94bd1 + dd4f250 commit 7567b5f

9 files changed

+97
-0
lines changed

installing/installing_gcp/installing-gcp-customizations.adoc

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

3434
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
3535

36+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
37+
3638
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
3739

3840
[role="_additional-resources"]

installing/installing_gcp/installing-gcp-network-customizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4040

4141
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
4242

43+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
44+
4345
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
4446

4547
[role="_additional-resources"]

installing/installing_gcp/installing-gcp-private.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
3737

3838
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
3939

40+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
41+
4042
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
4143

4244
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-user-infra-vpc.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ This section describes the requirements for deploying {product-title} on user-pr
6161
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
6262
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
6363
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
64+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
6465

6566
include::modules/installation-gcp-user-infra-config-host-project-vpc.adoc[leveloffset=+1]
6667
include::modules/installation-gcp-dns.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-user-infra.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ This section describes the requirements for deploying {product-title} on user-pr
5656
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
5757
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5858
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
59+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
5960

6061
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
6162
include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-vpc.adoc

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

3434
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
3535

36+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
37+
3638
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
3739

3840
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4444

4545
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
4646

47+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
48+
4749
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
4850

4951
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

installing/installing_gcp/installing-restricted-networks-gcp.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ This section describes the requirements for deploying {product-title} on user-pr
6363
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
6464
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
6565
include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2]
66+
include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2]
6667

6768
include::modules/installation-user-infra-generate.adoc[leveloffset=+1]
6869
include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2]
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_gcp/installing-gcp-customizations.adoc
4+
// * installing/installing_gcp/installing-gcp-network-customizations.adoc
5+
// * installing/installing_gcp/installing-gcp-private.adoc
6+
// * installing/installing_gcp/installing-gcp-vpc.adoc
7+
// * installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
8+
// * installing/installing_gcp/installing-gcp-user-infra.adoc
9+
// * installing/installing_gcp/installing-gcp-user-infra-vpc.adoc
10+
// * installing/installing_gcp/installing-restricted-networks-gcp.adoc
11+
12+
ifeval::["{context}" == "installing-gcp-customizations"]
13+
:ipi:
14+
endif::[]
15+
ifeval::["{context}" == "installing-gcp-network-customizations"]
16+
:ipi:
17+
endif::[]
18+
ifeval::["{context}" == "installing-gcp-private"]
19+
:ipi:
20+
endif::[]
21+
ifeval::["{context}" == "installing-gcp-vpc"]
22+
:ipi:
23+
endif::[]
24+
ifeval::["{context}" == "installing-restricted-networks-gcp-installer-provisioned"]
25+
:ipi:
26+
endif::[]
27+
28+
:_content-type: PROCEDURE
29+
[id="installation-custom-machine-types_{context}"]
30+
= Using custom machine types
31+
Using a custom machine type to install a {product-title} cluster is supported.
32+
33+
Consider the following when using a custom machine type:
34+
35+
* Similar to predefined instance types, custom machine types must meet the minimum resource requirements for control plane and compute machines. For more information, see "Minimum resource requirements for cluster installation".
36+
* The name of the custom machine type must adhere to the following syntax:
37+
+
38+
--
39+
`custom-<number_of_cpus>-<amount_of_memory_in_mb>`
40+
41+
For example, `custom-6-20480`.
42+
--
43+
44+
ifdef::ipi[]
45+
As part of the installation process, you specify the custom machine type in the `install-config.yaml` file.
46+
47+
.Sample `install-config.yaml` file with a custom machine type
48+
49+
[source,yaml]
50+
----
51+
compute:
52+
- architecture: amd64
53+
hyperthreading: Enabled
54+
name: worker
55+
platform:
56+
gcp:
57+
type: custom-6-20480
58+
replicas: 2
59+
controlPlane:
60+
architecture: amd64
61+
hyperthreading: Enabled
62+
name: master
63+
platform:
64+
gcp:
65+
type: custom-6-20480
66+
replicas: 3
67+
----
68+
endif::ipi[]
69+
70+
ifeval::["{context}" == "installing-gcp-customizations"]
71+
:!ipi:
72+
endif::[]
73+
ifeval::["{context}" == "installing-gcp-network-customizations"]
74+
:!ipi:
75+
endif::[]
76+
ifeval::["{context}" == "installing-gcp-private"]
77+
:!ipi:
78+
endif::[]
79+
ifeval::["{context}" == "installing-gcp-vpc"]
80+
:!ipi:
81+
endif::[]
82+
ifeval::["{context}" == "installing-restricted-networks-gcp-installer-provisioned"]
83+
:!ipi:
84+
endif::[]

0 commit comments

Comments
 (0)