Skip to content

Commit

Permalink
Make Planning guide fit for all flavours
Browse files Browse the repository at this point in the history
* Add images for upstream
  $ git diff master| rg "image::" | rg -v "^@@" | rg -v -- "^-" | cut -c 2- | sed "s@image::common/@guides/common/images/@g" | sed "s/\[.*$//g"
* Add xref for ULN content
* Hide content for foreman-el+deb
* Make images not executable
  $ chmod -x guides/common/images/*
* Render Planning for Foreman for all flavours
  $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "assembly_"
* Reword "on the other hand" to make Vale happy
* Reword concepts included in Planning guide
  $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "modules/"
* Split file
* Use assembly to bundle provisioning requirements
* Verify content in Planning guide for all flavours
  $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "assembly_" | xargs -I {} cat "{}" | rg "^include" | sed "s/include::/guides\/common\//g" | sed "s/\[.*$//g"
  • Loading branch information
maximiliankolb committed Feb 6, 2025
1 parent 9a795c2 commit 4492d57
Show file tree
Hide file tree
Showing 83 changed files with 1,325 additions and 206 deletions.
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::[]
4 changes: 2 additions & 2 deletions guides/common/assembly_deployment-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::modules/con_configuring-project-server-with-external-database.adoc[leve

include::modules/con_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2]

include::modules/ref_overview-of-authentication-methods-in-project.adoc[leveloffset=+1]
include::modules/ref_configuring-external-authentication-in-foreman.adoc[leveloffset=+1]

include::modules/con_planning-organization-and-location-context.adoc[leveloffset=+1]

Expand All @@ -20,7 +20,7 @@ include::modules/con_defining-your-content-library.adoc[leveloffset=+1]
include::modules/con_defining-content-access-strategies-for-hosts.adoc[leveloffset=+1]
endif::[]

include::modules/con_creating-and-managing-roles.adoc[leveloffset=+1]
include::modules/con_defining-role-based-access-control-policies.adoc[leveloffset=+1]

include::modules/con_best-practices-for-role-based-access-control-in-project.adoc[leveloffset=+2]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/assembly_major-project-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include::modules/con_smartproxy-overview.adoc[leveloffset=+1]

include::modules/con_overview-of-hosts-in-project.adoc[leveloffset=+1]

include::modules/ref_list-of-key-open-source-components-of-foreman-server.adoc[leveloffset=+1]
include::modules/ref_list-of-key-open-source-components-of-foreman.adoc[leveloffset=+1]

include::modules/con_smartproxy-features.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ include::modules/con_organizations-and-locations-in-project.adoc[leveloffset=+1]

include::modules/con_host-groups-overview.adoc[leveloffset=+1]

ifdef::katello,orcharhino,satellite[]
include::modules/con_host-collections-overview.adoc[leveloffset=+1]
endif::[]

include::modules/ref_additional-resources-project-infrastructure-organization-concepts.adoc[leveloffset=+1]
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 @@ -10,4 +10,6 @@ include::modules/con_remote-execution-in-project.adoc[leveloffset=+1]

include::modules/con_managing-foreman-with-ansible.adoc[leveloffset=+1]

ifndef::foreman-deb,orcharhino[]
include::modules/con_kickstart-workflow.adoc[leveloffset=+1]
endif::[]
Empty file modified guides/common/images/aws-combined-direct-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified guides/common/images/aws-combined-vpn-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified guides/common/images/aws-multi-region-direct-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified guides/common/images/aws-multi-region-vpn-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified guides/common/images/aws-single-region-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/host-group-structures.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/lifecycle-path-basic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/lifecycle-path-diverged.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/lifecycle-path-simple.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/lifecycle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
3 changes: 3 additions & 0 deletions guides/common/images/server-multiple-manifests.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified guides/common/images/system-architecture-satellite.png
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions guides/common/images/system-architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,6 @@ Deleting a subscription manifest removes all the subscriptions attached to runni

.Additional resources
* For instructions about creating and importing a Red{nbsp}Hat subscription manifest, see {ContentManagementDocURL}Managing_Red_Hat_Subscriptions_content-management[Managing Red Hat subscriptions] in _{ContentManagementDocTitle}_.
ifndef::orcharhino[]
* For details about using subscription manifests with {Project}, see {RHDocsBaseURL}/subscription_central/1-latest/html/creating_and_managing_manifests_for_a_connected_satellite_server/index[_Creating and managing manifests for a connected Satellite Server_].
endif::[]
7 changes: 4 additions & 3 deletions guides/common/modules/con_additional-deployment-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ For more information, see {ManagingHostsDocURL}Configuring_and_Setting_Up_Remote
Automating tasks with a configuration management tool::
By integrating {Project} with a configuration management tool, you can automate repetitive tasks and ensure consistent configuration of your hosts.
+
For more information on using Ansible with {Project}, see {ManagingConfigurationsAnsibleDocURL}[_{ManagingConfigurationsAnsibleDocTitle}_].
ifndef::satellite[]
You will need to enable the Ansible plugin on your {ProjectServer}.
You can use Ansible to configure hosts.
endif::[]
For more information on using Ansible with {Project}, see {ManagingConfigurationsAnsibleDocURL}[_{ManagingConfigurationsAnsibleDocTitle}_].
+
You can use Puppet to configure hosts.
For more information on using Puppet with {Project}, see {ManagingConfigurationsPuppetDocURL}[_{ManagingConfigurationsPuppetDocTitle}_].
+
ifndef::foreman-deb,satellite[]
You can use Salt to configure hosts.
For more information on using Salt with {Project}, see {ManagingConfigurationsSaltDocURL}[_{ManagingConfigurationsSaltDocTitle}_].
You will need to enable the Salt plugin on your {ProjectServer}.
endif::[]

Security management with OpenSCAP::
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_api-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ When you prepare to upgrade {ProjectServer}, update all the scripts that contain
====

.Additional resources
* See {APIDocURL}[_{APIDocTitle}_] for details on using the {Project} API.
* For more information on {Project} API, see {APIDocURL}[_{APIDocTitle}_].
2 changes: 2 additions & 0 deletions guides/common/modules/con_client-operating-systems.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ include::snip_supported-client-operating-systems.adoc[]
* Operating system installers that can perform unattended installations, such as Anaconda or Debian-installer

ifndef::foreman-deb[]
ifndef::orcharhino[]
The Katello plugin provides functionality for content and subscription management.
endif::[]
The following utilities are provided for supported client operating systems:

* Katello host tools
Expand Down
2 changes: 2 additions & 0 deletions guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ ifndef::foreman-deb,orcharhino[]
You can also run DNS, DHCP, and TFTP externally, outside of the {Project} environment.
endif::[]

ifndef::orcharhino[]
ifeval::["{context}" == "planning"]
.Additional resources
ifndef::satellite[]
Expand All @@ -25,3 +26,4 @@ ifdef::satellite[]
** {InstallingServerDisconnectedDocURL}configuring-external-services_{project-context}[Configuring external services] in _{InstallingServerDisconnectedDocTitle}_
endif::[]
endif::[]
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,15 @@ This requires {Project} to create a record in PostgreSQL for each job.

ifeval::["{context}" == "planning"]
.Additional resources
ifndef::satellite[]
ifndef::orcharhino,satellite[]
* For more information about using an external database, see {InstallingServerDocURL}using-external-databases[Using external databases with {Project}] in _{InstallingServerDocTitle}_.
endif::[]
ifdef::satellite[]
* For more information about using an external database, see the following documents:
** {InstallingServerDocURL}using-external-databases[Using external databases with {Project}] in _{InstallingServerDocTitle}_
** {InstallingServerDisconnectedDocURL}using-external-databases[Using external databases with {Project}] in _{InstallingServerDisconnectedDocTitle}_
endif::[]
ifdef::orcharhino[]
* For more information about using an external database, see {AdministeringDocURL}Migrating_from_Internal_Databases_to_External_Databases_admin[Migrating from internal {Project} databases to external databases] in _{AdministeringDocTitle}_.
endif::[]
endif::[]
Loading

0 comments on commit 4492d57

Please sign in to comment.