Skip to content
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

Rework planning for foreman #3634

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
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
2 changes: 1 addition & 1 deletion guides/common/assembly_common-deployment-scenarios.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ include::modules/con_single-location-with-segregated-subnets.adoc[leveloffset=+1

include::modules/con_multiple-locations.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
include::modules/con_content-view-scenarios.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
include::modules/con_projectserver-with-multiple-manifests.adoc[leveloffset=+1]
endif::[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
include::modules/con_content-and-patch-management-with-project.adoc[]

ifdef::katello,satellite,orcharhino[]
include::modules/con_content-flow-in-project.adoc[leveloffset=+1]

include::modules/con_content-views-in-project.adoc[leveloffset=+1]
Expand All @@ -10,4 +9,3 @@ include::modules/con_lifecycle-environments-and-environment-paths.adoc[leveloffs
include::modules/con_content-types-in-project.adoc[leveloffset=+1]

include::modules/con_content-and-patch-management-with-project-additional-resources.adoc[leveloffset=+1]
endif::[]
17 changes: 17 additions & 0 deletions guides/common/assembly_provisioning-requirements.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
include::modules/con_provisioning-requirements.adoc[]

include::modules/con_pxe-booting.adoc[leveloffset=+1]

include::modules/con_pxe-sequence.adoc[leveloffset=+2]

include::modules/con_pxe-booting-requirements.adoc[leveloffset=+2]

include::modules/con_http-booting.adoc[leveloffset=+1]

include::modules/con_http-booting-requirements-with-managed-dhcp.adoc[leveloffset=+2]

include::modules/con_http-booting-requirements-with-unmanaged-dhcp.adoc[leveloffset=+2]

ifdef::foreman-el,katello,orcharhino[]
include::modules/con_secure-boot.adoc[leveloffset=+1]
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,3 @@
= Content and patch management with {ProjectName}

With {ProjectName}, you can provide content and apply patches to hosts systematically in all lifecycle stages.
ifndef::katello,satellite,orcharhino[]
These features are provided by the Katello plugin.
endif::[]
11 changes: 4 additions & 7 deletions guides/common/modules/con_content-flow-in-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ ifdef::satellite[]
custom Yum repositories,
endif::[]
ifndef::satellite[]
custom Deb and Yum repositories,
custom Deb and Yum repositories, PyPI,
endif::[]
Git repositories, Ansible collections, Docker Hub, SCAP repositories, or internal data stores of your organization.
Git repositories, Ansible collections, container registries, SCAP repositories, or internal data stores of your organization.
*{ProjectServer}*::
On your {ProjectServer}, you plan and manage the content lifecycle.
*{SmartProxyServers}*::
Expand All @@ -25,14 +25,11 @@ For example, you can establish a content source for each geographical location o
By assigning a host system to a {SmartProxyServer} or directly to your {ProjectServer}, you ensure the host receives the content they provide.
Hosts can be physical or virtual.

ifndef::satellite[]
include::snip_red-hat-images.adoc[]
endif::[]

// TODO: create image for upstream
image::common/system-architecture-satellite.png[Content flow in {ProjectName}]

.Additional resources
* See xref:Major-{Project}-Components_{context}[] for details.
ifdef::satellite[]
* See {ContentManagementDocURL}managing_red_hat_subscriptions_content-management[Managing {Team} subscriptions] in _{ContentManagementDocTitle}_ for information about Content Delivery Network (CDN).
* See {ContentManagementDocURL}Managing_Red_Hat_Subscriptions_content-management[Managing Red Hat subscriptions] in _{ContentManagementDocTitle}_ for information about Content Delivery Network (CDN).
endif::[]
1 change: 0 additions & 1 deletion guides/common/modules/con_content-views-in-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,5 @@ endif::[]
ifeval::["{context}" == "planning"]
[role="_additional-resources"]
.Additional resources

* For more information, see {ContentManagementDocURL}Managing_Content_Views_content-management[Managing content views] in _{ContentManagementDocTitle}_.
endif::[]
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="{project-context}-overview-and-concepts"]
= {Project} overview and concepts

{ProjectName} is a centralized tool for provisioning, remote management, and monitoring of multiple {EL} deployments.
{ProjectName} is a centralized tool for provisioning, content delivery, remote management, and monitoring of multiple {client-os} deployments.
With {Project}, you can deploy, configure, and maintain your systems across physical, virtual, and cloud environments.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ You can promote content along the environment path to the next lifecycle environ
When you promote a content view from one environment to the next environment in the application lifecycle, {Project} updates the repository and publishes the packages.
For example, if development ends on a particular version of an application, you can promote this version to the testing environment and start development on the next version.

ifndef::satellite[]
include::snip_red-hat-images.adoc[]
endif::[]

[[figu-An_Environment_Path_Containing_Four_Environments]]
// TODO: Create image for upstream
// TODO: if this works, then we can/should replace all "image::common/" macros with "immage::_file-name_"
.An environment path containing four environments

image::lifecycle-satellite.png[An environment path containing four environments]
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[id="technical-users-provided-and-required-by-{project-context}"]
= Technical users provided and required by {Project}

During the installation of {Project}, system accounts are created.
They are used to manage files and process ownership of the components integrated into {Project}.
The {Project} installation process automatically creates system accounts.
They manage files and process ownership of the components integrated into {Project}.
Some of these accounts have fixed UIDs and GIDs, while others take the next available UID and GID on the system instead.
To control the UIDs and GIDs assigned to accounts, you can define accounts before installing {Project}.
Because some of the accounts have hard-coded UIDs and GIDs, it is not possible to do this with all accounts created during {Project} installation.

The following table lists all the accounts created by {Project} during installation.
You can predefine accounts that have *Yes* in the *Flexible UID and GID* column with custom UID and GID before installing {Project}.

Do not change the home and shell directories of system accounts because they are requirements for {Project} to work correctly.
Do not change the home and shell directories of system accounts because they are requirements for {Project}.

Because of potential conflicts with local users that {Project} creates, you cannot use external identity providers for the system users of the {Project} base operating system.

Expand Down
25 changes: 2 additions & 23 deletions guides/doc-Planning_for_Project/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,13 @@ include::common/header.adoc[]

= {PlanningDocTitle}

// This guide is Katello specific, in particular the diagrams
ifdef::foreman-el,foreman-deb[]
include::common/modules/snip_guide-not-ready.adoc[]
endif::[]
ifndef::foreman-el,foreman-deb[]

ifdef::satellite[]
include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

include::common/modules/con_foreman-overview-and-concepts.adoc[]

ifdef::katello,satellite,orcharhino[]
include::common/assembly_content-and-patch-management-with-project.adoc[leveloffset=+1]

include::common/assembly_provisioning-management-with-project.adoc[leveloffset=+1]
Expand All @@ -35,23 +30,7 @@ include::common/assembly_deployment-path.adoc[leveloffset=+1]

include::common/assembly_common-deployment-scenarios.adoc[leveloffset=+1]

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

include::common/modules/con_pxe-booting.adoc[leveloffset=+2]

include::common/modules/con_pxe-sequence.adoc[leveloffset=+3]

include::common/modules/con_pxe-booting-requirements.adoc[leveloffset=+3]

include::common/modules/con_http-booting.adoc[leveloffset=+2]

include::common/modules/con_http-booting-requirements-with-managed-dhcp.adoc[leveloffset=+3]

include::common/modules/con_http-booting-requirements-with-unmanaged-dhcp.adoc[leveloffset=+3]

ifdef::foreman-el,katello,orcharhino[]
include::common/modules/con_secure-boot.adoc[leveloffset=+2]
endif::[]
include::common/assembly_provisioning-requirements.adoc[leveloffset=+1]

:!numbered:

Expand Down