diff --git a/guides/common/assembly_customizing-the-installation.adoc b/guides/common/assembly_customizing-the-installation.adoc new file mode 100644 index 00000000000..530c790ca4c --- /dev/null +++ b/guides/common/assembly_customizing-the-installation.adoc @@ -0,0 +1,26 @@ +[id="customizing-the-installation"] += Customizing the installation + +* Overview of common options + +#As an administrator, I want to leverage {Insights} to diagnose my {ProjectServer}. + +#As an administrator, I want to leverage {Insights} to diagnose my {Project} hosts; I can register my {Project} Server with {Insights} directly so that it sends data to Red Hat services.# + +#As an administrator, I want to leverage {Insights} to diagnose my {Project} hosts; I want to avoid sending system data to Red Hat services.# + +#As an administrator, I want to configure my {ProjectServer} for pull-based remote execution to be able to manage my hosts remotely without enabling outgoing connections from the server to the hosts.# + +#As an administrator, I want to configure my {ProjectServer} to provision hosts in an IPv6 network with UEFI HTTP Boot provisioning.# + +#As an administrator, I want to configure my {ProjectServer} with an HTTP proxy that will handle requests to the content source, such as Red Hat CDN, so that the server can remain behind a firewall.# + +#As an administrator, I want to enable the baseboard management controller (BMC) module on my {ProjectServer} so that I can perform power management tasks on hosts using the intelligent platform management interface (IPMI) or a similar protocol.# + +#As an administrator, I want to configure the server for outgoing emails so that the server can send email notifications to users.# + +#As an administrator, I want to integrate my {ProjectServer} with an {FreeIPA} realm so that {Project} can automatically manage the lifecycle of the systems enrolled in the {FreeIPA} domain.# + +#As an administrator, I want to configure an alternate CNAME for {Project} so that I can deploy the {Project} web interface on a different domain name than the one that is used by hosts to connect to {Project}.# + +#As an administrator, I want to configure my {ProjectServer} with a custom SSL certificate to ensure encrypted communications between the server and all hosts in a deployment where I cannot or do not want to use {Project}'s default self-signed certificate. (Includes substory: I want to be able to switch back to using {Project}'s default self-signed certificate.)# diff --git a/guides/common/assembly_installing-server.adoc b/guides/common/assembly_installing-server.adoc new file mode 100644 index 00000000000..bdf800090c1 --- /dev/null +++ b/guides/common/assembly_installing-server.adoc @@ -0,0 +1,7 @@ +include::modules/con_installing-project-server.adoc[] + +include::modules/con_overview-of-the-installation-process.adoc[leveloffset=+1] + +include::modules/proc_basic-initial-configuration.adoc[leveloffset=+1] + +include::modules/proc_examining-the-installation-logs.adoc[leveloffset=+1] diff --git a/guides/common/assembly_planning-project-server-installation.adoc b/guides/common/assembly_planning-project-server-installation.adoc index 1148f5c7ecf..0e630ed776c 100644 --- a/guides/common/assembly_planning-project-server-installation.adoc +++ b/guides/common/assembly_planning-project-server-installation.adoc @@ -16,4 +16,6 @@ ifeval::["{mode}" == "connected"] include::modules/ref_ipv6-and-ipv4-requirements.adoc[leveloffset=+1] endif::[] +ifndef::foremanctl[] include::modules/con_aws-requirements.adoc[leveloffset=+1] +endif::[] diff --git a/guides/common/assembly_preparing-environment-for-project-server-installation.adoc b/guides/common/assembly_preparing-environment-for-project-server-installation.adoc index 06e4d143ebf..3cc71439219 100644 --- a/guides/common/assembly_preparing-environment-for-project-server-installation.adoc +++ b/guides/common/assembly_preparing-environment-for-project-server-installation.adoc @@ -6,4 +6,6 @@ include::modules/proc_opening-required-ports.adoc[leveloffset=+1] include::modules/proc_verifying-dns-resolution.adoc[leveloffset=+1] +ifndef::foremanctl[] include::modules/proc_preparing-for-using-external-databases.adoc[leveloffset=+1] +endif::[] diff --git a/guides/common/modules/con_installing-project-server.adoc b/guides/common/modules/con_installing-project-server.adoc new file mode 100644 index 00000000000..ff473b87d9c --- /dev/null +++ b/guides/common/modules/con_installing-project-server.adoc @@ -0,0 +1,4 @@ +[id="installing-{project-context}-server"] += Installing {ProjectServer} + +Basic installation scenarios only. Purpose: Explain `foremanctl`, show basic procedures, explain how to troubleshoot. diff --git a/guides/common/modules/con_overview-of-the-installation-process.adoc b/guides/common/modules/con_overview-of-the-installation-process.adoc new file mode 100644 index 00000000000..d0ccf53ef01 --- /dev/null +++ b/guides/common/modules/con_overview-of-the-installation-process.adoc @@ -0,0 +1,7 @@ +[id="overview-of-the-installation-process"] += Overview of the installation process + +* We use `foremanctl`, which can install and perform additional configuration after installation +* You can install a basic server and then add additional config, or you can do everything in one step + +#As an administrator, I want to leverage tuning profiles to ensure my deployment is tailored to the number of hosts I'll deploy so that I prevent performance issues.# diff --git a/guides/common/modules/con_planning-project-server-installation.adoc b/guides/common/modules/con_planning-project-server-installation.adoc index 13ef444c0cd..c0c560a035a 100644 --- a/guides/common/modules/con_planning-project-server-installation.adoc +++ b/guides/common/modules/con_planning-project-server-installation.adoc @@ -4,3 +4,8 @@ = Planning {ProjectServer} installation Review the following guidelines, requirements, and considerations before proceeding with the installation. + +ifdef::foremanctl[] +:FeatureName: The `foremanctl` installer +include::snip_technology-preview.adoc[] +endif::[] diff --git a/guides/common/modules/proc_basic-initial-configuration.adoc b/guides/common/modules/proc_basic-initial-configuration.adoc new file mode 100644 index 00000000000..46beb8659c2 --- /dev/null +++ b/guides/common/modules/proc_basic-initial-configuration.adoc @@ -0,0 +1,13 @@ +[id="basic-initial-configuration"] += Basic initial configuration + +* Scenario with default database +* Scenario with external database + +#As an administrator, I want to install a {ProjectServer} with the default local (internal) database so that I can keep the installation process simple; I don't need the option to fine-tune the database.# + +#As an administrator, I want to install a {ProjectServer} with an external PostgreSQL database (with or without encrypted connections) to help with the server load and gain more flexibility in tuning the database.# + +.Next steps +* Feel free to extend and customize. +See xref:customizing-the-installation[]. diff --git a/guides/common/modules/proc_examining-the-installation-logs.adoc b/guides/common/modules/proc_examining-the-installation-logs.adoc new file mode 100644 index 00000000000..9130a59e2fd --- /dev/null +++ b/guides/common/modules/proc_examining-the-installation-logs.adoc @@ -0,0 +1,7 @@ +[id="examining-the-installation-logs"] +== Examining the logs + +* How to troubleshoot if the installation goes wrong +* List of common problems + +#As an administrator, I want to leverage installation logs so that I can review the installation process or troubleshoot failures.# diff --git a/guides/common/modules/proc_examining-the-logs.adoc b/guides/common/modules/proc_examining-the-logs.adoc new file mode 100644 index 00000000000..e69de29bb2d diff --git a/guides/common/modules/ref_ipv6-and-ipv4-requirements.adoc b/guides/common/modules/ref_ipv6-and-ipv4-requirements.adoc index 9be58436d09..1af4323fbeb 100644 --- a/guides/common/modules/ref_ipv6-and-ipv4-requirements.adoc +++ b/guides/common/modules/ref_ipv6-and-ipv4-requirements.adoc @@ -35,12 +35,16 @@ If you intend to provision hosts in an IPv6 network, the following requirements * Deploy an external DHCPv6 server and configure it manually to communicate with the network boot process and to manage IP address assignment because {Project} cannot integrate with a DHCPv6 server and manage its configuration. For more information about DHCPv6 server configuration, see {ProvisioningDocURL}options-in-unmanaged-dhcpv6[Options in unmanaged DHCPv6] in _{ProvisioningDocTitle}_. +ifndef::foremanctl[] * Configure {Project} for UEFI HTTP boot provisioning. Although {Project} provisioning templates include IPv6 support for PXE and HTTP (iPXE) provisioning, the UEFI HTTP Boot provisioning is the only tested and certified provisioning workflow. For more information, see xref:configuring-for-uefi-http-boot-provisioning-in-an-ipv6-network_{context}[]. +endif::[] .Additional resources ifdef::satellite[] * link:https://access.redhat.com/solutions/5045841[_How do I disable the IPv6 protocol on Red Hat Satellite and/or Red Hat Capsule server?_ in Red Hat Knowledgebase] endif::[] +ifndef::foremanctl[] * xref:adding-a-default-http-proxy_{context}[] +endif::[] diff --git a/guides/common/modules/ref_system-requirements.adoc b/guides/common/modules/ref_system-requirements.adoc index 51f60c4b592..d32726b8eff 100644 --- a/guides/common/modules/ref_system-requirements.adoc +++ b/guides/common/modules/ref_system-requirements.adoc @@ -58,24 +58,30 @@ ifndef::foreman-deb[] For more information about configuring system locale in {EL}, see {RHELDocsBaseURL}9/html/configuring_basic_system_settings/assembly_changing-basic-environment-settings_configuring-basic-system-settings#proc_configuring-the-system-locale_assembly_changing-basic-environment-settings[Configuring the system locale] in _{RHEL}{nbsp}9 Configuring basic system settings_. endif::[] +ifndef::foremanctl[] * If you use an external identity provider in your deployment, ensure the provider did not create the following user accounts on the system. These user accounts can cause conflicts with the local users that {ProductName} creates: -** {apache-user} +** `{apache-user}` ifeval::["{context}" == "{project-context}"] -** foreman +** `foreman` endif::[] -** foreman-proxy -** postgres +** `foreman-proxy` +** `postgres` ifdef::katello,satellite,orcharhino[] -** pulp +** `pulp` endif::[] -** puppet -** redis +** `puppet` +** `redis` ifdef::katello,satellite,orcharhino[] ifeval::["{context}" == "{project-context}"] -** tomcat +** `tomcat` endif::[] endif::[] +endif::[] +ifdef::foremanctl[] +* If you use an external identity provider in your deployment, ensure the provider did not create the `{apache-user}` user account on the system. +This user account can cause conflicts with the local users that {ProductName} creates. +endif::[] ifeval::["{context}" == "{smart-proxy-context}"] [WARNING] diff --git a/guides/doc-Installing_Server_foremanctl/master.adoc b/guides/doc-Installing_Server_foremanctl/master.adoc index a96472c2531..e33862b383c 100644 --- a/guides/doc-Installing_Server_foremanctl/master.adoc +++ b/guides/doc-Installing_Server_foremanctl/master.adoc @@ -4,14 +4,17 @@ include::common/header.adoc[] :context: {project-context} :mode: connected :ProductName: {ProjectServer} -:installer-foremanctl: +:foremanctl: = {InstallingServerCTLDocTitle} -== Technology preview +include::common/assembly_planning-project-server-installation.adoc[leveloffset=+1] -:FeatureName: The `foremanctl` installer -include::common/modules/snip_technology-preview.adoc[] +include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1] + +include::common/assembly_installing-server.adoc[leveloffset=+1] + +include::common/assembly_customizing-the-installation.adoc[leveloffset=+1] ifndef::orcharhino,satellite[] include::common/ribbons.adoc[]