-
Notifications
You must be signed in to change notification settings - Fork 95
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix headings and anchors for Foreman on AWS
$ cat guides/doc-Deploying_Project_on_AWS/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg modules | sort -u $ chmod -x guides/common/images/aws-combined-direct-satellite.png $ chmod -x guides/common/images/aws-combined-vpn-satellite.png $ chmod -x guides/common/images/aws-multi-region-direct-satellite.png $ chmod -x guides/common/images/aws-multi-region-vpn-satellite.png $ chmod -x guides/common/images/aws-single-region-satellite.png
- Loading branch information
1 parent
9a75901
commit 6beeb99
Showing
38 changed files
with
741 additions
and
228 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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}_. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
guides/common/modules/con_foreman-on-aws-prerequisites-for-foreman-server.adoc
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
5 changes: 0 additions & 5 deletions
5
guides/common/modules/con_foreman-on-aws-registering-hosts.adoc
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
guides/common/modules/con_foreman-on-aws-rh-cloud-prerequisites.adoc
This file was deleted.
Oops, something went wrong.
5 changes: 0 additions & 5 deletions
5
guides/common/modules/con_foreman-on-aws-use-case-considerations.adoc
This file was deleted.
Oops, something went wrong.
7 changes: 0 additions & 7 deletions
7
guides/common/modules/con_installing-foreman-server-on-aws.adoc
This file was deleted.
Oops, something went wrong.
8 changes: 0 additions & 8 deletions
8
guides/common/modules/con_installing-smart-proxy-server-on-aws.adoc
This file was deleted.
Oops, something went wrong.
40 changes: 40 additions & 0 deletions
40
guides/common/modules/con_prerequisites-for-foreman-on-aws.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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::[] |
84 changes: 84 additions & 0 deletions
84
guides/common/modules/con_scenarios-for-foreman-on-aws.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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::[] |
56 changes: 0 additions & 56 deletions
56
guides/common/modules/con_supported-use-cases-for-deploying-foreman-on-aws.adoc
This file was deleted.
Oops, something went wrong.
42 changes: 42 additions & 0 deletions
42
guides/common/modules/con_supported-use-cases-for-foreman-on-aws.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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::[] |
13 changes: 0 additions & 13 deletions
13
guides/common/modules/con_unsupported-use-cases-for-deploying-foreman-on-aws.adoc
This file was deleted.
Oops, something went wrong.
14 changes: 14 additions & 0 deletions
14
guides/common/modules/con_unsupported-use-cases-for-foreman-on-aws.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Oops, something went wrong.