diff --git a/guides/common/images/aws-combined-direct-orcharhino.svg b/guides/common/images/aws-combined-direct-orcharhino.svg new file mode 100644 index 00000000000..e185250d6eb --- /dev/null +++ b/guides/common/images/aws-combined-direct-orcharhino.svg @@ -0,0 +1,3 @@ + + +
Amazon Web Services
Internet
VPC
Base system
orcharhino Proxy Server
Client instances
Availability zone
Internet Gateway
Gateway
On-premise data center
orcharhino Server
Elastic IP
 diff --git a/guides/common/images/aws-combined-direct-satellite.png b/guides/common/images/aws-combined-direct-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-combined-direct.png b/guides/common/images/aws-combined-direct.png new file mode 100644 index 00000000000..3b8c2f0b3a6 Binary files /dev/null and b/guides/common/images/aws-combined-direct.png differ diff --git a/guides/common/images/aws-combined-vpn-orcharhino.svg b/guides/common/images/aws-combined-vpn-orcharhino.svg new file mode 100644 index 00000000000..9c9218b7e7e --- /dev/null +++ b/guides/common/images/aws-combined-vpn-orcharhino.svg @@ -0,0 +1,3 @@ + + +
Amazon Web Services
Internet Gateway
Internet
VPC
Base system
orcharhino Proxy Server
Client instances
Availability zone
VPN Gateway
VPN   
connection   
VPN Gateway
On-premise data center
orcharhino Server
 diff --git a/guides/common/images/aws-combined-vpn-satellite.png b/guides/common/images/aws-combined-vpn-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-combined-vpn.png b/guides/common/images/aws-combined-vpn.png new file mode 100644 index 00000000000..3579563b968 Binary files /dev/null and b/guides/common/images/aws-combined-vpn.png differ diff --git a/guides/common/images/aws-multi-region-direct-orcharhino.svg b/guides/common/images/aws-multi-region-direct-orcharhino.svg new file mode 100644 index 00000000000..14907042737 --- /dev/null +++ b/guides/common/images/aws-multi-region-direct-orcharhino.svg @@ -0,0 +1,3 @@ + + +
Amazon Web Services
VPC
Base system
orcharhino Server
Client instances
Availability zone
Internet Gateway
Elastic IP
VPC
Base system
orcharhino Server
Client instances
Availability zone
Internet Gateway
Elastic IP
Internet
 \ No newline at end of file diff --git a/guides/common/images/aws-multi-region-direct-satellite.png b/guides/common/images/aws-multi-region-direct-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-multi-region-direct.png b/guides/common/images/aws-multi-region-direct.png new file mode 100644 index 00000000000..e49cad76037 Binary files /dev/null and b/guides/common/images/aws-multi-region-direct.png differ diff --git a/guides/common/images/aws-multi-region-vpn-orcharhino.svg b/guides/common/images/aws-multi-region-vpn-orcharhino.svg new file mode 100644 index 00000000000..6aff41160ea --- /dev/null +++ b/guides/common/images/aws-multi-region-vpn-orcharhino.svg @@ -0,0 +1,3 @@ + + +
Amazon Web Services
VPC
Base system
orcharhino Server
Client instances
Availability zone
Internet Gateway
Elastic IP
VPC
Base system
orcharhino Proxy Server
Client instances
Availability zone
Internet Gateway
Elastic IP
VPN   
connection   
VPN instance
VPN instance
 \ No newline at end of file diff --git a/guides/common/images/aws-multi-region-vpn-satellite.png b/guides/common/images/aws-multi-region-vpn-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-multi-region-vpn.png b/guides/common/images/aws-multi-region-vpn.png new file mode 100644 index 00000000000..a63ab38d50c Binary files /dev/null and b/guides/common/images/aws-multi-region-vpn.png differ diff --git a/guides/common/images/aws-one-region-setup-orcharhino.svg b/guides/common/images/aws-one-region-setup-orcharhino.svg new file mode 100644 index 00000000000..9a204c4826d --- /dev/null +++ b/guides/common/images/aws-one-region-setup-orcharhino.svg @@ -0,0 +1,3 @@ + + +
