Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ jobs:
make -j ${{ env.MAKE_J }} html BUILD=katello
make -j ${{ env.MAKE_J }} html BUILD=satellite
make -j ${{ env.MAKE_J }} html BUILD=orcharhino
make -j ${{ env.MAKE_J }} html BUILD=foreman-el-foremanctl
make -j ${{ env.MAKE_J }} html BUILD=foreman-deb-foremanctl
make -j ${{ env.MAKE_J }} html BUILD=katello-foremanctl
make -j ${{ env.MAKE_J }} html BUILD=satellite-foremanctl
make -j ${{ env.MAKE_J }} html BUILD=orcharhino-foremanctl

- name: Upload HTML
uses: actions/upload-artifact@v5
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ clean:
$(MAKE) -C guides/ clean
rm -rf $(DEST) web/output/

html: build-foreman-el build-foreman-deb build-katello
html: build-foreman-el build-foreman-deb build-katello build-foreman-el-foremanctl build-foreman-deb-foremanctl build-foreman-katello-foremanctl

build-%: FORCE prep
$(MAKE) -C guides/ html BUILD=$*
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ See the [README in the `guides/` subdirectory](guides/README.md) for more inform

To build both the static site and the guides for easy local testing, a global `Makefile` is provided in the root directory with the following targets:

* `html`: builds HTML guides with all contexts (`foreman-el`, `foreman-deb`, `katello`, `satellite`, and `orcharhino`)
* `html`: builds HTML guides with all contexts (`foreman-el`, `foreman-deb`, `katello`, `satellite`, `orcharhino`, including `foremanctl` build for each context)
* `web`: builds static site using the `nanoc` tool
* `compile`: compiles all content into a single directory `./result`
* `serve`: serves the result directory via a python web server (the default target)
Expand Down
9 changes: 9 additions & 0 deletions guides/common/assembly_installing-server.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:_mod-docs-content-type: ASSEMBLY

include::modules/con_installing-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-logs.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions guides/common/attributes-foreman-deb-foremanctl.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-foreman-deb.adoc[]
1 change: 1 addition & 0 deletions guides/common/attributes-foreman-el-foremanctl.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-foreman-el.adoc[]
1 change: 1 addition & 0 deletions guides/common/attributes-katello-foremanctl.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-katello.adoc[]
1 change: 1 addition & 0 deletions guides/common/attributes-orcharhino-foremanctl.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-orcharhino.adoc[]
1 change: 1 addition & 0 deletions guides/common/attributes-satellite-foremanctl.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-satellite.adoc[]
27 changes: 27 additions & 0 deletions guides/common/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@
// * attributes-katello.adoc (attributes overridden or unique to Katello)
// * attributes-orcharhino.adoc (attributes overridden or unique to orcharhino)
// * attributes-satellite.adoc (attributes overridden or unique to Satellite)
// * attributes-foreman-el-foremanctl.adoc (attributes overridden or unique to foremanctl build)
// * attributes-foreman-deb-foremanctl.adoc (attributes overridden or unique to foremanctl build)
// * attributes-katello-foremanctl.adoc (attributes overridden or unique to foremanctl build)
// * attributes-orcharhino-foremanctl.adoc (attributes overridden or unique to foremanctl build)
// * attributes-satellite-foremanctl.adoc (attributes overridden or unique to foremanctl build)

// Define properties to represent each build. Allows 'or' and 'and' operations in conditions.
ifeval::["{build}" == "foreman-el"]
Expand All @@ -46,6 +51,28 @@ endif::[]
ifeval::["{build}" == "orcharhino"]
:orcharhino:
endif::[]
ifeval::["{build}" == "foreman-el-foremanctl"]
:foreman-el:
:foreman:
:foremanctl:
endif::[]
ifeval::["{build}" == "foreman-deb-foremanctl"]
:foreman-deb:
:foreman:
:foremanctl:
endif::[]
ifeval::["{build}" == "katello-foremanctl"]
:foremanctl:
:katello:
endif::[]
ifeval::["{build}" == "satellite-foremanctl"]
:foremanctl:
:satellite:
endif::[]
ifeval::["{build}" == "orcharhino-foremanctl"]
:foremanctl:
:orcharhino:
endif::[]

