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

Add 3.12 folder and update nightly #2170

Merged
merged 4 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ plugins:

foreman_versions:
- nightly
- "3.12"
- "3.11"
- "3.10"
- "3.9"
Expand Down
17 changes: 17 additions & 0 deletions _includes/manuals/3.12/1.1_architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

## Foreman Architecture

A Foreman installation will always contain a central Foreman instance
that is responsible for providing the Web based GUI, node
configurations, initial host configuration files, etc. However, if the
Foreman installation supports unattended installations, then other
operations need to be performed to fully automate this process. The
Smart Proxy manages remote services and is generally installed with all
Foreman installations to manage TFTP, DHCP, DNS, Puppet, Puppet CA,
Ansible, and Salt.

## Smart-Proxy

A [Smart-Proxy](manuals/{{page.version}}/index.html#4.3SmartProxies) is located on or near a machine that performs a specific function and helps Foreman orchestrate the process of commissioning a new host. Placing the Smart Proxy on or near to the actual service will also help reduce latency in large distributed organizations.

![Foreman Architecture](/static/images/foreman_architecture.png)
139 changes: 139 additions & 0 deletions _includes/manuals/3.12/1.2_release_notes.md
Copy link
Member

Choose a reason for hiding this comment

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

I just categorized all issues. Would you mind regenerating?

Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
## Release notes for {{page.version}}

This section will be updated prior to the next release.

### Headline features

### Upgrade warnings

### Deprecations

### Release notes for 3.12.0

#### Foreman
* Add product host count to 'Subscription - General Report' ([#37756](https://projects.theforeman.org/issues/37756))
* Fix audit message about removing records ([#37734](https://projects.theforeman.org/issues/37734))
* Change All Hosts kebab menu to match mockup [Foreman] ([#37675](https://projects.theforeman.org/issues/37675))
* Invalid MAC address error message appears twice while editing interface ([#37651](https://projects.theforeman.org/issues/37651))
* Curl command cannot be rendered during host registration due to Loc/Org mismatch ([#37640](https://projects.theforeman.org/issues/37640))
* FFI 1.17.0+ requires Rubygems 3.3.22+ for installation, breaking Ruby 2.7 source installs ([#37607](https://projects.theforeman.org/issues/37607))
* Monitor -> Host statusses shows "Pending Installation" instead of Installed ([#37589](https://projects.theforeman.org/issues/37589))
* [RFE] Provisioning Templates or RHEL 9 should have option timesource ([#37581](https://projects.theforeman.org/issues/37581))
* Improved "EFI local chainloading" on SecureBoot enabled hosts not working for all distribution ([#37562](https://projects.theforeman.org/issues/37562))
* As a web UI user, I can select multiple hosts and perform a bulk change of the hostgroup ([#37551](https://projects.theforeman.org/issues/37551))
* per_page=all doesn't work for parameters of subnets, domains, organizations.... ([#37550](https://projects.theforeman.org/issues/37550))
* HostsIndex page should gracefully handle when 'Any organization' is selected ([#37548](https://projects.theforeman.org/issues/37548))
* Append domain name setting ([#37532](https://projects.theforeman.org/issues/37532))
* cleanup media dup ([#37527](https://projects.theforeman.org/issues/37527))
* Plugins are finalized before seeds are executed ([#37503](https://projects.theforeman.org/issues/37503))
* Unify sending built status in host_init_config ([#37495](https://projects.theforeman.org/issues/37495))
* Fix Style/CaseLikeIf cop ([#37458](https://projects.theforeman.org/issues/37458))
* Cloudinit default generates invalid yaml output ([#37433](https://projects.theforeman.org/issues/37433))
* Fix Style/ExplicitBlockArgument cop ([#37428](https://projects.theforeman.org/issues/37428))
* Rubocop minitest rules fix ([#37426](https://projects.theforeman.org/issues/37426))
* Fix Style/RedundantRegexpEscape cop ([#37424](https://projects.theforeman.org/issues/37424))
* Open Fix Style/HashEachMethods cop ([#37423](https://projects.theforeman.org/issues/37423))
* Fix Style/AccessorGrouping cop ([#37420](https://projects.theforeman.org/issues/37420))
* As a web UI user, I can select multiple hosts and perform build actions ([#37395](https://projects.theforeman.org/issues/37395))
* Improve "EFI local chainloading" on SecureBoot enabled hosts ([#37345](https://projects.theforeman.org/issues/37345))
* Help page should not link libera chat anymore after the migration to matrix ([#37086](https://projects.theforeman.org/issues/37086))
* Possibility to use selenium remote driver ([#36978](https://projects.theforeman.org/issues/36978))
* Upload facts after host provisioning ([#36886](https://projects.theforeman.org/issues/36886))
* Fix parsing of Ubuntu version in fact parsers ([#36547](https://projects.theforeman.org/issues/36547))

#### Foreman - Compute resources - VMware
* Feature Request: Support of NVMe controllers for VMware ([#34839](https://projects.theforeman.org/issues/34839))

#### Foreman - Compute resources - libvirt
* Drop CPU model for libvirt VM creation ([#36999](https://projects.theforeman.org/issues/36999))

#### Foreman - Host registration
* Host remains in build mode during registration when setup_insights is set to true ([#37720](https://projects.theforeman.org/issues/37720))
* Find methods for taxonomies ([#37702](https://projects.theforeman.org/issues/37702))

#### Foreman - JavaScript stack
* Drop coffee-rails dependency ([#37583](https://projects.theforeman.org/issues/37583))
* Content Columns can disappear from the Manage Columns widget on the redesigned All Hosts Page ([#37553](https://projects.theforeman.org/issues/37553))
* Change I18n loading from import to require ([#37300](https://projects.theforeman.org/issues/37300))

#### Foreman - Organizations and Locations
* Smart Proxy forces association to all Locations unless Puppet is enabled on the proxy ([#29450](https://projects.theforeman.org/issues/29450))

#### Foreman - Proxy gateway
* Test Connection' button in 'New HTTP Proxy' returns success with invalid URL ([#36919](https://projects.theforeman.org/issues/36919))

#### Foreman - Settings
* The description of a setting Instance color contains additional dot ([#37597](https://projects.theforeman.org/issues/37597))

#### Foreman - Templates
* Create a way to refresh CA certificates on hosts that are managed by Katello ([#37601](https://projects.theforeman.org/issues/37601))
* RHEL registration template ignores host_parm subscription_manager_org ([#37496](https://projects.theforeman.org/issues/37496))
* Templates - cloned_from reference ([#37059](https://projects.theforeman.org/issues/37059))
* Template render error when no PXELoader is selected ([#36626](https://projects.theforeman.org/issues/36626))

#### Foreman - Tests
* nic_managed factory can create an IP outside of its subnet ([#37711](https://projects.theforeman.org/issues/37711))
* Report renderer tests fail depending on the libyaml version ([#37613](https://projects.theforeman.org/issues/37613))
* with_temporary_settings test helper doesn't clean up properly ([#37558](https://projects.theforeman.org/issues/37558))

#### Foreman - Unattended installations
* Use SHA512 for root password hashing when no OS is set ([#37614](https://projects.theforeman.org/issues/37614))
* HostCommon.crypt_passwords reencrypts Base64 based passwords for Grub, leading to errors ([#37610](https://projects.theforeman.org/issues/37610))
* Extend Windows support in templates ([#36495](https://projects.theforeman.org/issues/36495))

#### Foreman - Web Interface
* Add button linking to new All Hosts UI ([#37690](https://projects.theforeman.org/issues/37690))
* Show complete hostgroup name in host overview and table ([#37648](https://projects.theforeman.org/issues/37648))
* Tab title missing in tableindexpage ([#37645](https://projects.theforeman.org/issues/37645))
* Pagination doesnt always update between react pages ([#37644](https://projects.theforeman.org/issues/37644))
* Template render error when host has .ics domain name ([#37623](https://projects.theforeman.org/issues/37623))
* Host details - Fix append domain setting ([#37584](https://projects.theforeman.org/issues/37584))
* use textarea in host comment edit ([#37582](https://projects.theforeman.org/issues/37582))
* remove space between table buttons ([#37578](https://projects.theforeman.org/issues/37578))
* Foreman Table columns sort is inconsistent ([#37575](https://projects.theforeman.org/issues/37575))
* Cancel build shows notification with host id instead of hostname on the new UI of Red Hat Satellite ([#37556](https://projects.theforeman.org/issues/37556))
* New All Hosts page ignores pagination url params on first load ([#37485](https://projects.theforeman.org/issues/37485))
* Add Power Status column to new All Hosts page ([#37478](https://projects.theforeman.org/issues/37478))
* Extend TableIndexPage and TableHooks with new capabilities for All Hosts page ([#37398](https://projects.theforeman.org/issues/37398))

#### Installer
* After an OS version upgrade, the GUI still shows the old/wrong Operating System version ([#37726](https://projects.theforeman.org/issues/37726))
* Disable port 8443 by default ([#37701](https://projects.theforeman.org/issues/37701))
* Installler doesn't handle Puppetserver 8 upgrade ([#37686](https://projects.theforeman.org/issues/37686))
* Correct docroot for Content Proxies's Apache vhost ([#37620](https://projects.theforeman.org/issues/37620))
* Possibility to set puppet version in gitlab CI ([#37568](https://projects.theforeman.org/issues/37568))

#### Installer - Foreman modules
* Pasing --foreman-proxy-content-enable-docker false can leave smart_proxy_container_gateway in an inconsistent state ([#37707](https://projects.theforeman.org/issues/37707))
* DNS forwarders aren't validated ([#37604](https://projects.theforeman.org/issues/37604))

#### Installer - foreman-installer script
* Add check for ipv6.disable=1 in /proc/cmdline because it's known to break installations ([#37693](https://projects.theforeman.org/issues/37693))

#### Packaging - RPMs
* Make foreman-installer-katello pull in foreman-maintain ([#37663](https://projects.theforeman.org/issues/37663))

#### SELinux - Plugins
* Boot disk based Provisioning fails to generate ISO image for instance clietn.example.com: ERF42-8093 [Foreman::Exception]: ISO build failed ([#37497](https://projects.theforeman.org/issues/37497))

#### Smart Proxy
* Maximum sessions limit reached on iDRAC using Redfish as BMC provider ([#37486](https://projects.theforeman.org/issues/37486))

#### Smart Proxy - DHCP
* invalid value for Integer(): “#Resolv::DNS::Resource::IN::A:0x00007fnnnnnnnnn” ([#37621](https://projects.theforeman.org/issues/37621))

#### Smart Proxy - Packaging
* Pin FFI to < 1.17 on Ruby 2.x ([#37624](https://projects.theforeman.org/issues/37624))

#### Smart Proxy - Registration
* Host registration with repositories fails because smart-proxy cannot convert arrays to string ([#37631](https://projects.theforeman.org/issues/37631))

*A full list of changes in 3.12.0 is available via [Redmine](https://projects.theforeman.org/issues?set_filter=1&sort=id%3Adesc&status_id=closed&f[]=cf_12&op[cf_12]=%3D&v[cf_12]=1836)*

### Contributors

We'd like to thank the following people who contributed to the Foreman {{page.version}} release:

Adam Lazik,Adam Růžička,Aneta Šteflová Petrová,Archana Kumari,Beat Gaetzi,Bernhard Suttner,Chris Roberts,Cole Higgins,Dirk Götz,Eric Helms,Evgeni Golov,Ewoud Kohl van Wijngaarden,Girija Soni,Griffin-Sullivan,Jan Löser,Jeremy Lenz,Joniel Pasqualetto,Laurent Bigonville,Leos Stejskal,Marek Hulán,Maria Agaphontzev,Markus Reisner,Martin Alfke,Maximilian Kolb,Nadja Heitmann,Nofar Alfassi,Oleh Fedorenko,Partha Aji,Patrick Creech,Quinn James,RhinoX,Richard Stempfl,Romuald Conty,Samir Jha,Sayan Das,Shimon Shtein,William Bradford Clark,akumari,dosas,girijaasoni,kmalyjur,omahs

As well as all users who helped test releases, report bugs and provide feedback on the project.
193 changes: 193 additions & 0 deletions _includes/manuals/3.12/2.1_quickstart_installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
[The Foreman installer](/manuals/{{page.version}}/index.html#3.2ForemanInstaller) uses Puppet **(6 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](/manuals/{{page.version}}/index.html#4.3SmartProxies) 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.

<div class="alert alert-info">

If you want to manage content (for example, RPMs, Kickstart trees, ISO and KVM images, OSTree content, and more) with Foreman please follow the <a href="https://theforeman.org/plugins/katello/">Katello</a> installation instructions. If you are a new user, ensure that you familiarize yourself with <a href="https://theforeman.org/plugins/katello/">Katello</a> and decide whether you want to use its features because installing Katello on top of an existing Foreman is unsupported. Note that you cannot install Katello on Debian systems.

</div>


#### Select operating system

<script type="text/javascript">
function update_quickstart_os(select) {
var os = select.value;
$(".quickstart_os").hide();
if (os && os != 'none') {
$(".quickstart_os_"+os).show();
} else {
$(".quickstart_os_none").show();
}
}
</script>

To provide specific installation instructions, please select your operating system:
<select onChange="update_quickstart_os(this);">
<option value="none">-- select operating system --</option>
<option value="el8">Enterprise Linux 8</option>
<option value="el9">Enterprise Linux 9</option>
<option value="debian11">Debian 11 (Bullseye)</option>
<option value="ubuntu2004">Ubuntu 20.04 (Focal)</option>
<option value="ubuntu2204">Ubuntu 22.04 (Jammy)</option>
</select>

#### Repositories

<div class="quickstart_os quickstart_os_none">
<i>No operating system selected.</i>
</div>

<div class="quickstart_os quickstart_os_el8">
<p>
Enable Puppet's 7.x repository:
</p>

{% highlight bash %}
sudo dnf -y install https://yum.puppet.com/puppet7-release-el-8.noarch.rpm
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_el9">
<p>
Enable Puppet's 7.x repository:
</p>

{% highlight bash %}
sudo dnf -y install https://yum.puppet.com/puppet7-release-el-9.noarch.rpm
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_el8">
<p>Enable the Foreman repositories:</p>

{% highlight bash %}
sudo dnf -y install https://yum.theforeman.org/releases/{{page.version}}/el8/x86_64/foreman-release.rpm
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_el9">
<p>Enable the Foreman repositories:</p>

{% highlight bash %}
sudo dnf -y install https://yum.theforeman.org/releases/{{page.version}}/el9/x86_64/foreman-release.rpm
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_el8">
<p>Enable the Foreman module:</p>

{% highlight bash %}
sudo dnf -y module enable foreman:el8
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_debian11">
<p>
Enable Puppet's 7.x repository:
</p>

{% highlight bash %}
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-bullseye.deb
sudo apt-get install /tmp/puppet7-release-bullseye.deb
{% endhighlight %}

<p>Enable the Foreman repositories:</p>

{% highlight bash %}
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb http://deb.theforeman.org/ bullseye {{page.version}}" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb http://deb.theforeman.org/ plugins {{page.version}}" | sudo tee -a /etc/apt/sources.list.d/foreman.list
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_ubuntu2004">
<p>
Enable Puppet's 7.x repository:
</p>

{% highlight bash %}
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-focal.deb
sudo apt-get install /tmp/puppet7-release-focal.deb
{% endhighlight %}

<p>Enable the Foreman repositories:</p>

{% highlight bash %}
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb http://deb.theforeman.org/ focal {{page.version}}" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb http://deb.theforeman.org/ plugins {{page.version}}" | sudo tee -a /etc/apt/sources.list.d/foreman.list
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_ubuntu2204">
<p>
Enable Puppet's 7.x repository:
</p>

{% highlight bash %}
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-jammy.deb
sudo apt-get install /tmp/puppet7-release-jammy.deb
{% endhighlight %}

<p>Enable the Foreman repositories:</p>

{% highlight bash %}
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb http://deb.theforeman.org/ jammy {{page.version}}" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb http://deb.theforeman.org/ plugins {{page.version}}" | sudo tee -a /etc/apt/sources.list.d/foreman.list
{% endhighlight %}
</div>

#### Downloading the installer

<div class="quickstart_os quickstart_os_none">
<i>No operating system selected.</i>
</div>

<div class="quickstart_os quickstart_os_el8 quickstart_os_el9">
{% highlight bash %}
sudo dnf -y install foreman-installer
{% endhighlight %}
</div>

<div class="quickstart_os quickstart_os_debian11 quickstart_os_ubuntu2004 quickstart_os_ubuntu2204">
{% highlight bash %}
sudo apt-get update && sudo apt-get -y install foreman-installer
{% endhighlight %}
</div>

#### Running the installer

<div class="quickstart_os quickstart_os_debian11 quickstart_os_ubuntu2004 quickstart_os_ubuntu2204 alert alert-info">
Ensure that <code>ping $(hostname -f)</code> shows the real IP address, not 127.0.1.1. Change or remove this entry from /etc/hosts if present.
</div>

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](/manuals/{{page.version}}/index.html#3.2.2InstallerOptions) section. Adding `-v` will disable the progress bar and display all changes. To run the installer, execute:

<div class="quickstart_os quickstart_os_none quickstart_os_debian11 quickstart_os_ubuntu2004 quickstart_os_ubuntu2204 quickstart_os_el8 quickstart_os_el9">
{% highlight bash %}
sudo foreman-installer
{% endhighlight %}
</div>

After it completes, the installer will print some details about where to find Foreman and the Smart Proxy. Output should be similar to this:

{% highlight bash %}
* Foreman is running at https://theforeman.example.com
Initial credentials are admin / 3ekw5xtyXCoXxS29
* Foreman Proxy is running at https://theforeman.example.com:8443
The full log is at /var/log/foreman-installer/foreman-installer.log
{% endhighlight %}

#### Next-generation documentation

Over the last year, Foreman community members have been open-sourcing Red Hat documentation to make more comprehensive guides available to Foreman users. At the moment, the following guides have been migrated to a work-in-progress [Foreman and Katello documentation site](https://docs.theforeman.org). This project is not yet complete, but you might find useful information in some of the following guides:

* [Provisioning Guide](https://docs.theforeman.org/master/Provisioning_Guide/index-foreman.html)
* [Administering Foreman Guide](https://docs.theforeman.org/master/Administering_Red_Hat_Satellite/index-foreman.html)
* [Managing Hosts Guide](https://docs.theforeman.org/master/Managing_Hosts/index-foreman.html)
* [Content Management Guide](https://docs.theforeman.org/master/Content_Management_Guide/index-foreman.html)
* [Configuring Smart Proxies with a Load Balancer](https://docs.theforeman.org/master/Configuring_Load_Balancer/index-foreman.html)
Loading