Skip to content

Commit 1fd9e7b

Browse files
committed
Add foremanctl install and use tabs to do it
1 parent ff78826 commit 1fd9e7b

File tree

5 files changed

+76
-2
lines changed

5 files changed

+76
-2
lines changed

guides/common/modules/proc_configuring-repositories-el.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[tabs]
2+
====
3+
`{foreman-installer}`::
14
. Clear any metadata:
25
+
36
[options="nowrap" subs="+quotes,attributes"]
@@ -35,3 +38,12 @@ ifdef::foreman-el,katello[]
3538
# {package-install} https://yum.puppet.com/puppet7-release-el-{distribution-major-version}.noarch.rpm
3639
----
3740
endif::[]
41+
42+
`foremanctl` installer::
43+
* Enable the required repositories:
44+
+
45+
[options="nowrap" subs="+quotes,attributes"]
46+
----
47+
# dnf copr enable @theforeman/foremanctl rhel-9-x86_64
48+
----
49+
====

guides/common/modules/proc_installing-project-server-packages.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
= Installing {ProjectServer} packages
55

66
.Procedure
7+
ifdef::foremanctl[]
8+
[tabs]
9+
====
10+
`{foreman-installer}`::
11+
endif::[]
712
ifdef::foreman-deb[]
813
. Update package lists:
914
+
@@ -24,3 +29,13 @@ endif::[]
2429
----
2530
# {package-install} {project-installer-package}
2631
----
32+
ifdef::foremanctl[]
33+
`foremanctl` installer::
34+
* Install the `foremanctl` package:
35+
+
36+
[options="nowrap" subs="+quotes,attributes"]
37+
----
38+
# dnf install foremanctl
39+
----
40+
====
41+
endif::[]

guides/common/modules/proc_running-installer.adoc

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
[id="running-the-{project-context}-installer_{context}"]
44
= Running the {Project} installer
55

6-
The Foreman installer is a collection of Puppet modules that installs {Project} based on native operating system packages.
7-
6+
The {foreman-installer} installer is a collection of Puppet modules that installs {Project} based on native operating system packages.
87
The installation run is non-interactive by default.
98
The script displays its progress and writes logs to `{installer-log-file}`.
109

10+
The `foremanctl` provides a containerized installation.
11+
1112
.Procedure
13+
[tabs]
14+
====
15+
`{foreman-installer}`::
1216
* Run the {Project} installer:
1317
+
1418
[options="nowrap" subs="+quotes,attributes"]
@@ -17,3 +21,20 @@ The script displays its progress and writes logs to `{installer-log-file}`.
1721
----
1822
+
1923
For a list of the available customization options, run `{foreman-installer} --help` or `{foreman-installer} --full-help`.
24+
25+
`foremanctl` installer::
26+
. Optional: Run a pre-install check:
27+
+
28+
[options="nowrap" subs="+quotes,attributes"]
29+
----
30+
# foremanctl checks
31+
----
32+
. Run the installer:
33+
+
34+
[options="nowrap" subs="+quotes,attributes"]
35+
----
36+
# foremanctl deploy
37+
----
38+
+
39+
The `TASK [post_install : Admin credentials]` displays information on how to access your {ProjectServer}.
40+
====

guides/common/modules/ref_system-requirements-quickstart.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
[id="system-requirements"]
44
= System requirements
55

6+
[tabs]
7+
====
8+
`{foreman-installer}`::
69
// The requirements in this section must match the full requirements in the installation guide.
710
The following list shows the most critical requirements common for most scenarios.
811
For a full list, see {InstallingServerDocURL}[_{InstallingServerDocTitle}_].
@@ -26,3 +29,25 @@ ifdef::foreman-el,katello,orcharhino[]
2629
endif::[]
2730
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
2831
* Ensure the system has at least {project-minimum-memory} of memory.
32+
33+
`foremanctl` installer::
34+
ifdef::foreman-deb[]
35+
* The following operating systems are supported for deploying {Project}:
36+
endif::[]
37+
ifndef::foreman-deb[]
38+
* The following operating system is supported for deploying {Project}:
39+
endif::[]
40+
+
41+
ifndef::foreman-deb[]
42+
** {EL} 9 (x86_64)
43+
endif::[]
44+
ifdef::foreman-deb[]
45+
** Debian 12 (Bookworm) (amd64)
46+
** Ubuntu 22.04 (Jammy) (amd64)
47+
endif::[]
48+
ifdef::foreman-el,katello,orcharhino[]
49+
* Installing {Project} on a system with Extra Packages for Enterprise Linux (EPEL) is not supported.
50+
endif::[]
51+
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
52+
* Ensure the system has at least {project-minimum-memory} of memory.
53+
====

guides/doc-Quickstart/master.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ include::common/header.adoc[]
44
:context: quick-start
55
:mode: connected
66
:ProductName: {ProjectServer}
7+
:foremanctl:
78

89
= {QuickstartDocTitle}
910

0 commit comments

Comments
 (0)