Skip to content
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
3 changes: 3 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ jobs:
make clean
make -j ${{ env.MAKE_J }} html BUILD=foreman-el
make -j ${{ env.MAKE_J }} html BUILD=foreman-deb
make -j ${{ env.MAKE_J }} html BUILD=foremanctl-katello
make -j ${{ env.MAKE_J }} html BUILD=foremanctl-orcharhino
make -j ${{ env.MAKE_J }} html BUILD=foremanctl-satellite
make -j ${{ env.MAKE_J }} html BUILD=katello
make -j ${{ env.MAKE_J }} html BUILD=satellite
make -j ${{ env.MAKE_J }} html BUILD=orcharhino
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-foremanctl-katello build-foremanctl-orcharhino build-foremanctl-satellite build-katello build-orcharhino build-satellite

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`, `foremanctl-katello`, `foremanctl-orcharhino`, `foremanctl-satellite`, `katello`, `orcharhino`, and `satellite`)
* `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
1 change: 1 addition & 0 deletions guides/common/attributes-foremanctl-katello.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-foremanctl-orcharhino.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-foremanctl-satellite.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include::attributes-satellite.adoc[]
22 changes: 18 additions & 4 deletions guides/common/attributes-titles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
:HammerDocTitle: Using the Hammer CLI tool
:HammerRefDocTitle: Hammer reference
:InstallingServerDocTitle: Installing {ProjectServerTitle} {ProjectVersion} on {install-on-os}
:InstallingServerCTLDocTitle: Installing {ProjectServerTitle} {ProjectVersion} on {install-on-os} by using foremanctl
// Installing Disconnected - defined for Satellite only
:InstallingServerDisconnectedDocTitle: Installing {ProjectServerTitle} in a disconnected network environment
:InstallingSmartProxyDocTitle: Installing a {SmartProxy}{nbsp}Server {ProjectVersion} on {install-on-os}
Expand All @@ -40,13 +39,11 @@

ifdef::katello[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} with Katello {KatelloVersion} plugin on {install-on-os}
:InstallingServerCTLDocTitle: Installing {ProjectServerTitle} with Katello {KatelloVersion} plugin on {install-on-os} by using foremanctl
:QuickstartDocTitle: Quickstart guide for {Project} with Katello on {install-on-os}
endif::[]

ifdef::satellite[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} in a connected network environment
:InstallingServerCTLDocTitle: Installing {ProjectServerTitle} in a connected network environment by using foremanctl
:InstallingSmartProxyDocTitle: Installing Capsule Server
:ManagingConfigurationsAnsibleDocTitle: Managing configurations by using Ansible integration
:ManagingConfigurationsPuppetDocTitle: Managing configurations by using Puppet integration
Expand All @@ -58,7 +55,24 @@ endif::[]

ifdef::orcharhino[]
:InstallingServerDocTitle: Installing {ProjectServerTitle}
:InstallingServerCTLDocTitle: Installing {ProjectServerTitle} by using foremanctl
:InstallingSmartProxyDocTitle: Installing {SmartProxyServer}
:QuickstartDocTitle: Quickstart
endif::[]

// Overrides for foremanctl (containerized) builds
ifdef::foremanctl[]
:UpgradingDocTitle: Upgrading {ProjectName} to {ProjectVersion} (containerized)
ifdef::katello[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} with Katello {KatelloVersion} plugin (containerized) on {install-on-os}
:QuickstartDocTitle: Quickstart guide for {Project} with Katello (containerized) on {install-on-os}
endif::[]
ifdef::satellite[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} (containerized) in a connected network environment
:QuickstartDocTitle: Quickstart (containerized)
:UpgradingDocTitle: Upgrading connected {ProjectName} to {ProjectVersion} (containerized)
endif::[]
ifdef::orcharhino[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} (containerized)
:QuickstartDocTitle: Quickstart (containerized)
endif::[]
endif::[]
15 changes: 15 additions & 0 deletions guides/common/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
// Attribute files for SPECIFIC PRODUCTS:
// * attributes-foreman-el.adoc (attributes overridden or unique to Red Hat Enterprise Linux and clones)
// * attributes-foreman-deb.adoc (attributes overridden or unique to Debian/Ubuntu)
// * attributes-foremanctl-katello.adoc (attributes overridden or unique to foremanctl-katello build)
// * attributes-foremanctl-orcharhino.adoc (attributes overridden or unique to foremanctl-orcharhino build)
// * attributes-foremanctl-satellite.adoc (attributes overridden or unique to foremanctl-satellite build)
// * 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)
Expand All @@ -37,6 +40,18 @@ ifeval::["{build}" == "foreman-deb"]
:foreman-deb:
:foreman:
endif::[]
ifeval::["{build}" == "foremanctl-katello"]
:foremanctl:
:katello:
endif::[]
ifeval::["{build}" == "foremanctl-orcharhino"]
:foremanctl:
:orcharhino:
endif::[]
ifeval::["{build}" == "foremanctl-satellite"]
:foremanctl:
:satellite:
endif::[]
ifeval::["{build}" == "katello"]
:katello:
endif::[]
Expand Down
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::[]
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::[]
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 @@ -33,14 +28,3 @@ ifdef::foreman-el,katello[]
# {package-install} https://yum.puppet.com/puppet8-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
----
10 changes: 9 additions & 1 deletion guides/doc-Installing_Server/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ include::common/header.adoc[]

