-
Notifications
You must be signed in to change notification settings - Fork 106
Initial content for the foremanctl installer guide #4087
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
Draft
aneta-petrova
wants to merge
9
commits into
theforeman:master
Choose a base branch
from
aneta-petrova:installing-foremanctl
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−12
Draft
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
93c966c
Initial commit for the foremanctl installer guide
aneta-petrova 3fe2a55
Exclude AWS prerequisites for the new installer guide
aneta-petrova e64eccf
Update ext user account prerequisite for the new installer
aneta-petrova b3bba68
Move TP snippet
aneta-petrova 4a9ddcf
Exclude content not available with foremanctl
aneta-petrova d7a20f8
Simplify foremanctl attribute
aneta-petrova eae8016
Add user stories based on the current installation guide
aneta-petrova 3616805
Start drafting structure
aneta-petrova 969a3b6
Add an insights story
aneta-petrova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| [id="customizing-the-installation"] | ||
| = Customizing the installation | ||
|
|
||
| * Overview of common options | ||
|
|
||
| #As an administrator, I want to leverage {Insights} to diagnose my {ProjectServer}. | ||
|
|
||
| #As an administrator, I want to leverage {Insights} to diagnose my {Project} hosts; I can register my {Project} Server with {Insights} directly so that it sends data to Red Hat services.# | ||
|
|
||
| #As an administrator, I want to leverage {Insights} to diagnose my {Project} hosts; I want to avoid sending system data to Red Hat services.# | ||
|
|
||
| #As an administrator, I want to configure my {ProjectServer} for pull-based remote execution to be able to manage my hosts remotely without enabling outgoing connections from the server to the hosts.# | ||
|
|
||
| #As an administrator, I want to configure my {ProjectServer} to provision hosts in an IPv6 network with UEFI HTTP Boot provisioning.# | ||
|
|
||
| #As an administrator, I want to configure my {ProjectServer} with an HTTP proxy that will handle requests to the content source, such as Red Hat CDN, so that the server can remain behind a firewall.# | ||
|
|
||
| #As an administrator, I want to enable the baseboard management controller (BMC) module on my {ProjectServer} so that I can perform power management tasks on hosts using the intelligent platform management interface (IPMI) or a similar protocol.# | ||
|
|
||
| #As an administrator, I want to configure the server for outgoing emails so that the server can send email notifications to users.# | ||
|
|
||
| #As an administrator, I want to integrate my {ProjectServer} with an {FreeIPA} realm so that {Project} can automatically manage the lifecycle of the systems enrolled in the {FreeIPA} domain.# | ||
|
|
||
| #As an administrator, I want to configure an alternate CNAME for {Project} so that I can deploy the {Project} web interface on a different domain name than the one that is used by hosts to connect to {Project}.# | ||
|
|
||
| #As an administrator, I want to configure my {ProjectServer} with a custom SSL certificate to ensure encrypted communications between the server and all hosts in a deployment where I cannot or do not want to use {Project}'s default self-signed certificate. (Includes substory: I want to be able to switch back to using {Project}'s default self-signed certificate.)# |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| include::modules/con_installing-project-server.adoc[] | ||
|
|
||
| include::modules/con_overview-of-the-installation-process.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/proc_basic-initial-configuration.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/proc_examining-the-installation-logs.adoc[leveloffset=+1] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| [id="installing-{project-context}-server"] | ||
| = Installing {ProjectServer} | ||
|
|
||
| Basic installation scenarios only. Purpose: Explain `foremanctl`, show basic procedures, explain how to troubleshoot. |
7 changes: 7 additions & 0 deletions
7
guides/common/modules/con_overview-of-the-installation-process.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [id="overview-of-the-installation-process"] | ||
| = Overview of the installation process | ||
|
|
||
| * We use `foremanctl`, which can install and perform additional configuration after installation | ||
| * You can install a basic server and then add additional config, or you can do everything in one step | ||
|
|
||
| #As an administrator, I want to leverage tuning profiles to ensure my deployment is tailored to the number of hosts I'll deploy so that I prevent performance issues.# |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
guides/common/modules/proc_basic-initial-configuration.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| [id="basic-initial-configuration"] | ||
| = Basic initial configuration | ||
|
|
||
| * Scenario with default database | ||
| * Scenario with external database | ||
|
|
||
| #As an administrator, I want to install a {ProjectServer} with the default local (internal) database so that I can keep the installation process simple; I don't need the option to fine-tune the database.# | ||
|
|
||
| #As an administrator, I want to install a {ProjectServer} with an external PostgreSQL database (with or without encrypted connections) to help with the server load and gain more flexibility in tuning the database.# | ||
|
|
||
| .Next steps | ||
| * Feel free to extend and customize. | ||
| See xref:customizing-the-installation[]. |
7 changes: 7 additions & 0 deletions
7
guides/common/modules/proc_examining-the-installation-logs.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| [id="examining-the-installation-logs"] | ||
| == Examining the logs | ||
|
|
||
| * How to troubleshoot if the installation goes wrong | ||
| * List of common problems | ||
|
|
||
| #As an administrator, I want to leverage installation logs so that I can review the installation process or troubleshoot failures.# |
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.