Amazon Web Services
Internet Gateway
Internet
VPC
Base system
orcharhino Server
Client instances
Availability zone
 \ No newline at end of file diff --git a/guides/common/images/aws-one-region-setup.png b/guides/common/images/aws-one-region-setup.png new file mode 100644 index 00000000000..76c72383dab Binary files /dev/null and b/guides/common/images/aws-one-region-setup.png differ diff --git a/guides/common/images/aws-single-region-satellite.png b/guides/common/images/aws-single-region-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/modules/con_deploying-foreman-on-aws.adoc b/guides/common/modules/con_deploying-foreman-on-aws.adoc new file mode 100644 index 00000000000..fc2053e552d --- /dev/null +++ b/guides/common/modules/con_deploying-foreman-on-aws.adoc @@ -0,0 +1,5 @@ +[id="deploying-{project-context}-on-aws"] += Deploying {Project} on AWS + +You can run {ProjectServer}, {SmartProxyServers}, and hosts on your Amazon Web Services (AWS) environment. +If you want to provision cloud instances on Amazon EC2, see {ProvisioningDocURL}#Provisioning_Cloud_Instances_in_Amazon_EC2_ec2-provisioning[Provisioning cloud instances in Amazon EC2] in _{ProvisioningDocTitle}_. diff --git a/guides/common/modules/con_deployment-scenarios.adoc b/guides/common/modules/con_deployment-scenarios.adoc deleted file mode 100644 index adbbf309c6f..00000000000 --- a/guides/common/modules/con_deployment-scenarios.adoc +++ /dev/null @@ -1,54 +0,0 @@ -[[Deployment_Scenarios]] -= Deployment Scenarios - -There are three deployment scenarios for {ProjectName} in Amazon Web Services: - -* One-region setup -* Connecting on-premises and AWS region -* Connecting different regions - -ifndef::satellite[] -include::snip_red-hat-images.adoc[] -endif::[] - -.Scenario 1: One-region setup - -image::common/aws-single-region-satellite.png[One-region setup] - -The least complex configuration of {ProjectServer} in Amazon Web Services consists of both {ProjectServer} and the content hosts residing within the same region and within the Virtual Private Cloud (VPC). - -You can also use a different availability zone. - -.Scenario 2: Connecting on-premises and AWS region - -Create a VPN connection between the on-premises location and the AWS region where the {SmartProxy} is located. - -It is also possible to use the external host name of {ProjectServer} when you register the instance that runs {SmartProxyServer}. - -*Option 1: Site-to-site VPN connection between the AWS region and the on-premises datacenter* - -image::common/aws-combined-vpn-satellite.png[Site-to-site VPN connection between the AWS region and the on-premises datacenter] - -*Option 2: Direct connection using the external DNS host name* - -image::common/aws-combined-direct-satellite.png[Direct connection using the external DNS host name] - -.Scenario 3: Connecting different regions - -Create a site-to-site VPN connection between different regions so that you can use the internal DNS host name when you register the instance that runs {SmartProxyServer} to {ProjectServer}. - -If you do not establish a site-to-site VPN connection, use the external DNS host name when you register the instance that runs {SmartProxyServer} to {ProjectServer}. - -[NOTE] -==== -Most public cloud providers do not charge for data being transferred into a region or between availability zones within a single region. -However, they do charge for data leaving the region to the Internet. -==== - -*Option 1: Site-to-site VPN connection between AWS regions* - -image::common/aws-multi-region-vpn-satellite.png[Site-to-site VPN connection between AWS regions] - -*Option 2: Direct connection using the external DNS host name* - -image::common/aws-multi-region-direct-satellite.png[Direct connection using the external DNS host name] diff --git a/guides/common/modules/con_foreman-on-aws-assumptions.adoc b/guides/common/modules/con_foreman-on-aws-assumptions.adoc deleted file mode 100644 index 9365908759e..00000000000 --- a/guides/common/modules/con_foreman-on-aws-assumptions.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= Amazon Web Service Assumptions - -To use this guide, you must have a working knowledge of the following aspects of Amazon Web Services: - -* Creating and accessing {RHEL} images in AWS -* Editing network access in AWS Security -* Creating EC2 instances and how to create EBS volumes -* Launching instances -* Importing and exporting virtual machines in AWS -* Using AWS Direct Connect - -To install {Project} in an AWS environment, you must ensure that your AWS set up meets the {InstallingServerDocURL}system-requirements_{project-context}[System Requirements] in _{InstallingServerDocTitle}_. - -To install {SmartProxy} in an AWS environment, you must ensure that your AWS set up meets the {InstallingSmartProxyDocURL}system-requirements_{smart-proxy-context}[System Requirements] in _{InstallingSmartProxyDocTitle}_. - -For more information about Amazon Web Services and terminology, see https://aws.amazon.com/documentation/ec2/[Amazon Elastic Compute Cloud Documentation]. - -For more information about Amazon Web Services Direct Connect, see https://docs.aws.amazon.com/directconnect/latest/UserGuide/Welcome.html[What is AWS Direct Connect?] diff --git a/guides/common/modules/con_foreman-on-aws-prerequisites-for-foreman-server.adoc b/guides/common/modules/con_foreman-on-aws-prerequisites-for-foreman-server.adoc deleted file mode 100644 index ca68bb6448e..00000000000 --- a/guides/common/modules/con_foreman-on-aws-prerequisites-for-foreman-server.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= {ProjectName}-specific prerequisites - -* Ensure that the Amazon EC2 instance type meets or exceeds the {InstallingServerDocURL}system-requirements_{project-context}[System Requirements] in _{InstallingServerDocTitle}_. -For the best performance, use an https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/storage-optimized-instances.html[AWS storage optimized instance]. -ifndef::foreman-deb[] -* Use {InstallingServerDocURL}satellite-storage-requirements_{project-context}[Storage Requirements] in _{InstallingServerDocTitle}_ to understand and assign the correct storage to your AWS EBS volumes. -* Store the synced content on an EBS volume that is separate to the boot volume. -* Mount the synced content EBS volume separately in the operating system. -* Optional: Store other data on a separate EBS volume. -endif::[] -* If you want {ProjectServer} and {SmartProxyServer} to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance. diff --git a/guides/common/modules/con_foreman-on-aws-prerequisites.adoc b/guides/common/modules/con_foreman-on-aws-prerequisites.adoc deleted file mode 100644 index 8c02669c25c..00000000000 --- a/guides/common/modules/con_foreman-on-aws-prerequisites.adoc +++ /dev/null @@ -1,4 +0,0 @@ -[[Prerequisites]] -= Prerequisites - -Before you can install and register {ProjectName} and {SmartProxy}, you must set up accounts with Amazon Web Services (AWS) and create and start {RHEL} instances on AWS. diff --git a/guides/common/modules/con_foreman-on-aws-registering-hosts.adoc b/guides/common/modules/con_foreman-on-aws-registering-hosts.adoc deleted file mode 100644 index 482b6f95646..00000000000 --- a/guides/common/modules/con_foreman-on-aws-registering-hosts.adoc +++ /dev/null @@ -1,5 +0,0 @@ -[[aws-registering-hosts]] -= Registering Hosts to {Project} - -When you install {ProjectServer} and {SmartProxyServer}, you must then register the hosts on EC2 instances to {Project}. -For more information, see {ManagingHostsDocURL}Registering_Hosts_managing-hosts[Registering Hosts] in _{ManagingHostsDocTitle}_. diff --git a/guides/common/modules/con_foreman-on-aws-rh-cloud-prerequisites.adoc b/guides/common/modules/con_foreman-on-aws-rh-cloud-prerequisites.adoc deleted file mode 100644 index 59cf6d5443d..00000000000 --- a/guides/common/modules/con_foreman-on-aws-rh-cloud-prerequisites.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= Red Hat Cloud prerequisites - -To use this guide, you must complete the following steps: - -* Register with Red Hat Cloud Access. -* Migrate any Red Hat subscriptions that you want to use. -* Create an AWS instance and deploy a {RHEL} virtual machine to the instance. -* Ensure that your subscriptions are eligible for transfer to Red Hat Cloud. -For more information, see https://www.redhat.com/en/technologies/cloud-computing/cloud-access#program-details[Red Hat Cloud Access Program Details]. - -For more information about deploying {RHEL} in AWS, see https://access.redhat.com/articles/2962171[How to Locate Red Hat Cloud Access Gold Images on AWS EC2]. diff --git a/guides/common/modules/con_foreman-on-aws-use-case-considerations.adoc b/guides/common/modules/con_foreman-on-aws-use-case-considerations.adoc deleted file mode 100644 index 476721f14a1..00000000000 --- a/guides/common/modules/con_foreman-on-aws-use-case-considerations.adoc +++ /dev/null @@ -1,5 +0,0 @@ -[[Use_Case_Considerations]] -= Use Case Considerations - -Because Amazon Web Services is an image-only service, there are common {Project} use cases that do not work, or require extra configuration in an Amazon Web Service environment. -If you plan to use {Project} on AWS, ensure that the use case scenarios that you want to use are available in an AWS environment. diff --git a/guides/common/modules/con_installing-foreman-server-on-aws.adoc b/guides/common/modules/con_installing-foreman-server-on-aws.adoc deleted file mode 100644 index ca78598503d..00000000000 --- a/guides/common/modules/con_installing-foreman-server-on-aws.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[[Installing_Satellite_on_AWS]] -= Installing {ProjectServer} on AWS - -On your AWS environment, complete the following steps: - -. Connect to the new instance. -. Use {InstallingServerDocURL}index[{InstallingServerDocTitle}] to install {ProjectServer}. diff --git a/guides/common/modules/con_installing-smart-proxy-server-on-aws.adoc b/guides/common/modules/con_installing-smart-proxy-server-on-aws.adoc deleted file mode 100644 index e930602d99f..00000000000 --- a/guides/common/modules/con_installing-smart-proxy-server-on-aws.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[[Installing_Capsule_on_AWS]] -= Installing {SmartProxy} on AWS - -On your AWS environment, complete the following steps: - -. Connect to the new instance. -. Install {SmartProxyServer}. -For more information, see {InstallingSmartProxyDocURL}[{InstallingSmartProxyDocTitle}]. diff --git a/guides/common/modules/con_prerequisites-for-foreman-on-aws.adoc b/guides/common/modules/con_prerequisites-for-foreman-on-aws.adoc new file mode 100644 index 00000000000..2b64272350c --- /dev/null +++ b/guides/common/modules/con_prerequisites-for-foreman-on-aws.adoc @@ -0,0 +1,40 @@ +[id="prerequisites-for-{project-context}-on-aws"] += Prerequisites for {Project} on AWS + +Installing and running {ProjectServer} and {SmartProxyServers} on Amazon Web Services (AWS) has additional requirements to your environment. + +* Ensure that the Amazon EC2 instance type meets or exceeds the {InstallingServerDocURL}system-requirements_{project-context}[System requirements] in _{InstallingServerDocTitle}_. +For the best performance, use an https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/storage-optimized-instances.html[AWS storage optimized instance]. +ifndef::foreman-deb[] +* Use {InstallingServerDocURL}satellite-storage-requirements_{project-context}[Storage requirements] in _{InstallingServerDocTitle}_ to understand and assign the correct storage to your AWS EBS volumes. +* Store content on an EBS volume that is separate to the boot volume. +* Mount your content EBS volume separately in the operating system. +* Optional: Store other data on a separate EBS volume. +endif::[] +* If you want {ProjectServer} and {SmartProxyServer} to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance. + +.Amazon Web Service requirements +* Creating and accessing {EL} images in AWS +* Editing network access in AWS Security +* Creating EC2 instances and EBS volumes +* Launching EC2 instances +* Importing and exporting virtual machines in AWS +* Using AWS Direct Connect + +.System requirements +* To install {ProjectServer} in your AWS environment, ensure that it meets {ProjectServer} system requirements. +For more information, see {InstallingServerDocURL}system-requirements_{project-context}[System requirements] in _{InstallingServerDocTitle}_. +* To install {SmartProxyServer} in your AWS environment, ensure that it meets {SmartProxyServer} system requirements. +For more information, see {InstallingSmartProxyDocURL}system-requirements_{smart-proxy-context}[System requirements] in _{InstallingSmartProxyDocTitle}_. +* For more information about Amazon Web Services and terminology, see https://docs.aws.amazon.com/ec2/[Amazon Elastic Compute Cloud Documentation]. +* For more information about Amazon Web Services Direct Connect, see https://docs.aws.amazon.com/directconnect/latest/UserGuide/Welcome.html[What is AWS Direct Connect?]. + +ifdef::satellite[] +.Red Hat Cloud prerequisites +* Register with Red Hat Cloud Access. +* Migrate any Red Hat subscriptions that you want to use. +* Create an AWS instance and deploy a {RHEL} virtual machine to the instance. +For more information about deploying {RHEL} in AWS, see https://access.redhat.com/articles/2962171[How to Locate Red Hat Cloud Access Gold Images on AWS EC2]. +* Ensure that your subscriptions are eligible for transfer to Red Hat Cloud. +For more information, see https://www.redhat.com/en/technologies/cloud-computing/cloud-access#program-details[Red Hat Cloud Access Program Details]. +endif::[] diff --git a/guides/common/modules/con_scenarios-for-foreman-on-aws.adoc b/guides/common/modules/con_scenarios-for-foreman-on-aws.adoc new file mode 100644 index 00000000000..62e401c5d68 --- /dev/null +++ b/guides/common/modules/con_scenarios-for-foreman-on-aws.adoc @@ -0,0 +1,84 @@ +[id="scenarios-for-{project-context}-on-aws"] += Scenarios for {Project} on AWS + +There are several deployment scenarios for {Project} on Amazon Web Services (AWS): + +* One-region setup +* Connecting on-premises and AWS region +* Connecting different regions + +.Scenario 1: One-region setup +ifdef::foreman-el,foreman-deb,katello[] +image::common/aws-one-region-setup.png[One-region setup] +endif::[] +ifdef::satellite[] +image::common/aws-one-region-setup-satellite.png[One-region setup] +endif::[] +ifdef::orcharhino[] +image::common/aws-one-region-setup-orcharhino.svg[One-region setup] +endif::[] + +The least complex configuration of {ProjectServer} in AWS consists of both {ProjectServer} and the hosts residing within the same region and within the Virtual Private Cloud (VPC). +You can also use a different availability zone. + +.Scenario 2: Connecting on-premises and AWS region +Create a VPN connection between the on-premises location and the AWS region where your {SmartProxyServer} is located. +It is also possible to use the external host name of {ProjectServer} when you register the instance that runs {SmartProxy}. + +*Option 1: Site-to-site VPN connection between the AWS region and the on-premises data center* + +ifdef::foreman-el,foreman-deb,katello[] +image::common/aws-combined-vpn.png[Site-to-site VPN connection between the AWS region and the on-premises data center] +endif::[] +ifdef::satellite[] +image::common/aws-combined-vpn-satellite.png[Site-to-site VPN connection between the AWS region and the on-premises data center] +endif::[] +ifdef::orcharhino[] +image::common/aws-combined-vpn-orcharhino.svg[Site-to-site VPN connection between the AWS region and the on-premises data center] +endif::[] + +*Option 2: Direct connection using the external DNS host name* + +ifdef::foreman-el,foreman-deb,katello[] +image::common/aws-combined-direct.png[Direct connection using the external DNS host name] +endif::[] +ifdef::satellite[] +image::common/aws-combined-direct-satellite.png[Direct connection using the external DNS host name] +endif::[] +ifdef::orcharhino[] +image::common/aws-combined-direct-orcharhino.svg[Direct connection using the external DNS host name] +endif::[] + +.Scenario 3: Connecting different regions +Create a site-to-site VPN connection between different regions so that you can use the internal DNS host name when you register the instance that runs {SmartProxy} to {ProjectServer}. +If you do not establish a site-to-site VPN connection, use the external DNS host name when you register the instance that runs {SmartProxy} to {ProjectServer}. + +[NOTE] +==== +Most public cloud providers do not charge for data being transferred into a region or between availability zones within a single region. +However, they do charge for data leaving the region to the Internet. +==== + +*Option 1: Site-to-site VPN connection between AWS regions* + +ifdef::foreman-el,foreman-deb,katello[] +image::common/aws-multi-region-vpn.png[Site-to-site VPN connection between AWS regions] +endif::[] +ifdef::satellite[] +image::common/aws-multi-region-vpn-satellite.png[Site-to-site VPN connection between AWS regions] +endif::[] +ifdef::orcharhino[] +image::common/aws-multi-region-vpn-orcharhino.svg[Site-to-site VPN connection between AWS regions] +endif::[] + +*Option 2: Direct connection using the external DNS host name* + +ifdef::foreman-el,foreman-deb,katello[] +image::common/aws-multi-region-direct.png[Direct connection using the external DNS host name] +endif::[] +ifdef::satellite[] +image::common/aws-multi-region-direct-satellite.png[Direct connection using the external DNS host name] +endif::[] +ifdef::orcharhino[] +image::common/aws-multi-region-direct-orcharhino.svg[Direct connection using the external DNS host name] +endif::[] diff --git a/guides/common/modules/con_supported-use-cases-for-deploying-foreman-on-aws.adoc b/guides/common/modules/con_supported-use-cases-for-deploying-foreman-on-aws.adoc deleted file mode 100644 index eaf1605459c..00000000000 --- a/guides/common/modules/con_supported-use-cases-for-deploying-foreman-on-aws.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= Use Cases Known to Work - -You can perform the following {ProjectName} use cases on AWS: - -ifdef::katello,orcharhino,satellite[] -* {ContentManagementDocURL}Managing_Red_Hat_Subscriptions_content-management[Managing Red Hat Subscriptions] -* {ContentManagementDocURL}Importing_Content_content-management[Importing Content] -* {ContentManagementDocURL}Managing_Errata[Managing Errata] -* {ManagingHostsDocURL}Registering_a_Host_Manually_managing-hosts[Registering a Host Manually] -endif::[] -ifdef::satellite[] -* https://access.redhat.com/products/red-hat-insights/#satellite6[Red Hat Insights] -endif::[] -* {AdministeringDocURL}Using_FreeIPA_admin[Realm Integration via IdM] -ifndef::foreman-deb[] -* {AdministeringDocURL}Managing_Security_Compliance_admin[OpenSCAP] -endif::[] -* {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote_Jobs_managing-hosts[Remote Execution] - -ifndef::foreman-deb[] -.Subscriptions - -Not all Red Hat subscriptions are eligible to run in public cloud environments. -For more information about subscription eligibility, see the https://www.redhat.com/en/technologies/cloud-computing/cloud-access#program-details[Red Hat Cloud Access Page]. -You can create additional organizations and then import additional manifests to the organizations. -ifdef::satellite[] -For more information, see {AdministeringDocURL}Creating_an_Organization_admin[Creating an Organization] in _{AdministeringDocTitle}_. -endif::[] -ifndef::satellite[] -For more information, see {ManagingOrganizationsLocationsDocURL}Managing_Organizations_managing-organizations-locations[Managing Organizations] in _{ManagingOrganizationsLocationsDocTitle}_. -endif::[] -endif::[] - -.Multi-homed {Project} and {SmartProxy} - -ifdef::satellite[] -Multi-homed {Project} is not supported. - -Multi-homed {SmartProxy} is supported, to implement this, you can configure {SmartProxies} with a load balancer. -For more information, see {ConfiguringLoadBalancerDocURL}[Configuring {SmartProxies} with a Load Balancer]. -endif::[] - -ifndef::satellite[] -One way to use multi-homed {SmartProxies} is by configuring {SmartProxies} with a load balancer. -For more information, see {ConfiguringLoadBalancerDocURL}[Configuring {SmartProxies} with a Load Balancer]. -endif::[] - -You must do this when {ProjectServer} or {SmartProxyServer} has different internal and external DNS host names and there is no site-to-site VPN connection between the locations where you deploy {ProjectServer} and {SmartProxyServer}. - -ifdef::katello,orcharhino,satellite[] -.On demand content sources -You can use the *On demand* download policy to reduce the storage footprint of the server that runs {Project}. -When you set the download policy to *On Demand*, content syncs to {ProjectServer} or {SmartProxyServer} when a content host requests it. - -For more information, see {ContentManagementDocURL}Importing_Content_content-management[Importing Content] in _{ContentManagementDocTitle}_. -endif::[] diff --git a/guides/common/modules/con_supported-use-cases-for-foreman-on-aws.adoc b/guides/common/modules/con_supported-use-cases-for-foreman-on-aws.adoc new file mode 100644 index 00000000000..aff7c544dc5 --- /dev/null +++ b/guides/common/modules/con_supported-use-cases-for-foreman-on-aws.adoc @@ -0,0 +1,42 @@ +[id="supported-use-cases-for-{project-context}-on-aws"] += Supported use cases for {Project} on AWS + +You can perform the following {Project} use cases on Amazon Web Services (AWS): + +ifdef::katello,orcharhino,satellite[] +* {ContentManagementDocURL}Managing_Red_Hat_Subscriptions_content-management[Managing Red Hat subscriptions] +* {ContentManagementDocURL}Importing_Content_content-management[Importing content] +* {ContentManagementDocURL}Managing_Errata_content-management[Managing errata] +endif::[] +* {ManagingHostsDocURL}registering-hosts-and-setting-up-host-integration_managing-hosts[Registering hosts and setting up host integration] +* {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote_Jobs_managing-hosts[Configuring and setting up remote jobs] +ifdef::satellite[] +* {ManagingHostsDocURL}monitoring-hosts-by-using-red-hat-insights[Monitoring hosts by using Red Hat Insights] +endif::[] +* {ConfiguringUserAuthenticationDocURL}[{ConfiguringUserAuthenticationDocTitle}] +ifndef::foreman-deb[] +* {ManagingSecurityDocURL}[{ManagingSecurityDocTitle}] +endif::[] + +ifdef::satellite[] +.Subscriptions +Not all Red Hat subscriptions are eligible to run in public cloud environments. +For more information about subscription eligibility, see https://www.redhat.com/en/technologies/cloud-computing/cloud-access[Red Hat Cloud Access]. +For more information about Red Hat manifests, see {ContentManagementDocURL}Managing_Red_Hat_Subscriptions_content-management[Managing Red Hat subscriptions] in _{ContentManagementDocTitle}_. +endif::[] + +.Multi-homed {Project} and {SmartProxy} +Multi-homed {ProjectServer} is not supported. + +Multi-homed {SmartProxyServers} are supported by configuring {SmartProxies} with a load balancer. +For more information, see {ConfiguringLoadBalancerDocURL}[Configuring {SmartProxies} with a Load Balancer]. + +You must do this when {ProjectServer} or {SmartProxyServer} has different internal and external DNS host names and there is no site-to-site VPN connection between the locations where you deploy {ProjectServer} and {SmartProxyServer}. + +ifdef::katello,orcharhino,satellite[] +.On demand content sources +You can use the *On demand* download policy to reduce the storage footprint of your {ProjectServer}. +When you set the download policy to *On Demand*, content is synchronized to {ProjectServer} or {SmartProxyServer} when a content host requests it. + +For more information, see {ContentManagementDocURL}Download_Policies_Overview_content-management[Download policies overview] in _{ContentManagementDocTitle}_. +endif::[] diff --git a/guides/common/modules/con_unsupported-use-cases-for-deploying-foreman-on-aws.adoc b/guides/common/modules/con_unsupported-use-cases-for-deploying-foreman-on-aws.adoc deleted file mode 100644 index 95329588539..00000000000 --- a/guides/common/modules/con_unsupported-use-cases-for-deploying-foreman-on-aws.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Use Cases that Do Not Work - -In AWS, you cannot manage the DHCP. -Because of this, most of Kickstart and PXE provisioning models of {ProjectServer} are unusable. -This includes: - -* PXE Provisioning -* Discovery and Discovery Rules -* ISO Provisioning methods. -** PXE-Less Discovery (iPXE) -** Per-host ISO -** Generic ISO -** Full-host ISO diff --git a/guides/common/modules/con_unsupported-use-cases-for-foreman-on-aws.adoc b/guides/common/modules/con_unsupported-use-cases-for-foreman-on-aws.adoc new file mode 100644 index 00000000000..c1dc1877bb2 --- /dev/null +++ b/guides/common/modules/con_unsupported-use-cases-for-foreman-on-aws.adoc @@ -0,0 +1,14 @@ +[id="unsupported-use-cases-for-{project-context}-on-aws"] += Unsupported use cases for {Project} on AWS + +In Amazon Web Services (AWS), you cannot manage the DHCP service. +Because of this, most of Kickstart and PXE provisioning models of {Project} are unusable. +This includes: + +* PXE Provisioning +* Discovery and Discovery Rules +* ISO Provisioning methods +** PXE-Less Discovery (iPXE) +** Per-host ISO +** Generic ISO +** Full-host ISO diff --git a/guides/common/modules/con_use-case-considerations-for-foreman-on-aws.adoc b/guides/common/modules/con_use-case-considerations-for-foreman-on-aws.adoc new file mode 100644 index 00000000000..0ff1e50ecaf --- /dev/null +++ b/guides/common/modules/con_use-case-considerations-for-foreman-on-aws.adoc @@ -0,0 +1,5 @@ +[id="use-case-considerations-for-{project-context}-on-aws"] += Use case considerations for {Project} on AWS + +Amazon Web Services (AWS) is an image-only compute resource which means that there are common {Project} use cases that do not work or require extra configuration in your AWS environment. +If you plan to deploy {Project} to AWS, ensure that the use case scenarios that you want to use are available in your AWS environment. diff --git a/guides/common/modules/proc_installing-foreman-server-on-aws.adoc b/guides/common/modules/proc_installing-foreman-server-on-aws.adoc new file mode 100644 index 00000000000..d96f7c87715 --- /dev/null +++ b/guides/common/modules/proc_installing-foreman-server-on-aws.adoc @@ -0,0 +1,22 @@ +[id="installing-{project-context}-server-on-aws"] += Installing {ProjectServer} on AWS + +You can install {ProjectServer} on your AWS environment. + +.Procedure +. Launch an EC2 instance running {EL} AMI. +. Connect to the newly created instance. +. If you use a Red Hat Gold Image, remove the RHUI client and set the `enabled` parameter in the `product-id.conf` to `1`: ++ +[options="nowrap" subs="+quotes,attributes"] +----- +# {client-package-remove-el8} -y rh-amazon-rhui-client* +# dnf clean all + +# cat << EOF > /etc/yum/pluginconf.d/product-id.conf +[main] +enabled=1 +EOF +----- +. Install {ProjectServer}. +For more information, see {InstallingServerDocURL}[{InstallingServerDocTitle}]. diff --git a/guides/common/modules/proc_installing-smart-proxy-server-on-aws.adoc b/guides/common/modules/proc_installing-smart-proxy-server-on-aws.adoc new file mode 100644 index 00000000000..a6db339a484 --- /dev/null +++ b/guides/common/modules/proc_installing-smart-proxy-server-on-aws.adoc @@ -0,0 +1,9 @@ +[id="installing-{smart-proxy-context}-server-on-aws"] += Installing {SmartProxyServer} on AWS + +You can install {SmartProxyServer} on your AWS environment. + +.Procedure +. Connect to your new EC2 instance. +. Install {SmartProxyServer}. +For more information, see {InstallingSmartProxyDocURL}[{InstallingSmartProxyDocTitle}]. diff --git a/guides/common/modules/proc_preparing-foreman-server-on-aws.adoc b/guides/common/modules/proc_preparing-foreman-server-on-aws.adoc deleted file mode 100644 index b26b2c188d0..00000000000 --- a/guides/common/modules/proc_preparing-foreman-server-on-aws.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Preparing for the {ProjectName} Installation - -In your AWS environment, complete the following steps: - -. Launch an EC2 instance of a {RHEL} AMI. -. Connect to the newly created instance. -. If you use a Red Hat Gold Image, remove the RHUI client and set the `enabled` parameter in the `product-id.conf` to `1`. -+ -[options="nowrap" subs="+quotes,attributes"] ------ -# {client-package-remove-el8} -y rh-amazon-rhui-client* -# dnf clean all -# cat << EOF > /etc/yum/pluginconf.d/product-id.conf -> [main] -> enabled=1 -> EOF ------ diff --git a/guides/common/modules/proc_registering-hosts-on-aws-to-foreman.adoc b/guides/common/modules/proc_registering-hosts-on-aws-to-foreman.adoc new file mode 100644 index 00000000000..60fb9152718 --- /dev/null +++ b/guides/common/modules/proc_registering-hosts-on-aws-to-foreman.adoc @@ -0,0 +1,8 @@ +[id="registering-hosts-on-aws-to-{project-context}"] += Registering hosts on AWS to {Project} + +When you install {ProjectServer} and {SmartProxyServer}, you must then register the hosts on EC2 instances to {Project}. + +.Procedure +* Register your hosts to {Project}. +For more information, see {ManagingHostsDocURL}registering-hosts-and-setting-up-host-integration_managing-hosts[Registering hosts and setting up host integration] in _{ManagingHostsDocTitle}_. diff --git a/guides/doc-Deploying_Project_on_AWS/master.adoc b/guides/doc-Deploying_Project_on_AWS/master.adoc index 665ca3456b2..8df0383d1ec 100644 --- a/guides/doc-Deploying_Project_on_AWS/master.adoc +++ b/guides/doc-Deploying_Project_on_AWS/master.adoc @@ -15,31 +15,21 @@ ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] endif::[] -include::common/modules/con_foreman-on-aws-use-case-considerations.adoc[leveloffset=+1] +include::common/modules/con_scenarios-for-foreman-on-aws.adoc[leveloffset=+1] -include::common/modules/con_supported-use-cases-for-deploying-foreman-on-aws.adoc[leveloffset=+2] +include::common/modules/con_use-case-considerations-for-foreman-on-aws.adoc[leveloffset=+1] -include::common/modules/con_unsupported-use-cases-for-deploying-foreman-on-aws.adoc[leveloffset=+2] +include::common/modules/con_supported-use-cases-for-foreman-on-aws.adoc[leveloffset=+2] -include::common/modules/con_deployment-scenarios.adoc[leveloffset=+1] +include::common/modules/con_unsupported-use-cases-for-foreman-on-aws.adoc[leveloffset=+2] -include::common/modules/con_foreman-on-aws-prerequisites.adoc[leveloffset=+1] +include::common/modules/con_prerequisites-for-foreman-on-aws.adoc[leveloffset=+1] -include::common/modules/con_foreman-on-aws-assumptions.adoc[leveloffset=+2] +include::common/modules/con_deploying-foreman-on-aws.adoc[leveloffset=+1] -ifndef::foreman-deb[] -include::common/modules/con_foreman-on-aws-rh-cloud-prerequisites.adoc[leveloffset=+2] -endif::[] - -include::common/modules/con_foreman-on-aws-prerequisites-for-foreman-server.adoc[leveloffset=+2] - -ifndef::foreman-deb[] -include::common/modules/proc_preparing-foreman-server-on-aws.adoc[leveloffset=+2] -endif::[] - -include::common/modules/con_installing-foreman-server-on-aws.adoc[leveloffset=+1] +include::common/modules/proc_installing-foreman-server-on-aws.adoc[leveloffset=+2] -include::common/modules/con_installing-smart-proxy-server-on-aws.adoc[leveloffset=+1] +include::common/modules/proc_installing-smart-proxy-server-on-aws.adoc[leveloffset=+2] -include::common/modules/con_foreman-on-aws-registering-hosts.adoc[leveloffset=+1] +include::common/modules/proc_registering-hosts-on-aws-to-foreman.adoc[leveloffset=+2] endif::[] diff --git a/guides/image-sources/foreman-on-aws.drawio b/guides/image-sources/foreman-on-aws.drawio new file mode 100644 index 00000000000..b22b9fc22e1 --- /dev/null +++ b/guides/image-sources/foreman-on-aws.drawio @@ -0,0 +1,488 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +