Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

https://issues.redhat.com/browse/ACM-15868 Add External platform #7362

Open
wants to merge 3 commits into
base: 2.13_stage
Choose a base branch
from
Open

https://issues.redhat.com/browse/ACM-15868 Add External platform #7362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
629ae64
https://issues.redhat.com/browse/ACM-15868 Add External platform
oafischer Jan 9, 2025
cb7692e
https://issues.redhat.com/browse/ACM-15868 Add External platform
oafischer Jan 9, 2025
cd6afad
https://issues.redhat.com/browse/ACM-15868 Add External platform
oafischer Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions clusters/cluster_lifecycle/create_cluster_on_prem.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[#creating-a-cluster-on-premises]
= Creating a cluster in an on-premises environment

You can use the console to create on-premises {ocp} clusters. The clusters can be {sno} clusters, multi-node clusters, and compact three-node clusters on VMware vSphere, Red Hat OpenStack, Nutanix, or in a bare metal environment.
You can use the console to create on-premises {ocp} clusters. The clusters can be {sno} clusters, multi-node clusters, and compact three-node clusters on VMware vSphere, Red Hat OpenStack, Nutanix, External, or in a bare metal environment.

There is no platform integration with the platform where you install the cluster, as the platform value is set to `platform=none`. A {sno} cluster contains only a single node, which hosts the control plane services and the user workloads. This configuration can be helpful when you want to minimize the resource footprint of the cluster.
There is no platform integration with the platform where you install the cluster, as the platform value is set to `platform=none`. A {sno} cluster has only a single node, which hosts the control plane services and the user workloads. This configuration can be helpful when you want to minimize the resource footprint of the cluster.

You can also provision multiple {sno} clusters on edge resources by using the zero touch provisioning feature, which is a feature that is available with {ocp}. For more information about zero touch provisioning, see _Clusters at the network far edge_ in the {ocp-short} documentation.

Expand Down Expand Up @@ -189,7 +189,7 @@ spec:
<1> Use the name of your `AgentClusterInstall` resource.
<2> Use the pull secret that you downloaded in <<on-prem-creating-your-cluster-with-the-cli-pull-secret,Add the pull secret to the namespace>>.

[#on-prem-creating-your-cluster-with-the-cli-agentclusterinstall]
[#create-agentclusterinstall-cr]
=== Create the AgentClusterInstall custom resource

In the `AgentClusterInstall` custom resource, you can specify many of the requirements for the clusters. For example, you can specify the cluster network settings, platform, number of control planes, and worker nodes.
Expand Down Expand Up @@ -225,7 +225,27 @@ spec:
<1> Specify the platform type of the environment where the cluster is created. Valid values are: `BareMetal`, `None`, `VSphere`, `Nutanix`, or `External`.
<2> Use the same name that you used for your `ClusterDeployment` resource.
<3> Use the `ClusterImageSet` that you generated in <<on-prem-creating-your-cluster-with-the-cli-cluster-image-set,Generate a ClusterImageSet>>.
<4> You can specify your SSH public key, which enables you to access the host after it is installed.
<4> You can specify your SSH public key, which enables you to access the host after it is installed.

If you set `platformType:` to `External`, you must add the `external` spec. See the following example:

[source,yaml]
----
apiVersion: extensions.hive.openshift.io/v1beta1
kind: AgentClusterInstall
metadata:
name: test-agent-cluster-install
namespace: demo-worker4
spec:
platformType: External
external:
platformName: "myplatform" <1>
cloudControllerManager: External <2>
----

<1> Add your platform name.
<2> Leave empty to disable the Cloud Controller Manager during installation.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<2> Leave empty to disable the Cloud Controller Manager during installation.
<2> Leave empty to disable the Cloud Controller Manager during installation.

what do you think about adding that when cloudControllerManager is set to External, we expect the user to add custom manifests that will enable the cloud controller manager.



[#on-prem-creating-your-cluster-with-the-cli-nmstateconfig]
=== Optional: Create the NMStateConfig custom resource
Expand Down
4 changes: 3 additions & 1 deletion clusters/release_notes/mce_whats_new.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,6 @@ If you are using {mce-short} 2.6 and earlier, the hosted control planes document
[#cluster-management-new]
== Cluster management

Learn about new features and enhancements for Cluster lifecycle with {mce-short}.
Learn about new features and enhancements for Cluster lifecycle with {mce-short}.

You can now use the `External` platform in {ai}, which allows you to use integration components from cloud providers. To learn more, see link:../../clusters/cluster_lifecycle/create_cluster_on_prem.adoc#create-agentclusterinstall-cr[Create the AgentClusterInstall custom resource]
Loading