= {InstallingServerDocTitle}

ifndef::orcharhino,satellite[]
ifdef::foremanctl[]
:FeatureName: The `foremanctl` deployment utility
include::common/modules/snip_technology-preview.adoc[]
endif::[]
endif::[]

// This guide is not ready for stable releases
ifdef::HideDocumentOnStable[]
include::common/modules/con_guide-not-ready.adoc[leveloffset=+1]
Expand All @@ -21,6 +28,7 @@ ifdef::satellite[]
include::common/modules/con_red-hat-helper-app.adoc[leveloffset=+1]
endif::[]

ifndef::foremanctl[]
include::common/assembly_planning-project-server-installation.adoc[leveloffset=+1]

include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1]
Expand Down Expand Up @@ -73,7 +81,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
1 change: 0 additions & 1 deletion guides/doc-Installing_Server_foremanctl/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion guides/doc-Installing_Server_foremanctl/common

This file was deleted.

15 changes: 0 additions & 15 deletions guides/doc-Installing_Server_foremanctl/docinfo.xml

This file was deleted.

1 change: 0 additions & 1 deletion guides/doc-Installing_Server_foremanctl/images/common

This file was deleted.

18 changes: 0 additions & 18 deletions guides/doc-Installing_Server_foremanctl/master.adoc

This file was deleted.

11 changes: 3 additions & 8 deletions guides/doc-Quickstart/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,18 @@ 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.

ifndef::orcharhino,satellite[]
ifdef::foremanctl[]
:FeatureName: The `foremanctl` deployment utility
include::common/modules/snip_technology-preview.adoc[]
endif::[]
endif::[]

include::common/modules/ref_system-requirements-quickstart.adoc[leveloffset=+1]

Expand Down
9 changes: 9 additions & 0 deletions guides/doc-Upgrading_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,18 @@ include::common/header.adoc[]

= {UpgradingDocTitle}

ifndef::orcharhino,satellite[]
ifdef::foremanctl[]
:FeatureName: The `foremanctl` deployment utility
include::common/modules/snip_technology-preview.adoc[]
endif::[]
endif::[]

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 +55,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 guides/scripts/find_unused_modules
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ require 'asciidoctor'
BUILDS = %w[
foreman-el
foreman-deb
foremanctl-katello
foremanctl-orcharhino
foremanctl-satellite
katello
satellite
orcharhino
Expand Down
1 change: 1 addition & 0 deletions web/content/index.adoc.erb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ 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-foremanctl-katello.html[Foreman with Katello (containerized)]

<% if (release = releases_in_state('RC').first) %>
A release candidate is available for testing:
Expand Down
22 changes: 22 additions & 0 deletions web/releases/nightly.json
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,28 @@
["Hammer_Reference", "Hammer reference"]
]
}
},
{
"title": "Foreman with Katello (containerized)",
"header": "Foreman {FOREMAN_VER} and Katello {KATELLO_VER} (containerized)",
"filename": "index-foremanctl-katello.html",
"sections": {
"Release notes and upgrading": [
["Upgrading_Project", "Upgrading Foreman to {FOREMAN_VER}"]
],
"Quickstart": [
["Quickstart", "Quickstart guide"]
],
"Deploying Foreman": [
["Installing_Server", "Installing Foreman Server"]
],
"Administering Foreman server": [
],
"Administering hosts": [
],
"Reference": [
]
}
}
]
}
Loading