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

Resolves 2333 "Specify Puppet version requirement" #2551

Merged
merged 7 commits into from
Oct 26, 2023
Merged
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: 1 addition & 4 deletions guides/common/modules/proc_configuring-repositories-el.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
# {package-manager} clean all
----
ifdef::foreman-el,katello[]
+
. Install the `foreman-release.rpm` package:
+
[options="nowrap" subs="+quotes,attributes"]
Expand All @@ -16,16 +15,14 @@ ifdef::foreman-el,katello[]
----
endif::[]
ifdef::katello[]
+
. Install the `katello-repos-latest.rpm` package
. Install the `katello-repos-latest.rpm` package:
+
[options="nowrap" subs="+quotes,attributes"]
----
# {package-install} https://yum.theforeman.org/katello/{KatelloVersion}/katello/el{distribution-major-version}/x86_64/katello-repos-latest.rpm
----
endif::[]
ifdef::foreman-el,katello[]
+
. Install the `puppet7-release-el-{distribution-major-version}.noarch.rpm` package:
+
[options="nowrap" subs="+quotes,attributes"]
Expand Down
14 changes: 8 additions & 6 deletions guides/common/modules/proc_enabling-puppet.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,29 @@

By default, {Project} does not have any Puppet integration configured.
You need to enable the integration as is appropriate for your situation.
This means that you can configure {Project} to manage and deploy Puppet server on {ProjectServer} or on {SmartProxy}.
This means that you can configure {Project} to manage and deploy Puppet server on {ProjectServer} or {SmartProxyServers}.
Additionally, you can deploy Puppet server to {Project} externally and integrate it with {Project} for reporting, facts, and external node classification (ENC).

.Procedure
. Enable Puppet integration and install Puppet server on {ProjectServer}:
+
[options="nowrap" subs="+quotes,attributes"]
----
# {foreman-installer} --enable-foreman-plugin-puppet \
# {foreman-installer} \
--enable-foreman-cli-puppet \
--enable-foreman-plugin-puppet \
--enable-puppet \
--foreman-proxy-puppet true \
--foreman-proxy-puppetca true \
--enable-puppet \
--puppet-server true
----
. If you want to use Puppet integration on {SmartProxies}, enable Puppet integration and install Puppet server on {SmartProxies}:
. If you want to use Puppet integration on {SmartProxyServers}, enable Puppet integration and install Puppet server on {SmartProxyServers}:
+
[options="nowrap" subs="+quotes,attributes"]
----
# {foreman-installer} --foreman-proxy-puppet true \
--foreman-proxy-puppetca true \
# {foreman-installer} \
--enable-puppet \
--foreman-proxy-puppet true \
--foreman-proxy-puppetca true \
--puppet-server true
----
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,12 @@ endif::[]
.Procedure
. In the {ProjectWebUI}, navigate to *Configure* > *Global Parameters* to add host parameters globally.
Alternatively, you can navigate to *Configure* > *Host Groups* and edit or create a host group to add host parameters only to a host group.
ifdef::katello,orcharhino,satellite[]
. Enable the Puppet agent using a host parameter in global parameters or a host group.
ifdef::katello,orcharhino,satellite[]
Add a host parameter named `enable-puppet7`, select the *boolean* type, and set the value to `true`.
endif::[]
ifndef::katello,orcharhino,satellite[]
. Enable the Puppet agent from the official Puppet repository using one of the following host parameters in global parameters or a host group:

* Add a host parameter named `enable-puppetlabs-repo` for the latest stable Puppet release in the unversioned repository.
* Add a host parameter named `enable-official-puppet7-repo` for the Puppet 7 release repository.

+
Select the *boolean* type and set the value to `true`.
Add a host parameter named `enable-official-puppet7-repo`, select the *boolean* type, and set the value to `true`.
endif::[]
. Specify configuration for the Puppet agent using the following host parameters in global parameters or a host group:
* Add a host parameter named `puppet_server`, select the *string* type, and set the value to the hostname of your Puppet server, such as `puppet.example.com`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@
Before you begin with the Puppet integration, review the supported Puppet versions and system requirements.

Supported Puppet Versions::
{Project} supports the following Puppet versions:

* Puppet 7
{Project} supports Puppet 7.
Ensure that the Puppet modules used to configure managed hosts are compatible with Puppet 7.

System Requirements::
Before you begin integrating Puppet with your {Project}, ensure that you meet the system requirements.
Expand Down
14 changes: 10 additions & 4 deletions guides/doc-Quickstart/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,30 @@ include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::HideDocumentOnStable[]

The Foreman installer is a collection of Puppet modules that installs everything required for a full working Foreman setup. It uses native OS packaging (e.g. RPM and .deb packages) and adds necessary configuration for the complete installation.
The Foreman installer is a collection of Puppet modules that installs everything required for a full working Foreman setup.
It uses native OS packaging (`.rpm` or `.deb` packages) and adds necessary configuration for the complete installation.

Components include the Foreman web UI, Smart Proxy, a Puppet server, TFTP, DNS and DHCP servers. It is configurable and the Puppet modules can be read or run in “no-op” mode to see what changes it will make.
Components include the Foreman web UI, Smart Proxy, a Puppet server, TFTP, DNS and DHCP servers.
It is configurable and the Puppet modules can be read or run in "no-op" mode to see what changes it will make.

include::common/modules/ref_supported-operating-systems.adoc[]

The installation will require 4GB of memory.
For more information, see {InstallingServerDocURL}system-requirements_{project-context}[System Requirements].

The Foreman installer uses Puppet (5 or later required) to install Foreman. This guide assumes that you have a newly installed operating system, on which the installer will setup Foreman, a Puppet server, and the Smart Proxy by default. It’s not advisable to follow the steps below on an existing system, since the installer will affect the configuration of several components.
The Foreman installer uses Puppet to install Foreman.
This guide assumes that you have a newly installed operating system, on which the installer will setup Foreman, a Puppet server, and the Smart Proxy by default.
It's not advisable to follow the steps below on an existing system, since the installer will affect the configuration of several components.

include::common/modules/proc_configuring-repositories.adoc[leveloffset=+1]

include::common/modules/proc_installing-the-satellite-server-packages.adoc[leveloffset=+1]

== Running the Installer

The installation run is non-interactive, but the configuration can be customized by supplying any of the options listed in foreman-installer --help, or by running foreman-installer -i for interactive mode. More examples are given in the Installation Options section. Adding -v will disable the progress bar and display all changes.
The installation run is non-interactive, but the configuration can be customized by supplying any of the options listed in `foreman-installer --help`, or by running `foreman-installer -i` for interactive mode.
More examples are given in the Installation Options section.
Adding `-v` will disable the progress bar and display all changes.

To run the installer, execute:

Expand Down