diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 6c6e6c0b4f5..2f35fafe1f2 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -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 diff --git a/Makefile b/Makefile index 27759cd98d4..fac82f82289 100644 --- a/Makefile +++ b/Makefile @@ -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=$* diff --git a/README.md b/README.md index 429f29d307d..65631e4a81b 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/guides/common/attributes-foremanctl-katello.adoc b/guides/common/attributes-foremanctl-katello.adoc new file mode 100644 index 00000000000..2729aa34a21 --- /dev/null +++ b/guides/common/attributes-foremanctl-katello.adoc @@ -0,0 +1 @@ +include::attributes-katello.adoc[] diff --git a/guides/common/attributes-foremanctl-orcharhino.adoc b/guides/common/attributes-foremanctl-orcharhino.adoc new file mode 100644 index 00000000000..177eed8137a --- /dev/null +++ b/guides/common/attributes-foremanctl-orcharhino.adoc @@ -0,0 +1 @@ +include::attributes-orcharhino.adoc[] diff --git a/guides/common/attributes-foremanctl-satellite.adoc b/guides/common/attributes-foremanctl-satellite.adoc new file mode 100644 index 00000000000..e666af2f3c1 --- /dev/null +++ b/guides/common/attributes-foremanctl-satellite.adoc @@ -0,0 +1 @@ +include::attributes-satellite.adoc[] diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc index e5d595adb3e..4d9acb60925 100644 --- a/guides/common/attributes-titles.adoc +++ b/guides/common/attributes-titles.adoc @@ -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} @@ -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 @@ -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::[] diff --git a/guides/common/attributes.adoc b/guides/common/attributes.adoc index 606eb4f25a5..f0d9bc9171b 100644 --- a/guides/common/attributes.adoc +++ b/guides/common/attributes.adoc @@ -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) @@ -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::[] diff --git a/guides/common/modules/proc_running-project-deployment-utility.adoc b/guides/common/modules/proc_running-project-deployment-utility.adoc index 042563791f1..def5a675f22 100644 --- a/guides/common/modules/proc_running-project-deployment-utility.adoc +++ b/guides/common/modules/proc_running-project-deployment-utility.adoc @@ -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"] @@ -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"] @@ -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::[] diff --git a/guides/common/modules/ref_system-requirements-quickstart.adoc b/guides/common/modules/ref_system-requirements-quickstart.adoc index 21571e1f267..140d12efcc0 100644 --- a/guides/common/modules/ref_system-requirements-quickstart.adoc +++ b/guides/common/modules/ref_system-requirements-quickstart.adoc @@ -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}: @@ -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::[] @@ -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::[] diff --git a/guides/common/modules/snip_configuring-repositories-el.adoc b/guides/common/modules/snip_configuring-repositories-el.adoc index 322ea06c33d..93435604524 100644 --- a/guides/common/modules/snip_configuring-repositories-el.adoc +++ b/guides/common/modules/snip_configuring-repositories-el.adoc @@ -1,8 +1,3 @@ -ifdef::foremanctl[] -[tabs] -==== -Puppet-based installation:: -endif::[] . Clear any metadata: + [options="nowrap" subs="+quotes,attributes"] @@ -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::[] diff --git a/guides/common/modules/snip_configuring-repositories-foremanctl-katello.adoc b/guides/common/modules/snip_configuring-repositories-foremanctl-katello.adoc new file mode 100644 index 00000000000..ae1e80845bf --- /dev/null +++ b/guides/common/modules/snip_configuring-repositories-foremanctl-katello.adoc @@ -0,0 +1,6 @@ +* Enable the required repositories: ++ +[options="nowrap" subs="+quotes,attributes"] +---- +# dnf copr enable @theforeman/foremanctl rhel-9-x86_64 +---- diff --git a/guides/common/modules/snip_configuring-repositories-foremanctl-orcharhino.adoc b/guides/common/modules/snip_configuring-repositories-foremanctl-orcharhino.adoc new file mode 100644 index 00000000000..ae1e80845bf --- /dev/null +++ b/guides/common/modules/snip_configuring-repositories-foremanctl-orcharhino.adoc @@ -0,0 +1,6 @@ +* Enable the required repositories: ++ +[options="nowrap" subs="+quotes,attributes"] +---- +# dnf copr enable @theforeman/foremanctl rhel-9-x86_64 +---- diff --git a/guides/common/modules/snip_configuring-repositories-foremanctl-satellite.adoc b/guides/common/modules/snip_configuring-repositories-foremanctl-satellite.adoc new file mode 100644 index 00000000000..ae1e80845bf --- /dev/null +++ b/guides/common/modules/snip_configuring-repositories-foremanctl-satellite.adoc @@ -0,0 +1,6 @@ +* Enable the required repositories: ++ +[options="nowrap" subs="+quotes,attributes"] +---- +# dnf copr enable @theforeman/foremanctl rhel-9-x86_64 +---- diff --git a/guides/doc-Installing_Server/master.adoc b/guides/doc-Installing_Server/master.adoc index 258a526ca08..ae32eeedc14 100644 --- a/guides/doc-Installing_Server/master.adoc +++ b/guides/doc-Installing_Server/master.adoc @@ -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] @@ -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] @@ -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[] diff --git a/guides/doc-Installing_Server_foremanctl/Makefile b/guides/doc-Installing_Server_foremanctl/Makefile deleted file mode 100644 index dd1e5be8557..00000000000 --- a/guides/doc-Installing_Server_foremanctl/Makefile +++ /dev/null @@ -1 +0,0 @@ -include ../common/Makefile diff --git a/guides/doc-Installing_Server_foremanctl/common b/guides/doc-Installing_Server_foremanctl/common deleted file mode 120000 index 60d3b0a6a8f..00000000000 --- a/guides/doc-Installing_Server_foremanctl/common +++ /dev/null @@ -1 +0,0 @@ -../common \ No newline at end of file diff --git a/guides/doc-Installing_Server_foremanctl/docinfo.xml b/guides/doc-Installing_Server_foremanctl/docinfo.xml deleted file mode 100644 index 4f4a988cbf6..00000000000 --- a/guides/doc-Installing_Server_foremanctl/docinfo.xml +++ /dev/null @@ -1,15 +0,0 @@ -{InstallingServerCTLDocTitle} -Red Hat Satellite -{ProjectVersion} -Install and configure Satellite Server in a network with Internet access - - This guide describes how to install Red Hat Satellite from a connected network, perform initial configuration, and configure external services. - - - - Red Hat Satellite - Documentation Team - satellite-doc-list@redhat.com - - - diff --git a/guides/doc-Installing_Server_foremanctl/images/common b/guides/doc-Installing_Server_foremanctl/images/common deleted file mode 120000 index ac7700aa2af..00000000000 --- a/guides/doc-Installing_Server_foremanctl/images/common +++ /dev/null @@ -1 +0,0 @@ -../common/images/ \ No newline at end of file diff --git a/guides/doc-Installing_Server_foremanctl/master.adoc b/guides/doc-Installing_Server_foremanctl/master.adoc deleted file mode 100644 index a96472c2531..00000000000 --- a/guides/doc-Installing_Server_foremanctl/master.adoc +++ /dev/null @@ -1,18 +0,0 @@ -include::common/attributes.adoc[] -include::common/header.adoc[] -:installing-satellite-server-connected: -:context: {project-context} -:mode: connected -:ProductName: {ProjectServer} -:installer-foremanctl: - -= {InstallingServerCTLDocTitle} - -== Technology preview - -:FeatureName: The `foremanctl` installer -include::common/modules/snip_technology-preview.adoc[] - -ifndef::orcharhino,satellite[] -include::common/ribbons.adoc[] -endif::[] diff --git a/guides/doc-Quickstart/master.adoc b/guides/doc-Quickstart/master.adoc index 09dfbf1ad6b..c810bd05ecc 100644 --- a/guides/doc-Quickstart/master.adoc +++ b/guides/doc-Quickstart/master.adoc @@ -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] diff --git a/guides/doc-Upgrading_Project/master.adoc b/guides/doc-Upgrading_Project/master.adoc index 1d7e7f51951..d6b447adcbb 100644 --- a/guides/doc-Upgrading_Project/master.adoc +++ b/guides/doc-Upgrading_Project/master.adoc @@ -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] ==== @@ -47,6 +55,7 @@ endif::[] [appendix] include::common/modules/proc_troubleshooting-permission-issues.adoc[leveloffset=+1] +endif::[] ifndef::orcharhino,satellite[] include::common/ribbons.adoc[] diff --git a/guides/scripts/find_unused_modules b/guides/scripts/find_unused_modules index 41c99fee3fd..a78b30c8ce6 100755 --- a/guides/scripts/find_unused_modules +++ b/guides/scripts/find_unused_modules @@ -7,6 +7,9 @@ require 'asciidoctor' BUILDS = %w[ foreman-el foreman-deb + foremanctl-katello + foremanctl-orcharhino + foremanctl-satellite katello satellite orcharhino diff --git a/web/content/index.adoc.erb b/web/content/index.adoc.erb index 324ce41b197..8023ad95050 100644 --- a/web/content/index.adoc.erb +++ b/web/content/index.adoc.erb @@ -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: diff --git a/web/releases/nightly.json b/web/releases/nightly.json index 38bdda046f9..d58ec7a86ca 100644 --- a/web/releases/nightly.json +++ b/web/releases/nightly.json @@ -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": [ + ] + } } ] }