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.

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

Improve "Foreman on AWS" guide #3485

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

Conversation

maximiliankolb
Copy link
Contributor

@maximiliankolb maximiliankolb commented Dec 3, 2024

what

follow up to #3469

why

additional info

-> There will be a third PR after 3485 and 3456 to make this happen.

cherry-picks

to 3.13 and up only

Copy link

github-actions bot commented Dec 3, 2024

The PR preview for b53a90a is available at theforeman-foreman-documentation-preview-pr-3485.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

As mentioned on Matrix, some of my thoughts on what I'd like to see with this guide in the long term.

Once we drop the postgresql-evr package, we can use a plain PostgreSQL server. Right now we're aiming for Foreman 3.14 for that. For users it means they can use a managed database like Amazon RDS. It will probably be some special flavor of external database support where we point to https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ConnectToPostgreSQLInstance.html (or similar) to obtain the right values and reuse the existing modules.

I should check within Red Hat what the preference is, but it would make sense to me to default to it.

Of course, we first need to actually release the feature in 3.14.

@@ -1,12 +1,13 @@
= Use Cases that Do Not Work
[id="unsupported-use-cases-for-{project-context}-on-aws"]
= Unsupported use cases for {Project} on AWS

In AWS, you cannot manage the DHCP.
Copy link
Member

Choose a reason for hiding this comment

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

Note that if you add a Smart Proxy using a Smart Proxy in our on-premise data center (see Scenario 2: Connecting on-premises and AWS region) then you can use these methods.

This is a long standing issue I have with this guide.

[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 Amazon Web Service environment.
Copy link
Member

Choose a reason for hiding this comment

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

Is this really relevant? You can simply take a bare OS image and then manage it as a normal OS in EC2.

@maximiliankolb maximiliankolb force-pushed the improve_foreman_on_aws branch 2 times, most recently from e5e34a1 to a72da79 Compare December 6, 2024 15:10
@asteflova asteflova mentioned this pull request Dec 9, 2024
9 tasks
$ 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
@maximiliankolb maximiliankolb marked this pull request as ready for review December 9, 2024 14:53
= 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}_.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have explicitely added line 5 because I feel like the whole guide does not differentiate enough between "AWS as platform for Foreman/Katello" and "EC2 as compute resources". It often implies that if you run Foreman+Katello on AWS, then you're locked in to using only Amazon EC2 which is, to my understanding, not true.

[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}.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

"must" is too strong for my taste. However, I think that we will drop "installing Foreman Server", "Installing Smart Proxy Servers", and "Registering Hosts" in the near future when we move the relevent bits and pieces into "Planning for Foreman", so I think we can leave this as is for now.

The same applies to guides/common/modules/proc_installing-foreman-server-on-aws.adoc and guides/common/modules/proc_installing-smart-proxy-server-on-aws.adoc.

@maximiliankolb
Copy link
Contributor Author

TODO: After #3167 has been merged, mention the option to run external DBs on dedicated Amazon service: https://aws.amazon.com/rds/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants