Skip to content

Commit 317d0d5

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

File tree

4 files changed

+91
-9
lines changed

4 files changed

+91
-9
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+
Puppet-based installation::
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+
Containerized installation::
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_running-installer.adoc

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,58 @@
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-
8-
The installation run is non-interactive by default.
9-
The script displays its progress and writes logs to `{installer-log-file}`.
6+
Install the required packages and run the {Project} installer utility.
107

118
.Procedure
12-
* Run the {Project} installer:
9+
[tabs]
10+
====
11+
Puppet-based installation::
12+
. Install {ProjectServer} packages:
13+
.. Upgrade all packages:
14+
+
15+
[options="nowrap" subs="+quotes,attributes"]
16+
----
17+
# {package-upgrade}
18+
----
19+
.. Install {project-installer-package}:
20+
+
21+
[options="nowrap" subs="+quotes,attributes"]
22+
----
23+
# {package-install} {project-installer-package}
24+
----
25+
. Run the {Project} installer:
1326
+
1427
[options="nowrap" subs="+quotes,attributes"]
1528
----
1629
# {installer-scenario}
1730
----
1831
+
32+
The {foreman-installer} installer is a collection of Puppet modules that installs {Project} based on native operating system packages.
33+
+
34+
The installation run is non-interactive by default.
35+
The script displays its progress and writes logs to `{installer-log-file}`.
36+
+
1937
For a list of the available customization options, run `{foreman-installer} --help` or `{foreman-installer} --full-help`.
38+
39+
Containerized installation::
40+
. Install the `foremanctl` package:
41+
+
42+
[options="nowrap" subs="+quotes,attributes"]
43+
----
44+
# dnf install foremanctl
45+
----
46+
. Optional: Run a pre-install check:
47+
+
48+
[options="nowrap" subs="+quotes,attributes"]
49+
----
50+
# foremanctl checks
51+
----
52+
. Run the installer:
53+
+
54+
[options="nowrap" subs="+quotes,attributes"]
55+
----
56+
# foremanctl deploy
57+
----
58+
+
59+
You can find credentials to access your {ProjectServer} in the message shown in the `TASK [post_install : Admin credentials]` task results.
60+
====

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

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,33 @@
33
[id="system-requirements"]
44
= System requirements
55

6-
// The requirements in this section must match the full requirements in the installation guide.
76
The following list shows the most critical requirements common for most scenarios.
8-
For a full list, see {InstallingServerDocURL}[_{InstallingServerDocTitle}_].
97

8+
[tabs]
9+
====
10+
Puppet-based installation::
11+
// The requirements in this section must match the full requirements in the installation guide.
12+
ifdef::foreman-deb[]
13+
* The following operating systems are supported for deploying {Project}:
14+
endif::[]
15+
ifndef::foreman-deb[]
16+
* The following operating system is supported for deploying {Project}:
17+
endif::[]
18+
+
19+
ifndef::foreman-deb[]
20+
** {EL} 9 (x86_64)
21+
endif::[]
22+
ifdef::foreman-deb[]
23+
** Debian 12 (Bookworm) (amd64)
24+
** Ubuntu 22.04 (Jammy) (amd64)
25+
endif::[]
26+
ifdef::foreman-el,katello,orcharhino[]
27+
* Installing {Project} on a system with Extra Packages for Enterprise Linux (EPEL) is not supported.
28+
endif::[]
29+
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
30+
* Ensure the system has at least {project-minimum-memory} of memory.
31+
32+
Containerized installation::
1033
ifdef::foreman-deb[]
1134
* The following operating systems are supported for deploying {Project}:
1235
endif::[]
@@ -26,3 +49,4 @@ ifdef::foreman-el,katello,orcharhino[]
2649
endif::[]
2750
* Install {ProductName} on a freshly provisioned system that serves no other function except to run {ProductName}.
2851
* Ensure the system has at least {project-minimum-memory} of memory.
52+
====

guides/doc-Quickstart/master.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,25 @@ include::common/header.adoc[]
44
:context: quick-start
55
:mode: connected
66
:ProductName: {ProjectServer}
7+
:foremanctl:
8+
:tabs-sync-option:
79

810
= {QuickstartDocTitle}
911

1012
This guide describes the quickest way to get a {ProjectServer} up and running.
13+
You can choose between a Puppet-based installation and containerized installation.
1114
For a full installation guide, see {InstallingServerDocURL}[_{InstallingServerDocTitle}_].
15+
The full installation guide is currently provided only for the Puppet-based installation.
16+
17+
:FeatureName: The `foremanctl` installer
18+
include::common/modules/snip_technology-preview.adoc[]
1219

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

1522
include::common/modules/con_configuring-repositories.adoc[leveloffset=+1]
1623

1724
include::common/modules/proc_configuring-repositories-{build}.adoc[leveloffset=+1]
1825

19-
include::common/modules/proc_installing-project-server-packages.adoc[leveloffset=+1]
20-
2126
include::common/modules/proc_running-installer.adoc[leveloffset=+1]
2227

2328
ifndef::orcharhino,satellite[]

0 commit comments

Comments
 (0)