// Load base attributes
:SiteURL: https://docs.theforeman.org
Expand Down
2 changes: 2 additions & 0 deletions guides/common/modules/con_installing-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ On {EL}, you can install {Project} with or without the Katello plugin.
If you are a new user, consider installing {Project} with the Katello plugin.
endif::[]

ifndef::foremanctl[]
Note that the {Project} installation script is based on Puppet, which means that if you run the installation script more than once, it might overwrite any manual configuration changes.
To avoid this and determine which future changes apply, use the `--noop` argument when you run the installation script.
Expand All @@ -45,3 +46,4 @@ You can restore the previous file as follows:
# puppet filebucket -l \
restore /etc/dhcp/dhcpd.conf 622d9820b8e764ab124367c68f5fa3a1
----
endif::[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[id="overview-of-the-installation-process"]
= Overview of the installation process
2 changes: 2 additions & 0 deletions guides/common/modules/proc_basic-initial-configuration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[id="basic-initial-configuration"]
= Basic initial configuration
2 changes: 2 additions & 0 deletions guides/common/modules/proc_examining-the-logs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[id="examining-the-logs"]
= Examining the logs
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ For more information, see {AdministeringDocURL}postgresql-as-an-external-databas
* Install PostgreSQL on an external database host you prepared.
For more information, see {AdministeringDocURL}installing-postgresql_admin[Installing PostgreSQL] in _{AdministeringDocTitle}_.

ifndef::foremanctl[]
.Next steps
* To set up an external database when installing {Project}, see xref:configuring-{project-context}-installation[].
endif::[]

.Additional resources
* {AdministeringDocURL}Migrating_from_Internal_Databases_to_External_Databases_admin[Migrating an existing {Project} deployment to an external database] in _{AdministeringDocTitle}_.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@
Install the required packages and run the {Project} deployment utility.

.Procedure
ifdef::foremanctl[]
[tabs]
====
Puppet-based installation::
endif::[]
ifndef::foremanctl[]
. Upgrade all packages:
+
[options="nowrap" subs="+quotes,attributes"]
Expand All @@ -36,8 +32,8 @@ The installation run is non-interactive by default.
The script displays its progress and writes logs to `{installer-log-file}`.
+
For a list of the available customization options, run `{foreman-installer} --help` or `{foreman-installer} --full-help`.
endif::[]
ifdef::foremanctl[]
Containerized installation::
. Upgrade all packages:
+
[options="nowrap" subs="+quotes,attributes"]
Expand All @@ -60,5 +56,4 @@ Containerized installation::
You can find credentials to access your {ProjectServer} in the message shown in the `TASK [post_install : Admin credentials]` task results.
+
For a list of available options, run `foremanctl --help`.
====
endif::[]
4 changes: 4 additions & 0 deletions guides/common/modules/ref_ipv6-and-ipv4-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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::[]
9 changes: 2 additions & 7 deletions guides/common/modules/ref_system-requirements-quickstart.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@

The following list shows the most critical requirements common for most scenarios.

ifdef::foremanctl[]
[tabs]
====
Puppet-based installation::
endif::[]
ifndef::foremanctl[]
// The requirements in this section must match the full requirements in the installation guide.
ifdef::foreman-deb[]
* The following operating systems are supported for deploying {Project}:
Expand All @@ -30,9 +26,9 @@ ifdef::foreman-el,katello,orcharhino[]
endif::[]
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
* Ensure the system has at least {project-minimum-cpus} and {project-minimum-memory} of memory.
endif::[]

ifdef::foremanctl[]
Containerized installation::
ifdef::foreman-deb[]
* The following operating systems are supported for deploying {Project}:
endif::[]
Expand All @@ -49,5 +45,4 @@ ifdef::foreman-deb[]
endif::[]
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
* Ensure the system has at least {project-minimum-cpus} and {project-minimum-memory} of memory.
====
endif::[]
22 changes: 14 additions & 8 deletions guides/common/modules/ref_system-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
16 changes: 0 additions & 16 deletions guides/common/modules/snip_configuring-repositories-el.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
ifdef::foremanctl[]
[tabs]
====
Puppet-based installation::
endif::[]
. Clear any metadata:
+
[options="nowrap" subs="+quotes,attributes"]
Expand Down Expand Up @@ -40,14 +35,3 @@ ifdef::foreman-el,katello[]
# {package-install} https://yum.puppet.com/puppet7-release-el-{distribution-major-version}.noarch.rpm
----
endif::[]

ifdef::foremanctl[]
Containerized installation::
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
====
endif::[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* Enable the required repositories:
+
[options="nowrap" subs="+quotes,attributes"]
----
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
----
7 changes: 6 additions & 1 deletion guides/doc-Installing_Server/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ include::common/assembly_planning-project-server-installation.adoc[leveloffset=+

include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1]

ifdef::foremanctl[]
include::common/assembly_installing-server.adoc[leveloffset=+1]
endif::[]

ifndef::foremanctl[]
include::common/assembly_installing-server-connected.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
Expand Down Expand Up @@ -73,7 +78,7 @@ endif::[]

[appendix]
include::common/modules/proc_restoring-manual-changes-overwritten-by-a-puppet-run.adoc[leveloffset=+1]

endif::[]
endif::[]

ifndef::orcharhino,satellite[]
Expand Down
9 changes: 1 addition & 8 deletions guides/doc-Quickstart/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,13 @@ include::common/header.adoc[]
:mode: connected
:ProductName: {ProjectServer}
:tabs-sync-option:
ifdef::katello[]
:foremanctl:
endif::[]

= {QuickstartDocTitle}

This guide describes the quickest way to get a {ProjectServer} up and running.
ifdef::foremanctl[]
You can choose between a Puppet-based installation and containerized installation.
endif::[]
For a full installation guide, see {InstallingServerDocURL}[_{InstallingServerDocTitle}_].
ifdef::foremanctl[]
The full installation guide is currently provided only for the Puppet-based installation.

ifdef::foremanctl[]
:FeatureName: The `foremanctl` deployment utility
include::common/modules/snip_technology-preview.adoc[]
endif::[]
Expand Down
2 changes: 2 additions & 0 deletions guides/doc-Release_Notes/master.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
include::common/attributes.adoc[]
include::common/header.adoc[]

ifndef::foremanctl[]
ifndef::katello[]
include::topics/foreman.adoc[]
endif::[]
Expand All @@ -27,6 +28,7 @@ ifdef::katello[]

include::topics/katello-contributors.adoc[leveloffset=+1]
endif::[]
endif::[]

ifndef::orcharhino,satellite[]
include::common/ribbons.adoc[]
Expand Down
2 changes: 2 additions & 0 deletions guides/doc-Upgrading_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

ifndef::foremanctl[]
ifdef::foreman-el[]
[IMPORTANT]
====
Expand Down Expand Up @@ -47,6 +48,7 @@ endif::[]

[appendix]
include::common/modules/proc_troubleshooting-permission-issues.adoc[leveloffset=+1]
endif::[]

ifndef::orcharhino,satellite[]
include::common/ribbons.adoc[]
Expand Down
3 changes: 3 additions & 0 deletions web/content/index.adoc.erb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ The future version is built in nightly:
** link:/release/nightly/index-foreman-el.html[Foreman on Enterprise Linux (EL)]
** link:/release/nightly/index-foreman-deb.html[Foreman on Debian/Ubuntu]
** link:/release/nightly/index-katello.html[Foreman with Katello on Enterprise Linux (EL)]
** link:/release/nightly/index-foreman-el-foremanctl.html[Containerized Foreman on Enterprise Linux (EL)]
** link:/release/nightly/index-foreman-deb-foremanctl.html[Containerized Foreman on Debian/Ubuntu]
** link:/release/nightly/index-katello-foremanctl.html[Containerized Foreman with Katello on Enterprise Linux (EL)]

<% if (release = releases_in_state('RC').first) %>
A release candidate is available for testing:
Expand Down
Loading
Loading