Skip to content

Commit af7e305

Browse files
authored
Merge pull request #94569 from johnwilkins/HCIDOCS-304
HCIDOCS-304: Added a concept module introducing the Cluster API
2 parents f368c42 + 32fe411 commit af7e305

File tree

6 files changed

+30
-4
lines changed

6 files changed

+30
-4
lines changed

installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ toc::[]
88

99
After successfully deploying a bare-metal cluster, consider the following postinstallation procedures.
1010

11+
12+
//About the cluster API
13+
include::modules/bare-metal-about-the-cluster-api.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
18+
* xref:../../machine_management/cluster_api_machine_management/cluster-api-about.adoc#luster-api-about[About the Cluster API]
19+
* xref:../../machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc#cluster-api-getting-started[Getting started with the Cluster API]
20+
1121
// Configuring NTP for disconnected clusters
1222
include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leveloffset=+1]
1323

machine_management/cluster_api_machine_management/cluster-api-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99
:FeatureName: Managing machines with the Cluster API
1010
include::snippets/technology-preview.adoc[]
1111

12-
The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first}.
12+
The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, {vmw-first}, and bare metal.
1313

1414
//Cluster API overview
1515
include::modules/capi-overview.adoc[leveloffset=+1]

machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ include::modules/capi-creating-machine-template.adoc[leveloffset=+2]
2525
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
2626
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-template-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API machine template resource on {rh-openstack}]
2727
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
28+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-bare-metal.adoc#capi-yaml-machine-template-bare-metal_cluster-api-config-options-bare-metal[Sample YAML for a Cluster API machine template resource on bare metal]
2829

2930
//Creating a Cluster API compute machine set
3031
include::modules/capi-creating-machine-set.adoc[leveloffset=+2]
@@ -34,4 +35,5 @@ include::modules/capi-creating-machine-set.adoc[leveloffset=+2]
3435
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-set-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API compute machine set resource on {gcp-full}]
3536
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-set-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API compute machine set resource on {azure-full}]
3637
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-rhosp.adoc#capi-yaml-machine-set-rhosp_cluster-api-config-options-rhosp[Sample YAML for a Cluster API compute machine set resource on {rh-openstack}]
37-
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]
38+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]
39+
* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-bare-metal.adoc#capi-yaml-machine-set-bare-metal_cluster-api-config-options-bare-metal[Sample YAML for a Cluster API compute machine set resource on bare metal]
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="bare-metal-about-the-cluster-api_{context}"]
7+
= About the Cluster API
8+
9+
{product-title} 4.19 and later releases can manage machines by using the Cluster API.
10+
11+
:FeatureName: Managing machines with the Cluster API
12+
include::snippets/technology-preview.adoc[]
13+
14+
You can use the Cluster API to perform compute node provisioning management actions after the cluster installation finishes. The Cluster API allows dynamic management of compute node machine sets and machines. However, there is no support for control plane machines.

modules/capi-creating-machine-template.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ $ oc create -f <machine_template_resource_file>.yaml
7676
+
7777
[source,terminal]
7878
----
79-
$ oc get <machine_template_kind>
79+
$ oc get <machine_template_kind> -n openshift-cluster-api
8080
----
8181
+
8282
where `<machine_template_kind>` is the value that corresponds to your platform.

modules/capi-limitations.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Using the Cluster API to manage machines is a Technology Preview feature and has
1515
Enabling this feature set cannot be undone and prevents minor version updates.
1616
====
1717
18-
* Only {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first} clusters can use the Cluster API.
18+
* Only {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, {vmw-first}, and bare-metal clusters can use the Cluster API.
1919
2020
* You must manually create some of the primary resources that the Cluster API requires.
2121
For more information, see "Getting started with the Cluster API".

0 commit comments

Comments
 (0)