From ad48d0a8ed80e7ef9e06fb53a8214851f2a0e3ce Mon Sep 17 00:00:00 2001 From: Pan Ousley Date: Fri, 20 Oct 2023 14:39:40 -0400 Subject: [PATCH] CNV#28025: AWS BM GA and considerations --- modules/virt-aws-bm.adoc | 60 ++++++++++++++++++++ virt/install/preparing-cluster-for-virt.adoc | 39 +++++++------ 2 files changed, 81 insertions(+), 18 deletions(-) create mode 100644 modules/virt-aws-bm.adoc diff --git a/modules/virt-aws-bm.adoc b/modules/virt-aws-bm.adoc new file mode 100644 index 0000000000..04c1fd6327 --- /dev/null +++ b/modules/virt-aws-bm.adoc @@ -0,0 +1,60 @@ +// Module included in the following assemblies: +// +// * virt/install/preparing-cluster-for-virt.adoc + +:_content-type: CONCEPT +[id="virt-aws-bm_{context}"] += {VirtProductName} on AWS bare metal + +You can run {VirtProductName} on an Amazon Web Services (AWS) bare-metal {product-title} cluster. Before you set up your cluster, review the following summary of supported features and limitations: + +Installing:: +-- +* You can install the cluster by using installer-provisioned infrastructure, ensuring that you specify bare-metal node instance types in the `install-config.yaml` file. For example, you can use the `c5n.metal` type value for a machine based on x86_64 architecture. ++ +For more information, see the {product-title} documentation about installing on AWS. +-- + +Accessing virtual machines (VMs):: +-- +* There is no change to how you access VMs by using the `virtctl` CLI tool or the {product-title} web console. +* You can expose VMs by using a `NodePort` or `LoadBalancer` service. +** The load balancer approach is preferable because {product-title} automatically creates the load balancer in AWS and manages its lifecycle. A security group is also created for the load balancer, and you can use annotations to attach existing security groups. When you remove the service, {product-title} removes the load balancer and its associated resources. +-- + +Networking:: +-- +* You cannot use Single Root I/O Virtualization (SR-IOV) or bridge Container Network Interface (CNI) networks, including virtual LAN (VLAN). If your application requires a flat layer 2 network or control over the IP pool, consider using OVN-Kubernetes secondary overlay networks. +-- + +Storage:: +-- +* link:https://docs.portworx.com/portworx-enterprise/install-portworx/openshift[Portworx] is supported as a storage provider for {VirtProductName} on AWS bare metal. +** To use Portworx with {VirtProductName}, you must configure the `StorageClass` manifest to support live migration. For example: ++ +.Example `StorageClass` manifest +[source,yaml] +---- +allowVolumeExpansion: true +apiVersion: storage.k8s.io/v1 +kind: StorageClass +metadata: + annotations: + params/aggregation_level: Specifies the number of replication sets the volume + can be aggregated from +#... + name: px-csi-db-shared +parameters: + io_profile: db_remote + repl: "2" <1> + sharedv4: "true" + sharedv4_mount_options: vers=3.0,nolock <2> + sharedv4_svc_type: ClusterIP +provisioner: pxd.portworx.com +reclaimPolicy: Delete +volumeBindingMode: Immediate +---- +<1> Use `repl: "2"` for a cluster with 3 worker nodes. +<2> You must use NFS version 3 with the `nolock` mount option. +-- +* Amazon Elastic File System (EFS) and Amazon Elastic Block Store (EBS) are not supported for use with {VirtProductName} due to performance and functionality limitations. \ No newline at end of file diff --git a/virt/install/preparing-cluster-for-virt.adoc b/virt/install/preparing-cluster-for-virt.adoc index 9fe3c9a93e..7d24af5ef2 100644 --- a/virt/install/preparing-cluster-for-virt.adoc +++ b/virt/install/preparing-cluster-for-virt.adoc @@ -25,25 +25,15 @@ You cannot run {VirtProductName} on a single-stack IPv6 cluster. If you install your cluster in xref:../../installing/installing-fips.adoc#installing-fips-mode_installing-fips[FIPS mode], no additional setup is required for {VirtProductName}. -// Section is in assembly so that we can use xrefs -[id="virt-hardware-os-requirements_preparing-cluster-for-virt"] -== Hardware and operating system requirements - -Review the following hardware and operating system requirements for {VirtProductName}. - [id="supported-platforms_preparing-cluster-for-virt"] -=== Supported platforms +== Supported platforms + +You can use the following platforms with {VirtProductName}: * On-premise bare metal servers. See xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Planning a bare metal cluster for {VirtProductName}]. -* Amazon Web Services bare metal instances. See link:https://access.redhat.com/articles/6409731[Deploy {VirtProductName} on AWS metal instance types]. -+ --- -ifdef::openshift-enterprise[] -:FeatureName: Installing OpenShift Virtualization on AWS bare metal instances -include::snippets/technology-preview.adoc[] -:!FeatureName: -endif::[] --- + +* Amazon Web Services bare metal instances. See xref:../../installing/installing_aws/installing-aws-customizations.html#installing-aws-customizations[Installing a cluster on AWS with customizations]. +//See link:https://access.redhat.com/articles/6409731[Deploy {VirtProductName} on AWS metal instance types]. // seems outdated with references to OCS - remove? * IBM Cloud Bare Metal Servers. See link:https://access.redhat.com/articles/6738731[Deploy {VirtProductName} on IBM Cloud Bare Metal nodes]. + @@ -54,8 +44,21 @@ include::snippets/technology-preview.adoc[] :!FeatureName: endif::[] -- -+ -*Bare metal instances or servers offered by other cloud providers are not supported.* + +Bare metal instances or servers offered by other cloud providers are not supported. + +include::modules/virt-aws-bm.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Connecting a virtual machine to an OVN-Kubernetes secondary network] +* xref:../../virt/vm_networking/virt-exposing-vm-with-service.adoc#virt-exposing-vm-with-service[Exposing a virtual machine by using a service] + +// Section is in assembly so that we can use xrefs +[id="virt-hardware-os-requirements_preparing-cluster-for-virt"] +== Hardware and operating system requirements + +Review the following hardware and operating system requirements for {VirtProductName}. [id="cpu-requirements_preparing-cluster-for-virt"] === CPU requirements