From 4492d5789c50e8c3dca914fffae899c4baf116a3 Mon Sep 17 00:00:00 2001 From: Maximilian Kolb Date: Fri, 31 Jan 2025 14:48:48 +0100 Subject: [PATCH] Make Planning guide fit for all flavours * 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" --- .../assembly_common-deployment-scenarios.adoc | 2 +- ...ent-and-patch-management-with-project.adoc | 2 - guides/common/assembly_deployment-path.adoc | 4 +- .../assembly_major-project-components.adoc | 2 +- ...-infrastructure-organization-concepts.adoc | 2 + .../assembly_provisioning-requirements.adoc | 17 + ...y_tools-for-administration-of-project.adoc | 2 + .../images/aws-combined-direct-satellite.png | Bin .../images/aws-combined-vpn-satellite.png | Bin .../aws-multi-region-direct-satellite.png | Bin .../images/aws-multi-region-vpn-satellite.png | Bin .../images/aws-single-region-satellite.png | Bin .../host-group-structures-satellite.png | Bin .../common/images/host-group-structures.svg | 3 + .../images/lifecycle-path-basic-satellite.png | Bin guides/common/images/lifecycle-path-basic.svg | 3 + .../lifecycle-path-diverged-satellite.png | Bin .../common/images/lifecycle-path-diverged.svg | 3 + .../lifecycle-path-simple-satellite.png | Bin .../common/images/lifecycle-path-simple.svg | 3 + .../images/lifecycle-satellite.png | Bin guides/common/images/lifecycle.svg | 3 + .../server-multiple-manifests-satellite.png | Bin .../images/server-multiple-manifests.svg | 3 + .../images/system-architecture-satellite.png | Bin guides/common/images/system-architecture.svg | 3 + .../images/topology-direct-satellite.png | Bin .../images/topology-isolated-satellite.png | Bin ...ing-a-red-hat-subscription-to-project.adoc | 2 + .../con_additional-deployment-tasks.adoc | 7 +- guides/common/modules/con_api-overview.adoc | 2 +- .../modules/con_client-operating-systems.adoc | 2 + .../con_configuring-dns-dhcp-and-tftp.adoc | 2 + ...project-server-with-external-database.adoc | 5 +- .../modules/con_configuring-provisioning.adoc | 5 + ...ent-and-patch-management-with-project.adoc | 5 +- .../modules/con_content-flow-in-project.adoc | 16 +- .../modules/con_content-types-in-project.adoc | 2 +- .../modules/con_content-view-scenarios.adoc | 51 +- .../modules/con_content-views-in-project.adoc | 1 - .../con_creating-and-managing-roles.adoc | 41 +- ...ng-role-based-access-control-policies.adoc | 7 + .../con_defining-your-content-library.adoc | 16 +- .../con_foreman-overview-and-concepts.adoc | 6 +- .../modules/con_hammer-cli-overview.adoc | 2 +- .../modules/con_host-group-structures.adoc | 20 +- .../modules/con_host-groups-overview.adoc | 5 + .../con_installing-a-project-server.adoc | 4 +- ...le-environments-and-environment-paths.adoc | 16 +- .../con_managing-red-hat-subscriptions.adoc | 4 +- .../modules/con_managing-users-and-roles.adoc | 2 +- .../modules/con_multiple-locations.adoc | 12 +- ...rganizations-and-locations-in-project.adoc | 6 +- ...f-recommended-disaster-recovery-plans.adoc | 8 +- .../con_permissions-for-remote-execution.adoc | 2 +- .../modules/con_projectserver-overview.adoc | 4 +- ...projectserver-with-multiple-manifests.adoc | 18 +- ...ent-with-project-additional-resources.adoc | 3 + .../con_provisioning-methods-in-project.adoc | 4 - guides/common/modules/con_pxe-sequence.adoc | 3 +- .../con_remote-execution-in-project.adoc | 8 +- .../modules/con_smartproxy-features.adoc | 18 +- .../modules/con_smartproxy-networking.adoc | 28 +- .../modules/con_smartproxy-overview.adoc | 4 +- ...supported-usage-of-project-components.adoc | 10 +- ...synchronizing-content-between-servers.adoc | 2 +- .../common/modules/con_web-ui-overview.adoc | 2 + ...er-to-awx-as-a-dynamic-inventory-item.adoc | 2 +- ...-to-consume-content-from-a-custom-cdn.adoc | 2 +- ...bling-client-connections-to-satellite.adoc | 2 +- ...nstalling-python-packages-from-server.adoc | 2 +- ...-permissions-for-the-bootstrap-script.adoc | 2 +- ...grading-a-disconnected-project-server.adoc | 4 +- ...ng-external-authentication-in-foreman.adoc | 7 + ...ey-open-source-components-of-foreman.adoc} | 10 +- ...-of-authentication-methods-in-foreman.adoc | 4 + ...predefined-roles-available-in-project.adoc | 2 +- ...sers-provided-and-required-by-foreman.adoc | 6 +- .../snip_creating-and-managing-roles.adoc | 26 + ...=> snip_table-authentication-methods.adoc} | 13 - .../master.adoc | 2 +- guides/doc-Planning_for_Project/master.adoc | 25 +- .../image-sources/planning-for-foreman.drawio | 1015 +++++++++++++++++ 83 files changed, 1325 insertions(+), 206 deletions(-) create mode 100644 guides/common/assembly_provisioning-requirements.adoc mode change 100755 => 100644 guides/common/images/aws-combined-direct-satellite.png mode change 100755 => 100644 guides/common/images/aws-combined-vpn-satellite.png mode change 100755 => 100644 guides/common/images/aws-multi-region-direct-satellite.png mode change 100755 => 100644 guides/common/images/aws-multi-region-vpn-satellite.png mode change 100755 => 100644 guides/common/images/aws-single-region-satellite.png rename guides/{doc-Planning_for_Project => common}/images/host-group-structures-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/host-group-structures.svg rename guides/{doc-Planning_for_Project => common}/images/lifecycle-path-basic-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/lifecycle-path-basic.svg rename guides/{doc-Planning_for_Project => common}/images/lifecycle-path-diverged-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/lifecycle-path-diverged.svg rename guides/{doc-Planning_for_Project => common}/images/lifecycle-path-simple-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/lifecycle-path-simple.svg rename guides/{doc-Planning_for_Project => common}/images/lifecycle-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/lifecycle.svg rename guides/{doc-Planning_for_Project => common}/images/server-multiple-manifests-satellite.png (100%) mode change 100755 => 100644 create mode 100644 guides/common/images/server-multiple-manifests.svg mode change 100755 => 100644 guides/common/images/system-architecture-satellite.png create mode 100644 guides/common/images/system-architecture.svg rename guides/{doc-Planning_for_Project => common}/images/topology-direct-satellite.png (100%) rename guides/{doc-Planning_for_Project => common}/images/topology-isolated-satellite.png (100%) create mode 100644 guides/common/modules/con_defining-role-based-access-control-policies.adoc create mode 100644 guides/common/modules/ref_configuring-external-authentication-in-foreman.adoc rename guides/common/modules/{ref_list-of-key-open-source-components-of-foreman-server.adoc => ref_list-of-key-open-source-components-of-foreman.adoc} (86%) create mode 100644 guides/common/modules/ref_overview-of-authentication-methods-in-foreman.adoc create mode 100644 guides/common/modules/snip_creating-and-managing-roles.adoc rename guides/common/modules/{ref_overview-of-authentication-methods-in-project.adoc => snip_table-authentication-methods.adoc} (84%) create mode 100644 guides/image-sources/planning-for-foreman.drawio diff --git a/guides/common/assembly_common-deployment-scenarios.adoc b/guides/common/assembly_common-deployment-scenarios.adoc index 129b02ea417..7ab54abba15 100644 --- a/guides/common/assembly_common-deployment-scenarios.adoc +++ b/guides/common/assembly_common-deployment-scenarios.adoc @@ -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::[] diff --git a/guides/common/assembly_content-and-patch-management-with-project.adoc b/guides/common/assembly_content-and-patch-management-with-project.adoc index b766fc3ab1c..f496047021c 100644 --- a/guides/common/assembly_content-and-patch-management-with-project.adoc +++ b/guides/common/assembly_content-and-patch-management-with-project.adoc @@ -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] @@ -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::[] diff --git a/guides/common/assembly_deployment-path.adoc b/guides/common/assembly_deployment-path.adoc index 00cc6eb9a33..bf5b8f0a5b4 100644 --- a/guides/common/assembly_deployment-path.adoc +++ b/guides/common/assembly_deployment-path.adoc @@ -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] @@ -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] diff --git a/guides/common/assembly_major-project-components.adoc b/guides/common/assembly_major-project-components.adoc index 5b6b44fbda1..3edfaba66e0 100644 --- a/guides/common/assembly_major-project-components.adoc +++ b/guides/common/assembly_major-project-components.adoc @@ -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] diff --git a/guides/common/assembly_project-infrastructure-organization-concepts.adoc b/guides/common/assembly_project-infrastructure-organization-concepts.adoc index 9e6f23e2f93..5e63b024f37 100644 --- a/guides/common/assembly_project-infrastructure-organization-concepts.adoc +++ b/guides/common/assembly_project-infrastructure-organization-concepts.adoc @@ -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] diff --git a/guides/common/assembly_provisioning-requirements.adoc b/guides/common/assembly_provisioning-requirements.adoc new file mode 100644 index 00000000000..bdd0d67a9ad --- /dev/null +++ b/guides/common/assembly_provisioning-requirements.adoc @@ -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::[] diff --git a/guides/common/assembly_tools-for-administration-of-project.adoc b/guides/common/assembly_tools-for-administration-of-project.adoc index c8b13749e05..3b62854a131 100644 --- a/guides/common/assembly_tools-for-administration-of-project.adoc +++ b/guides/common/assembly_tools-for-administration-of-project.adoc @@ -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::[] diff --git a/guides/common/images/aws-combined-direct-satellite.png b/guides/common/images/aws-combined-direct-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-combined-vpn-satellite.png b/guides/common/images/aws-combined-vpn-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-multi-region-direct-satellite.png b/guides/common/images/aws-multi-region-direct-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-multi-region-vpn-satellite.png b/guides/common/images/aws-multi-region-vpn-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/aws-single-region-satellite.png b/guides/common/images/aws-single-region-satellite.png old mode 100755 new mode 100644 diff --git a/guides/doc-Planning_for_Project/images/host-group-structures-satellite.png b/guides/common/images/host-group-structures-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/host-group-structures-satellite.png rename to guides/common/images/host-group-structures-satellite.png diff --git a/guides/common/images/host-group-structures.svg b/guides/common/images/host-group-structures.svg new file mode 100644 index 00000000000..affda53eee3 --- /dev/null +++ b/guides/common/images/host-group-structures.svg @@ -0,0 +1,3 @@ + + +
dev-infra-git-el10
qa-infra-git-el10
prod-infra-git-el10
DEV
EL10
git
container
EL9
loghost
QA
Flat
Lifecycle Environment Based
Application Based
Location Based
ACME Web
frontend
web-dev
web-qa
backend
web-dev
infra
Munich
web-dev
web-frontend
web-backend
web-qa
web-frontend
Boston
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/lifecycle-path-basic-satellite.png b/guides/common/images/lifecycle-path-basic-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/lifecycle-path-basic-satellite.png rename to guides/common/images/lifecycle-path-basic-satellite.png diff --git a/guides/common/images/lifecycle-path-basic.svg b/guides/common/images/lifecycle-path-basic.svg new file mode 100644 index 00000000000..a1b87262efd --- /dev/null +++ b/guides/common/images/lifecycle-path-basic.svg @@ -0,0 +1,3 @@ + + +
Lib
Prod
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/lifecycle-path-diverged-satellite.png b/guides/common/images/lifecycle-path-diverged-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/lifecycle-path-diverged-satellite.png rename to guides/common/images/lifecycle-path-diverged-satellite.png diff --git a/guides/common/images/lifecycle-path-diverged.svg b/guides/common/images/lifecycle-path-diverged.svg new file mode 100644 index 00000000000..96bded6defc --- /dev/null +++ b/guides/common/images/lifecycle-path-diverged.svg @@ -0,0 +1,3 @@ + + +
Lib
Web
Dev
Web
QA
Web
UAT
Web
Prod
Lib
Dev
QA
Prod
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/lifecycle-path-simple-satellite.png b/guides/common/images/lifecycle-path-simple-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/lifecycle-path-simple-satellite.png rename to guides/common/images/lifecycle-path-simple-satellite.png diff --git a/guides/common/images/lifecycle-path-simple.svg b/guides/common/images/lifecycle-path-simple.svg new file mode 100644 index 00000000000..168ac2c190f --- /dev/null +++ b/guides/common/images/lifecycle-path-simple.svg @@ -0,0 +1,3 @@ + + +
Lib
Dev
QA
Prod
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/lifecycle-satellite.png b/guides/common/images/lifecycle-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/lifecycle-satellite.png rename to guides/common/images/lifecycle-satellite.png diff --git a/guides/common/images/lifecycle.svg b/guides/common/images/lifecycle.svg new file mode 100644 index 00000000000..e9fd15a4c26 --- /dev/null +++ b/guides/common/images/lifecycle.svg @@ -0,0 +1,3 @@ + + +
Organization 1
Foreman+Katello
Operator
Location 1
Dev
Location 2
Location 3
Location N
QA
Foreman Server & Smart Proxy Servers
Lib
Dev
QA
Prod
QA
Prod
QA
Prod
1
2
3
4
Network/Firewall
Version 1
Composite Content View 2
Version 2
Composite Content View 2
Version N
Composite Content View 2
Version N
Content View 1
Version N
Composite Content View 2
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/server-multiple-manifests-satellite.png b/guides/common/images/server-multiple-manifests-satellite.png old mode 100755 new mode 100644 similarity index 100% rename from guides/doc-Planning_for_Project/images/server-multiple-manifests-satellite.png rename to guides/common/images/server-multiple-manifests-satellite.png diff --git a/guides/common/images/server-multiple-manifests.svg b/guides/common/images/server-multiple-manifests.svg new file mode 100644 index 00000000000..7ebfe7d8db7 --- /dev/null +++ b/guides/common/images/server-multiple-manifests.svg @@ -0,0 +1,3 @@ + + +
IT  Subscriptions (30)
R&D Subscriptions (30)
Operations Subscriptions (50)
Engineering Subscriptions (20)
Manifest
Manifest
Manifest
Manifest
Example Corporation 2
Example Corporation 1
Org 1
Org 2
Org 3
Org 4
Foreman+Katello
60 Subscriptions
100 Subscriptions
 \ No newline at end of file diff --git a/guides/common/images/system-architecture-satellite.png b/guides/common/images/system-architecture-satellite.png old mode 100755 new mode 100644 diff --git a/guides/common/images/system-architecture.svg b/guides/common/images/system-architecture.svg new file mode 100644 index 00000000000..7c755a51d5e --- /dev/null +++ b/guides/common/images/system-architecture.svg @@ -0,0 +1,3 @@ + + +
Organizations
Foreman+Katello
Red Hat manifest
Puppet
Container Registry
Git
SCAP
Custom content
SUSE
Canonical
Operator
Ansible
Analytics
Location 1
1
Location 2
Location 3
Location N
2
3
N
Managed hosts
Foreman Server & Smart Proxy Servers
Lifecycle Management
 \ No newline at end of file diff --git a/guides/doc-Planning_for_Project/images/topology-direct-satellite.png b/guides/common/images/topology-direct-satellite.png similarity index 100% rename from guides/doc-Planning_for_Project/images/topology-direct-satellite.png rename to guides/common/images/topology-direct-satellite.png diff --git a/guides/doc-Planning_for_Project/images/topology-isolated-satellite.png b/guides/common/images/topology-isolated-satellite.png similarity index 100% rename from guides/doc-Planning_for_Project/images/topology-isolated-satellite.png rename to guides/common/images/topology-isolated-satellite.png diff --git a/guides/common/modules/con_adding-a-red-hat-subscription-to-project.adoc b/guides/common/modules/con_adding-a-red-hat-subscription-to-project.adoc index aad6fa45301..192703afded 100644 --- a/guides/common/modules/con_adding-a-red-hat-subscription-to-project.adoc +++ b/guides/common/modules/con_adding-a-red-hat-subscription-to-project.adoc @@ -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::[] diff --git a/guides/common/modules/con_additional-deployment-tasks.adoc b/guides/common/modules/con_additional-deployment-tasks.adoc index 000ad606501..baa74d971c5 100644 --- a/guides/common/modules/con_additional-deployment-tasks.adoc +++ b/guides/common/modules/con_additional-deployment-tasks.adoc @@ -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:: diff --git a/guides/common/modules/con_api-overview.adoc b/guides/common/modules/con_api-overview.adoc index 9e39729cdd1..36163fe7229 100644 --- a/guides/common/modules/con_api-overview.adoc +++ b/guides/common/modules/con_api-overview.adoc @@ -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}_]. diff --git a/guides/common/modules/con_client-operating-systems.adoc b/guides/common/modules/con_client-operating-systems.adoc index b18f9d6c2ca..a48bd2df9b7 100644 --- a/guides/common/modules/con_client-operating-systems.adoc +++ b/guides/common/modules/con_client-operating-systems.adoc @@ -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 diff --git a/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc b/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc index 241259a9e07..3843543a539 100644 --- a/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc +++ b/guides/common/modules/con_configuring-dns-dhcp-and-tftp.adoc @@ -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[] @@ -25,3 +26,4 @@ ifdef::satellite[] ** {InstallingServerDisconnectedDocURL}configuring-external-services_{project-context}[Configuring external services] in _{InstallingServerDisconnectedDocTitle}_ endif::[] endif::[] +endif::[] diff --git a/guides/common/modules/con_configuring-project-server-with-external-database.adoc b/guides/common/modules/con_configuring-project-server-with-external-database.adoc index b549ba3755d..ae440bae28e 100644 --- a/guides/common/modules/con_configuring-project-server-with-external-database.adoc +++ b/guides/common/modules/con_configuring-project-server-with-external-database.adoc @@ -24,7 +24,7 @@ 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[] @@ -32,4 +32,7 @@ ifdef::satellite[] ** {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::[] diff --git a/guides/common/modules/con_configuring-provisioning.adoc b/guides/common/modules/con_configuring-provisioning.adoc index fabe272b232..fc7a0d0b03e 100644 --- a/guides/common/modules/con_configuring-provisioning.adoc +++ b/guides/common/modules/con_configuring-provisioning.adoc @@ -10,6 +10,11 @@ The following {Project} features support automating the provisioning of your hos * Provisioning templates enable you to define the way {Project} installs an operating system on your hosts. * The Discovery service enables you to detect unknown hosts and virtual machines on the provisioning network. +ifndef::satellite[] ++ +This requires the Discovery plugin. +For more information, see {ProvisioningDocURL}Installing_the_Discovery_Service_provisioning[Installing the Discovery service] in _{ProvisioningDocTitle}_. +endif::[] * Host groups enable you to standardize provisioning of host configurations. .Additional resources diff --git a/guides/common/modules/con_content-and-patch-management-with-project.adoc b/guides/common/modules/con_content-and-patch-management-with-project.adoc index e191117ce97..13e8eb99c68 100644 --- a/guides/common/modules/con_content-and-patch-management-with-project.adoc +++ b/guides/common/modules/con_content-and-patch-management-with-project.adoc @@ -1,7 +1,4 @@ -[id="Content-and-Patch-Management-with-{ProjectNameID}_{context}"] +[id="content-and-patch-management-with-{project-context}"] = 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::[] diff --git a/guides/common/modules/con_content-flow-in-project.adoc b/guides/common/modules/con_content-flow-in-project.adoc index 63097cf1c52..7d4208334eb 100644 --- a/guides/common/modules/con_content-flow-in-project.adoc +++ b/guides/common/modules/con_content-flow-in-project.adoc @@ -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}*:: @@ -25,14 +25,18 @@ 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[] +ifdef::foreman-el,foreman-deb,katello[] +image::common/system-architecture.svg[Content flow in {ProjectName}] endif::[] - +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] image::common/system-architecture-satellite.png[Content flow in {ProjectName}] +endif::[] .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::[] diff --git a/guides/common/modules/con_content-types-in-project.adoc b/guides/common/modules/con_content-types-in-project.adoc index 20f26b4b2f7..2760b786206 100644 --- a/guides/common/modules/con_content-types-in-project.adoc +++ b/guides/common/modules/con_content-types-in-project.adoc @@ -6,7 +6,7 @@ ifdef::satellite[] You can use Red{nbsp}Hat content as well as custom content and organize it into {Project} products. endif::[] ifdef::katello,orcharhino[] -You can use content from Red{nbsp}Hat as well as from Canonical, Oracle, SUSE, and other custom content. +You can use any custom content and content from Red{nbsp}Hat, Canonical, Oracle, and SUSE. endif::[] For example, {Project} supports the following content types: diff --git a/guides/common/modules/con_content-view-scenarios.adoc b/guides/common/modules/con_content-view-scenarios.adoc index f1e303881ee..ca5f7f8cf73 100644 --- a/guides/common/modules/con_content-view-scenarios.adoc +++ b/guides/common/modules/con_content-view-scenarios.adoc @@ -8,40 +8,63 @@ It is not recommended to associate hosts directly with the Library as it prevent Instead, create a lifecycle environment path that suits your content workflow. The following scenarios are common: -* *A single lifecycle environment* – content from Library is promoted directly to the production stage. +* *A single lifecycle environment* {endash} content from Library is promoted directly to the production stage. This approach limits the complexity but still allows for testing the content within the Library before making it available to hosts. + -image::lifecycle-path-basic-satellite.png[A single lifecycle environment] +ifdef::foreman-el,foreman-deb,katello[] +image::common/lifecycle-path-basic.svg[A single lifecycle environment] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/lifecycle-path-basic-satellite.png[A single lifecycle environment] +endif::[] -* *A single lifecycle environment path* – both operating system and applications content is promoted through the same path. -The path can consist of several stages (for example *Development*, *QA*, *Production*), which enables thorough testing but requires additional effort. +* *A single lifecycle environment path* {endash} both operating system and applications content is promoted through the same path. +The path can consist of several stages, for example, *Development*, *QA*, *Production*, which enables thorough testing but requires additional effort. + -image::lifecycle-path-simple-satellite.png[A single lifecycle environment path] +ifdef::foreman-el,foreman-deb,katello[] +image::common/lifecycle-path-simple.svg[A single lifecycle environment path] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/lifecycle-path-simple-satellite.png[A single lifecycle environment path] +endif::[] -* *Application specific lifecycle environment paths* – each application has a separate path, which allows for individual application release cycles. +* *Application specific lifecycle environment paths* {endash} each application has a separate path, which allows for individual application release cycles. You can associate specific compute resources with application lifecycle stages to facilitate testing. -On the other hand, this scenario increases the maintenance complexity. +However, this scenario increases the maintenance complexity. + -image::lifecycle-path-diverged-satellite.png[Application specific lifecycle environment paths] - +ifdef::foreman-el,foreman-deb,katello[] +image::common/lifecycle-path-diverged.svg[Application specific lifecycle environment paths] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/lifecycle-path-diverged-satellite.png[Application specific lifecycle environment paths] +endif::[] The following content view scenarios are common: -* *All in one content view* – a content view that contains all necessary content for the majority of your hosts. +* *All in one content view* {endash} a content view that contains all necessary content for the majority of your hosts. Reducing the number of content views is an advantage in deployments with constrained resources (time, storage space) or with uniform host types. However, this scenario limits the content view capabilities such as time based snapshots or intelligent filtering. Any change in content sources affects a proportion of hosts. -* *Host specific content view* – a dedicated content view for each host type. +* *Host specific content view* {endash} a dedicated content view for each host type. This approach can be useful in deployments with a small number of host types (up to 30). -However, it prevents sharing content across host types as well as separation based on criteria other than the host type (for example between operating system and applications). +However, it prevents sharing content across host types as well as separation based on criteria other than the host type, for example, between operating system and applications. With critical updates every content view has to be updated, which increases maintenance efforts. -* *Host specific composite content view* – a dedicated combination of content views for each host type. +* *Host specific composite content view* {endash} a dedicated combination of content views for each host type. This approach enables separating host specific and shared content, for example you can have dedicated content views for the operating system and application content. By using a composite, you can manage your operating system and applications separately and at different frequencies. -* *Component based content view* – a dedicated content view for a specific application. +* *Component based content view* {endash} a dedicated content view for a specific application. For example a database content view can be included into several composite content views. This approach allows for greater standardization but it leads to an increased number of content views. diff --git a/guides/common/modules/con_content-views-in-project.adoc b/guides/common/modules/con_content-views-in-project.adoc index 73f17afbf9e..dcfa0d1a77c 100644 --- a/guides/common/modules/con_content-views-in-project.adoc +++ b/guides/common/modules/con_content-views-in-project.adoc @@ -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::[] diff --git a/guides/common/modules/con_creating-and-managing-roles.adoc b/guides/common/modules/con_creating-and-managing-roles.adoc index 9ca6c376063..16443f50555 100644 --- a/guides/common/modules/con_creating-and-managing-roles.adoc +++ b/guides/common/modules/con_creating-and-managing-roles.adoc @@ -1,42 +1,7 @@ -[id="Creating_and_Managing_Roles_{context}"] -ifeval::["{context}" == "admin"] +[id="creating-and-managing-roles"] = Creating and managing roles -endif::[] -ifeval::["{context}" == "planning"] -= Defining role-based access control policies -endif::[] -Users in {Project} can have one or more roles assigned. -These roles are associated with permissions that enable users to perform specified administrative actions in {Project}. -Permission filters define the actions allowed for a certain resource type. +include::snip_creating-and-managing-roles.adoc[] -{Project} provides a set of predefined roles with permissions sufficient for standard tasks. -ifeval::["{context}" == "admin"] -For a list of these roles, see xref:Predefined_Roles_Available_in_{project-context}_{context}[]. -endif::[] -You can also configure custom roles. - -[NOTE] -==== -One of the predefined roles is the *Default role*. -{Project} assigns the *Default role* to every user in the system. -By default, the *Default role* grants only a limited set of permissions. -Be aware that if you add a permission to the *Default role*, every {Project} users will gain that permission. -Assigning a different role to a user does not remove the *Default role* from the user. -==== - -The following types of roles are commonly defined within various {Project} deployments: - -Roles related to applications or parts of infrastructure:: -For example, roles for owners of {client-os} as the operating system as opposed to roles for owners of application servers and database servers. - -Roles related to a particular stage of the software lifecycle:: -For example, roles divided among the development, testing, and production phases, where each phase has one or more owners. - -Roles related to specific tasks:: -For example, you can create a role for security managers and a role for license managers, depending on the specific tasks users need to be able to perform within your organization. - -ifeval::["{context}" == "planning"] .Additional resources -* For more information, including details about creating custom roles and granting permissions to roles, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing users and roles] in _{AdministeringDocTitle}_. -endif::[] +* For a list of these roles, see xref:predefined-roles-available-in-{project-context}[]. diff --git a/guides/common/modules/con_defining-role-based-access-control-policies.adoc b/guides/common/modules/con_defining-role-based-access-control-policies.adoc new file mode 100644 index 00000000000..5d029898982 --- /dev/null +++ b/guides/common/modules/con_defining-role-based-access-control-policies.adoc @@ -0,0 +1,7 @@ +[id="definiting-role-based-access-control-policies"] += Defining role-based access control policies + +include::snip_creating-and-managing-roles.adoc[] + +.Additional resources +* For more information, including details about creating custom roles and granting permissions to roles, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing users and roles] in _{AdministeringDocTitle}_. diff --git a/guides/common/modules/con_defining-your-content-library.adoc b/guides/common/modules/con_defining-your-content-library.adoc index 43b47560dff..f816a6dd937 100644 --- a/guides/common/modules/con_defining-your-content-library.adoc +++ b/guides/common/modules/con_defining-your-content-library.adoc @@ -12,9 +12,17 @@ The repositories for the {RHEL}{nbsp}Server product consist of different version When you enable a Red{nbsp}Hat repository, {Project} automatically creates an associated product. ifdef::katello,orcharhino[] +Oracle ULN content:: +You can use {Project} to manage hosts running Oracle Linux. +For more information, see {ContentManagementDocURL}creating-uln-repositories[Creating ULN repositories] in _{ContentManagementDocTitle}_. + SUSE content:: You can use {Project} to manage hosts running {SLES}. For more information, see {ContentManagementDocURL}Managing_SUSE_Content_content-management[Managing SUSE content] in _{ContentManagementDocTitle}_. + +Ubuntu ESM content:: +You can use {Project} to manage hosts running Ubuntu. +For more information, see {ContentManagementDocURL}Synchronizing-Ubuntu-Expanded-Security-Maintenance-content_content-management[Synchronizing Ubuntu Expanded Security Maintenance content] in _{ContentManagementDocTitle}_. endif::[] Other sources of content:: @@ -32,8 +40,8 @@ You can synchronize repositories manually, or you can create a sync plan to ensu .Additional resources ifdef::katello[] -* For more information, see {ContentManagementDocURL}Basic_Content_Management_Workflow_content-management[Basic content management workflow] and {ContentManagementDocURL}Importing_Custom_Content[Importing custom content] in _{ContentManagementDocTitle}_. -endif::[] -ifndef::katello[] -* For more information, including procedures for enabling and synchronizing repositories, see {ContentManagementDocURL}Importing_Custom_Content[Importing custom content] in _{ContentManagementDocTitle}_. +* For more information about basic workflows, see {ContentManagementDocURL}Basic_Content_Management_Workflow_content-management[Basic content management workflow]. +* For more information about Deb content, see {ContentManagementDocURL}Adding_Custom_Deb_Repositories_content-management[Adding Deb repositories] in _{ContentManagementDocTitle}_. +* For more information about Yum content, see {ContentManagementDocURL}Adding_Custom_RPM_Repositories_content-management[Adding RPM repositories] in _{ContentManagementDocTitle}_. endif::[] +* For more information, including procedures for enabling and synchronizing repositories, see {ContentManagementDocURL}Importing_Content_content-management[Importing content] in _{ContentManagementDocTitle}_. diff --git a/guides/common/modules/con_foreman-overview-and-concepts.adoc b/guides/common/modules/con_foreman-overview-and-concepts.adoc index fc21ff722e8..5a06a520a90 100644 --- a/guides/common/modules/con_foreman-overview-and-concepts.adoc +++ b/guides/common/modules/con_foreman-overview-and-concepts.adoc @@ -1,5 +1,9 @@ [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, +ifdef::katello,orcharhino,satellite[] +content delivery, +endif::[] +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. diff --git a/guides/common/modules/con_hammer-cli-overview.adoc b/guides/common/modules/con_hammer-cli-overview.adoc index bcaea5d737a..413c03117e6 100644 --- a/guides/common/modules/con_hammer-cli-overview.adoc +++ b/guides/common/modules/con_hammer-cli-overview.adoc @@ -23,4 +23,4 @@ This can have performance implications when executing a large number of Hammer c In contrast, scripts that use API commands communicate directly with the Satellite API and they establish the binding only once. .Additional resources -* See {HammerDocURL}[_{HammerDocTitle}_] for details on using Hammer CLI. +* For more information about Hammer CLI, see {HammerDocURL}[_{HammerDocTitle}_]. diff --git a/guides/common/modules/con_host-group-structures.adoc b/guides/common/modules/con_host-group-structures.adoc index 91055eeca5c..9357e89d3f6 100644 --- a/guides/common/modules/con_host-group-structures.adoc +++ b/guides/common/modules/con_host-group-structures.adoc @@ -5,20 +5,28 @@ The fact that host groups can be nested to inherit parameters from each other al A well planned host group structure can help to simplify the maintenance of host settings. This section outlines four approaches to organizing host groups. -[[figu-Life_Cycle_Environment_Based_Structure]] .Host group structuring examples - -image::host-group-structures-satellite.png[Host group structuring examples] +ifdef::foreman-el,foreman-deb,katello[] +image::common/host-group-structures.svg[Host group structuring examples] +endif::[] +ifdef::orcharhino[] +TODO: Add image +endif::[] +ifdef::satellite[] +image::common/host-group-structures-satellite.png[Host group structuring examples] +endif::[] Flat structure:: The advantage of a flat structure is limited complexity, as inheritance is avoided. In a deployment with few host types, this scenario is the best option. However, without inheritance there is a risk of high duplication of settings between host groups. +ifdef::katello,orcharhino,satellite[] Lifecycle environment based structure:: In this hierarchy, the first host group level is reserved for parameters specific to a lifecycle environment. The second level contains operating system related definitions, and the third level contains application specific settings. -Such structure is useful in scenarios where responsibilities are divided among lifecycle environments (for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages). +Such structure is useful in scenarios where responsibilities are divided among lifecycle environments, for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages. +endif::[] Application based structure:: This hierarchy is based on roles of hosts in a specific application. @@ -28,5 +36,5 @@ However, the content views can only be assigned to host groups at the bottom lev Location based structure:: In this hierarchy, the distribution of locations is aligned with the host group structure. -In a scenario where the location ({SmartProxyServer}) topology determines many other attributes, this approach is the best option. -On the other hand, this structure complicates sharing parameters across locations, therefore in complex environments with a large number of applications, the number of host group changes required for each configuration change increases significantly. +In a scenario where the location or {SmartProxyServer} topology determines many other attributes, this approach is the best option. +However, this structure complicates sharing parameters across locations, therefore in complex environments with a large number of applications, the number of host group changes required for each configuration change increases significantly. diff --git a/guides/common/modules/con_host-groups-overview.adoc b/guides/common/modules/con_host-groups-overview.adoc index 280a82d0aad..76483ee5743 100644 --- a/guides/common/modules/con_host-groups-overview.adoc +++ b/guides/common/modules/con_host-groups-overview.adoc @@ -3,7 +3,12 @@ A host group acts as a template for common host settings. +ifdef::katello,orcharhino,satellite[] With host groups, you can define many settings for hosts, such as lifecycle environment, content view, or Ansible roles that are available to the hosts. +endif::[] +ifdef::foreman-el,foreman-deb[] +With host groups, you can define many settings for hosts, such as host parameters or operating system settings that are available to the hosts. +endif::[] Instead of defining the settings individually for each host, you can use host groups to define common settings once and apply them to multiple hosts. You can create nested host groups. diff --git a/guides/common/modules/con_installing-a-project-server.adoc b/guides/common/modules/con_installing-a-project-server.adoc index 5b7287497cf..2d10f6d0cd2 100644 --- a/guides/common/modules/con_installing-a-project-server.adoc +++ b/guides/common/modules/con_installing-a-project-server.adoc @@ -24,10 +24,10 @@ This allows for exporting both Red{nbsp}Hat provided and custom content at the f endif::[] .Additional resources -ifndef::satellite[] +ifndef::orcharhino,satellite[] * For complete information on installing a {ProjectServer}, including prerequisites and predefined tuning profiles, see {InstallingServerDocURL}[_{InstallingServerDocTitle}_]. endif::[] -ifdef::satellite[] +ifdef::orcharhino,satellite[] * For complete information on installing a {ProjectServer}, including prerequisites and predefined tuning profiles, see the following documents: ** {InstallingServerDocURL}[_{InstallingServerDocTitle}_] ** {InstallingServerDisconnectedDocURL}[_{InstallingServerDisconnectedDocTitle}_] diff --git a/guides/common/modules/con_lifecycle-environments-and-environment-paths.adoc b/guides/common/modules/con_lifecycle-environments-and-environment-paths.adoc index 9aa70d7dc35..eb151fe107b 100644 --- a/guides/common/modules/con_lifecycle-environments-and-environment-paths.adoc +++ b/guides/common/modules/con_lifecycle-environments-and-environment-paths.adoc @@ -8,11 +8,13 @@ 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]] .An environment path containing four environments - -image::lifecycle-satellite.png[An environment path containing four environments] +ifdef::foreman-el,foreman-deb,katello[] +image::common/lifecycle.svg[An environment path containing four environments] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/lifecycle-satellite.png[An environment path containing four environments] +endif::[] diff --git a/guides/common/modules/con_managing-red-hat-subscriptions.adoc b/guides/common/modules/con_managing-red-hat-subscriptions.adoc index 3fe8d4e15b3..4582363e172 100644 --- a/guides/common/modules/con_managing-red-hat-subscriptions.adoc +++ b/guides/common/modules/con_managing-red-hat-subscriptions.adoc @@ -33,9 +33,9 @@ endif::[] ifndef::orcharhino[] .Additional resources ifndef::satellite[] -* {InstallingServerDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn_{project-context}[Configuring {ProjectServerTitle} to Consume Content from a Custom CDN] in _{InstallingServerDocTitle}_ +* {InstallingServerDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn_{project-context}[Configuring {ProjectServer} to Consume Content from a Custom CDN] in _{InstallingServerDocTitle}_ endif::[] ifdef::satellite[] -* {InstallingServerDisconnectedDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn_{project-context}[Configuring {ProjectServerTitle} to Consume Content from a Custom CDN] in _{InstallingServerDisconnectedDocTitle}_ +* {InstallingServerDisconnectedDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn_{project-context}[Configuring {ProjectServer} to Consume Content from a Custom CDN] in _{InstallingServerDisconnectedDocTitle}_ endif::[] endif::[] diff --git a/guides/common/modules/con_managing-users-and-roles.adoc b/guides/common/modules/con_managing-users-and-roles.adoc index 9a552c329f8..8c6389398a9 100644 --- a/guides/common/modules/con_managing-users-and-roles.adoc +++ b/guides/common/modules/con_managing-users-and-roles.adoc @@ -15,4 +15,4 @@ Each role contains one on more _permission filters_ that specify the actions all Actions are grouped according to the _Resource type_. Once a role has been created, users and user groups can be associated with that role. This way, you can assign the same set of permissions to large groups of users. -{Project} provides a set of predefined roles and also enables creating custom roles and permission filters as described in xref:Creating_and_Managing_Roles_{context}[]. +{Project} provides a set of predefined roles and also enables creating custom roles and permission filters as described in xref:creating-and-managing-roles[]. diff --git a/guides/common/modules/con_multiple-locations.adoc b/guides/common/modules/con_multiple-locations.adoc index e916e3d7abe..7d821580ca8 100644 --- a/guides/common/modules/con_multiple-locations.adoc +++ b/guides/common/modules/con_multiple-locations.adoc @@ -6,8 +6,12 @@ This practice can save bandwidth since hosts obtain content from a local {SmartP Synchronization of content from remote repositories is done only by the {SmartProxy}, not by each host in a location. In addition, this layout makes the provisioning infrastructure more reliable and easier to configure. -ifndef::satellite[] -include::snip_red-hat-images.adoc[] +ifdef::foreman-el,foreman-deb,katello[] +image::common/system-architecture.svg[Content flow in {ProjectName}] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/system-architecture-satellite.png[Content flow in {ProjectName}] endif::[] - -image::common/system-architecture-satellite.png[Content Flow in {ProjectName}] diff --git a/guides/common/modules/con_organizations-and-locations-in-project.adoc b/guides/common/modules/con_organizations-and-locations-in-project.adoc index 65be550b463..7759181fdff 100644 --- a/guides/common/modules/con_organizations-and-locations-in-project.adoc +++ b/guides/common/modules/con_organizations-and-locations-in-project.adoc @@ -13,7 +13,12 @@ endif::[] Organizations:: Organizations typically represent different business units, departments, or teams, such as _Finance_, _Marketing_, or _Web Development_. +ifdef::satellite[] Each organization requires a separate Red{nbsp}Hat subscription manifest. +endif::[] +ifndef::satellite[] +To manage Red{nbsp}Hat content, each organization requires a separate Red{nbsp}Hat subscription manifest. +endif::[] + By creating organizations, you can create logical containers to isolate and manage their configurations separately according to their specific requirements. @@ -33,7 +38,6 @@ Each {SmartProxyServer} synchronizes content and handles configuration of hosts Your {ProjectServer} retains the management function, while the content and configuration is synchronized between your {ProjectServer} and {SmartProxyServers} assigned to certain locations. - .Example of using organizations and locations in {Project} ==== The structure of a multi-national company includes the Finance, Marketing, and Sales departments. diff --git a/guides/common/modules/con_overview-of-recommended-disaster-recovery-plans.adoc b/guides/common/modules/con_overview-of-recommended-disaster-recovery-plans.adoc index 1e0919fed93..0496b26924b 100644 --- a/guides/common/modules/con_overview-of-recommended-disaster-recovery-plans.adoc +++ b/guides/common/modules/con_overview-of-recommended-disaster-recovery-plans.adoc @@ -15,7 +15,13 @@ You will lose data changes that have occurred since the snapshot you are using t Active and passive {ProjectServer}, with external storage:: How do I back up?::: -Store the following critical data on network attached storage: content in `/var/lib/pulp` and database in `/var/lib/pgsql`. +Store the following critical data on network attached storage: +ifdef::katello,orcharhino,satellite[] +content in `/var/lib/pulp` and database in `/var/lib/pgsql`. +endif::[] +ifdef::foreman-el,foreman-deb[] +database in `/var/lib/pgsql`. +endif::[] Replicate this storage into a different data center. Attach the storage to a {ProjectServer} that is a clone of the primary {ProjectServer} but runs passively. How will I recover in case of a disruptive event?::: diff --git a/guides/common/modules/con_permissions-for-remote-execution.adoc b/guides/common/modules/con_permissions-for-remote-execution.adoc index 5b235d42253..338ed34d1ce 100644 --- a/guides/common/modules/con_permissions-for-remote-execution.adoc +++ b/guides/common/modules/con_permissions-for-remote-execution.adoc @@ -19,7 +19,7 @@ You can run remote execution jobs against {ProjectName} and {SmartProxy} registe Standard *Manager* and *Site Manager* roles have this permission by default. If you use either the *Manager* or *Site Manager* role, or if you use a custom role with the `execute_jobs_on_infrastructure_hosts` permission, you can execute remote jobs against registered {ProjectName} and {SmartProxy} hosts. -For more information on working with roles and permissions, see {AdministeringDocURL}Creating_and_Managing_Roles_admin[Creating and Managing Roles] in _{AdministeringDocTitle}_. +For more information on working with roles and permissions, see {AdministeringDocURL}creating-and-managing-roles[Creating and managing roles] in _{AdministeringDocTitle}_. The following example shows filters for the `execute_template_invocation` permission: diff --git a/guides/common/modules/con_projectserver-overview.adoc b/guides/common/modules/con_projectserver-overview.adoc index fdf2609b2fa..64dae28514d 100644 --- a/guides/common/modules/con_projectserver-overview.adoc +++ b/guides/common/modules/con_projectserver-overview.adoc @@ -1,5 +1,5 @@ [id="{ProjectServerID}-Overview_{context}"] -= {ProjectServerTitle} overview += {ProjectServer} overview {ProjectServer} is the central component of a {Project} deployment where you plan and manage the content lifecycle. @@ -19,4 +19,4 @@ A typical {Project} deployment includes one {ProjectServer} on which you perform You can grant {Project} users permissions to access precisely the parts of the infrastructure for which they are responsible. .Additional resources -* For more information about managing permissions, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing Users and Roles] in _{AdministeringDocTitle}_. \ No newline at end of file +* For more information about managing permissions, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing users and roles] in _{AdministeringDocTitle}_. diff --git a/guides/common/modules/con_projectserver-with-multiple-manifests.adoc b/guides/common/modules/con_projectserver-with-multiple-manifests.adoc index 1f8732ffd39..f34960d9c61 100644 --- a/guides/common/modules/con_projectserver-with-multiple-manifests.adoc +++ b/guides/common/modules/con_projectserver-with-multiple-manifests.adoc @@ -1,12 +1,14 @@ -[id="projectserver-with-multiple-manifests"] +[id="{project-context}-server-with-multiple-manifests"] = {ProjectServer} with multiple manifests If you plan to have more than one Red{nbsp}Hat{nbsp}Network account, or if you want to manage systems belonging to another entity that is also a Red{nbsp}Hat{nbsp}Network account holder, then you and the other account holder can assign subscriptions, as required, to manifests. A customer that does not have a {Project} subscription can create a Subscription Asset Manager manifest, which can be used with {Project}, if they have other valid subscriptions. You can then use the multiple manifests in one {ProjectServer} to manage multiple organizations. +ifdef::satellite[] If you must manage systems but do not have access to the subscriptions for the RPMs, you must use {RHEL} {Project} Add-On. For more information, see https://www.redhat.com/en/technologies/management/satellite[{Project} Add-On]. +endif::[] The following diagram shows two Red{nbsp}Hat{nbsp}Network account holders, who want their systems to be managed by the same {Project} installation. In this scenario, Example Corporation 1 can allocate any subset of their 60 subscriptions, in this example they have allocated 30, to a manifest. @@ -14,19 +16,23 @@ This can be imported into the {Project} as a distinct Organization. This allows system administrators the ability to manage Example Corporation 1's systems using {Project} completely independently of Example Corporation 2's organizations (R&D, Operations, and Engineering). .{ProjectServer} with multiple manifests -image::server-multiple-manifests-satellite.png[{ProjectServer} with multiple manifests] +ifdef::foreman-el,foreman-deb,katello[] +image::common/server-multiple-manifests.svg[{ProjectServer} with multiple manifests] +endif::[] +ifdef::orcharhino[] +// TODO: Add image +endif::[] +ifdef::satellite[] +image::common/server-multiple-manifests-satellite.png[{ProjectServer} with multiple manifests] +endif::[] When creating a Red{nbsp}Hat subscription manifest: * Add the subscription for {ProjectServer} to the manifest if planning a disconnected or self-registered {ProjectServer}. This is not necessary for a connected {ProjectServer} that is subscribed using the Subscription Manager utility on the base system. - * Add subscriptions for all {SmartProxyServers} you want to create. - * Add subscriptions for all Red{nbsp}Hat products you want to manage with {Project}. - * Note the date when the subscriptions are due to expire and plan for their renewal before the expiry date. - * Create one manifest per organization. You can use multiple manifests and they can be from different Red Hat subscriptions. diff --git a/guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc b/guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc index 5f909e8ce15..81cbe89ea50 100644 --- a/guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc +++ b/guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc @@ -2,3 +2,6 @@ = Additional resources * For information about how to provision hosts with {Project}, see {ProvisioningDocURL}[_{ProvisioningDocTitle}_]. +ifdef::orcharhino[] +* For more information about compute resource providers, see xref:sources/compute_resources.adoc[Compute Resources]. +endif::[] diff --git a/guides/common/modules/con_provisioning-methods-in-project.adoc b/guides/common/modules/con_provisioning-methods-in-project.adoc index dc9cf4e6fbd..c58b7fd5717 100644 --- a/guides/common/modules/con_provisioning-methods-in-project.adoc +++ b/guides/common/modules/con_provisioning-methods-in-project.adoc @@ -26,7 +26,3 @@ When provisioning virtual machines with {Project}, you can do the following: + * Provision virtual machines from virtual image templates. * Use the same PXE-based boot methods that you use to provision bare-metal hosts. - -ifdef::orcharhino[] -For more information, see xref:sources/compute_resources.adoc[compute resources]. -endif::[] diff --git a/guides/common/modules/con_pxe-sequence.adoc b/guides/common/modules/con_pxe-sequence.adoc index 1c04187c422..a1958aa2ed0 100644 --- a/guides/common/modules/con_pxe-sequence.adoc +++ b/guides/common/modules/con_pxe-sequence.adoc @@ -8,4 +8,5 @@ . The host configuration specifies the location of a kernel image, `initrd` and Kickstart. . The host downloads the files and installs the image. -For an example of using PXE Booting by {ProjectServer}, see {ProvisioningDocURL}provisioning-workflow_provisioning[Provisioning Workflow] in _{ProvisioningDocTitle}_. +.Additional resources +* For more information about PXE Booting, see {ProvisioningDocURL}Network_Boot_Provisioning_Workflow_provisioning[Network boot provisioning workflow] in _{ProvisioningDocTitle}_. diff --git a/guides/common/modules/con_remote-execution-in-project.adoc b/guides/common/modules/con_remote-execution-in-project.adoc index aea3de6c756..bb66ae96d93 100644 --- a/guides/common/modules/con_remote-execution-in-project.adoc +++ b/guides/common/modules/con_remote-execution-in-project.adoc @@ -24,14 +24,14 @@ ifdef::managing-hosts[] For more information, see xref:Template_Writing_Reference_{context}[]. endif::[] ifndef::managing-hosts[] -For more information, see {ManagingHostsDocURL}Template_Writing_Reference_managing-hosts[Template Writing Reference] in _{ManagingHostsDocTitle}_. +For more information, see {ManagingHostsDocURL}Template_Writing_Reference_managing-hosts[Template writing reference] in _{ManagingHostsDocTitle}_. endif::[] By default, {Project} includes several job templates for shell scripts and Ansible. -For more information, see {ManagingHostsDocURL}setting-up-job-templates_managing-hosts[Setting up Job Templates] in _{ManagingHostsDocTitle}_. +For more information, see {ManagingHostsDocURL}setting-up-job-templates_managing-hosts[Setting up job templates] in _{ManagingHostsDocTitle}_. .Additional resources -* See {ManagingHostsDocURL}executing-a-remote-job_managing-hosts[Executing a Remote Job] in _{ManagingHostsDocTitle}_. +* See {ManagingHostsDocURL}executing-a-remote-job_managing-hosts[Executing a remote job] in _{ManagingHostsDocTitle}_. ifeval::["{context}" == "planning"] -* See {ManagingConfigurationsAnsibleDocURL}Configuring_and_Setting_Up_Remote_Jobs_ansible[Configuring and Setting Up Remote Jobs] in _{ManagingConfigurationsAnsibleDocTitle}_. +* See {ManagingConfigurationsAnsibleDocURL}Configuring_and_Setting_Up_Remote_Jobs_ansible[Configuring and setting up remote jobs] in _{ManagingConfigurationsAnsibleDocTitle}_. endif::[] diff --git a/guides/common/modules/con_smartproxy-features.adoc b/guides/common/modules/con_smartproxy-features.adoc index a7b0b6ee582..b41acf56c17 100644 --- a/guides/common/modules/con_smartproxy-features.adoc +++ b/guides/common/modules/con_smartproxy-features.adoc @@ -1,20 +1,15 @@ [id="{SmartProxy}-Features_{context}"] = {SmartProxy} features -ifdef::satellite,orcharhino[] +ifdef::katello,satellite,orcharhino[] {SmartProxyServers} provide local host management services and can mirror content from {ProjectServer}. endif::[] -ifndef::satellite,orcharhino[] +ifdef::foreman-el,foreman-deb[] {SmartProxyServers} provide local host management services. -With the Katello plugin, they can also mirror content from {ProjectServer}. endif::[] -ifdef::satellite,orcharhino[] +ifdef::katello,satellite,orcharhino[] To mirror content from {ProjectServer}, {SmartProxy} provides the following functionalities: -endif::[] -ifndef::satellite,orcharhino[] -If you have the Katello plugin installed, you can use {SmartProxy} to mirror content from {ProjectServer}: -endif::[] Repository synchronization:: {SmartProxyServers} pull content for selected lifecycle environments from {ProjectServer} and make this content available to the hosts they manage. @@ -29,6 +24,11 @@ Red Hat Subscription Management (RHSM) proxy:: Hosts are registered to their associated {SmartProxyServers} rather than to the central {ProjectServer} or the Red{nbsp}Hat Customer Portal. You can use {SmartProxy} to run the following services for infrastructure and host management: +endif::[] + +ifdef::foreman-el,foreman-deb[] +{SmartProxies} provide the following functionalities: +endif::[] DHCP:: {SmartProxy} can manage a DHCP server, including integration with an existing solution, such as ISC DHCP servers, Active Directory, and Libvirt instances. @@ -67,6 +67,7 @@ Common configurations include the following: Infrastructure {SmartProxies}: DNS + DHCP + TFTP:: {SmartProxies} with these services provide infrastructure services for hosts and have all necessary services for provisioning new hosts. +ifdef::katello,satellite,orcharhino[] Content {SmartProxies}: Pulp:: {SmartProxies} with this service provide content synchronized from {ProjectServer} to hosts. @@ -76,3 +77,4 @@ Configuration {SmartProxies}: Pulp + Puppet + PuppetCA:: {SmartProxies} with DNS + DHCP + TFTP + Pulp + Puppet + PuppetCA:: {SmartProxies} with these services provide a full set of {SmartProxy} features. By configuring a {SmartProxy} with all these features, you can isolate hosts assigned to that {SmartProxy} by providing a single point of connection for the hosts. +endif::[] diff --git a/guides/common/modules/con_smartproxy-networking.adoc b/guides/common/modules/con_smartproxy-networking.adoc index dc82d950c2a..d784141781c 100644 --- a/guides/common/modules/con_smartproxy-networking.adoc +++ b/guides/common/modules/con_smartproxy-networking.adoc @@ -8,33 +8,27 @@ Many of the services that {SmartProxyServer} manages use dedicated network ports However, {SmartProxyServer} ensures that all communications from the host to {ProjectServer} use a single source IP address, which simplifies firewall administration. .{Project} topology with hosts connecting to a {SmartProxy} - In this topology, {SmartProxy} provides a single endpoint for all host network communications so that in remote network segments, only firewall ports to the {SmartProxy} itself must be open. -ifndef::satellite[] -include::snip_red-hat-images.adoc[] -endif::[] - +// TODO: Replace graphic with simpler graphic and reference to "Port and firewall requirements" +ifdef::satellite[] .How {Project} components interact when hosts connect to a {SmartProxy} -image::topology-isolated-satellite.png[{ProjectName} topology with a host] +image::common/topology-isolated-satellite.png[{ProjectName} topology with a host] +endif::[] .{Project} topology with hosts connecting directly to {ProjectServer} - In this topology, hosts connect to {ProjectServer} rather than a {SmartProxy}. This applies also to {SmartProxies} themselves because the {SmartProxyServer} is a host of {ProjectServer}. -ifndef::satellite,orcharhino[] -include::snip_red-hat-images.adoc[] -endif::[] - +// TODO: Replace graphic with simpler graphic and reference to "Port and firewall requirements" +ifdef::satellite[] .How {Project} components interact when hosts connect directly to {ProjectServer} -image::topology-direct-satellite.png[{ProjectName} topology with a direct host] +image::common/topology-direct-satellite.png[{ProjectName} topology with a direct host] +endif::[] .Additional resources -You can find complete instructions for configuring the host-based firewall to open the required ports in the following documents: - -* {InstallingServerDocURL}Ports_and_Firewalls_Requirements_{project-context}[Ports and Firewalls Requirements] in _{InstallingServerDocTitle}_ +* {InstallingServerDocURL}Port_and_firewall_requirements_{project-context}[Ports and firewall requirements] in _{InstallingServerDocTitle}_ ifdef::satellite[] -* {InstallingServerDisconnectedDocURL}Ports_and_Firewalls_Requirements_{project-context}[Ports and Firewalls Requirements] in _{InstallingServerDisconnectedDocTitle}_ +* {InstallingServerDisconnectedDocURL}Port_and_firewall_requirements_{project-context}[Ports and firewall requirements] in _{InstallingServerDisconnectedDocTitle}_ endif::[] -* {InstallingSmartProxyDocURL}capsule-ports-and-firewalls-requirements_{smart-proxy-context}[Ports and Firewalls Requirements] in _{InstallingSmartProxyDocTitle}_ +* {InstallingSmartProxyDocURL}{smart-proxy-context}-port-and-firewall-requirements_{smart-proxy-context}[Ports and firewall requirements] in _{InstallingSmartProxyDocTitle}_ diff --git a/guides/common/modules/con_smartproxy-overview.adoc b/guides/common/modules/con_smartproxy-overview.adoc index 225c49956c0..6084604ca54 100644 --- a/guides/common/modules/con_smartproxy-overview.adoc +++ b/guides/common/modules/con_smartproxy-overview.adoc @@ -1,4 +1,4 @@ -[id="{SmartProxy}-Overview_{context}"] +[id="{smart-proxy-context}-Overview_{context}"] = {SmartProxy} overview With {SmartProxyServers}, you can extend the reach and scalability of your {Project} deployment. @@ -9,4 +9,4 @@ By registering a host to a {SmartProxyServer}, you can configure this host to re * Running localized services to discover, provision, control, and configure hosts. By using content views, you can specify the exact subset of content that {SmartProxyServer} makes available to hosts. -For more information, see xref:Content-and-Patch-Management-with-{Project}_{context}[]. +For more information, see xref:content-and-patch-management-with-{project-context}[]. diff --git a/guides/common/modules/con_supported-usage-of-project-components.adoc b/guides/common/modules/con_supported-usage-of-project-components.adoc index 8adce06745f..8e9ef3ab79b 100644 --- a/guides/common/modules/con_supported-usage-of-project-components.adoc +++ b/guides/common/modules/con_supported-usage-of-project-components.adoc @@ -3,11 +3,13 @@ Usage of all {ProjectName} components is supported within the context of {ProjectName} only as described below. +ifdef::satellite[] {RHELServer}:: Each {ProjectName} subscription includes one supported instance of {RHELServer}. Reserve this instance solely for the purpose of running {ProjectName}. + Not supported: Using the operating system included with {Project} to run other daemons, applications, or services within your environment. +endif::[] SELinux:: Ensure SELinux is in enforcing or permissive mode. @@ -16,12 +18,16 @@ Not supported: Installation with disabled SELinux. Foreman:: You can extend Foreman with plugins packaged with {ProjectName}. +ifdef::satellite[] See https://access.redhat.com/articles/1343683[Satellite 6 Component Versions] in Red{nbsp}Hat Knowledgebase for information about supported Foreman plugins. + Not supported: Extending Foreman with plugins in the _{ProjectName} Optional_ repository. + -{ProjectName} also includes components, configuration, and functionality to provision and configure operating systems other than {RHEL}. +endif::[] +{ProjectName} also includes components, configuration, and functionality to provision and configure operating systems other than {EL}. +ifdef::satellite[] While these features are included, Red{nbsp}Hat supports their usage only for {RHEL}. +endif::[] Pulp:: Interact with Pulp only by using the {ProjectWebUI}, CLI, and API. @@ -44,6 +50,8 @@ Puppet:: When you run the {Project} installation program, you can install and configure Puppet servers as part of {SmartProxyServers}. A Puppet module, running on a Puppet server on your {ProjectServer} or any {SmartProxyServer}, is also supported by {Team}. +ifdef::satellite[] .Additional resources * Red{nbsp}Hat supports many different scripting and other frameworks. See https://access.redhat.com/articles/369183[How does Red{nbsp}Hat support scripting frameworks] in Red{nbsp}Hat Knowledgebase. +endif::[] diff --git a/guides/common/modules/con_synchronizing-content-between-servers.adoc b/guides/common/modules/con_synchronizing-content-between-servers.adoc index 154add5d5b5..747513a8544 100644 --- a/guides/common/modules/con_synchronizing-content-between-servers.adoc +++ b/guides/common/modules/con_synchronizing-content-between-servers.adoc @@ -1,5 +1,5 @@ [id="Synchronizing_Content_Between_Servers_{context}"] -= Synchronizing content between {ProjectServerTitle}s += Synchronizing content between {ProjectServer}s In a {Project} setup with multiple {ProjectServer}s, you can use {ISS} (ISS) to synchronize content from one upstream server to one or more downstream servers. diff --git a/guides/common/modules/con_web-ui-overview.adoc b/guides/common/modules/con_web-ui-overview.adoc index c55f25badd3..b78af5fc35e 100644 --- a/guides/common/modules/con_web-ui-overview.adoc +++ b/guides/common/modules/con_web-ui-overview.adoc @@ -10,8 +10,10 @@ For example, you can use the following navigation features in the {ProjectWebUI} | *Organization* dropdown | Choose the organization you want to manage. | *Location* dropdown | Choose the location you want to manage. | *Monitor* | Provides summary dashboards and reports. +ifdef::katello,orcharhino,satellite[] | *Content* | Provides content management tools. This includes content views, activation keys, and lifecycle environments. +endif::[] | *Hosts* | Provides host inventory and provisioning configuration tools. | *Configure* | Provides general configuration tools and data, including host groups and Ansible content. | *Infrastructure* | Provides tools on configuring how {Project} interacts with the environment. diff --git a/guides/common/modules/proc_adding-project-server-to-awx-as-a-dynamic-inventory-item.adoc b/guides/common/modules/proc_adding-project-server-to-awx-as-a-dynamic-inventory-item.adoc index eac2d568736..f48bcb3d709 100644 --- a/guides/common/modules/proc_adding-project-server-to-awx-as-a-dynamic-inventory-item.adoc +++ b/guides/common/modules/proc_adding-project-server-to-awx-as-a-dynamic-inventory-item.adoc @@ -7,7 +7,7 @@ To add {ProjectServer} to {awx} as a dynamic inventory item, you must create a c * If your {Project} deployment is large, for example, managing tens of thousands of hosts, using a non-admin user can negatively impact performance because of time penalties that accrue during authorization checks. For large deployments, consider using an admin user. * For non-admin users, you must assign the `Ansible Tower Inventory Reader` role to your {ProjectServer} user. -For more information about managing users, roles, and permission filters, see {AdministeringDocURL}Creating_and_Managing_Roles_admin[Creating and Managing Roles] in _{AdministeringDocTitle}_. +For more information about managing users, roles, and permission filters, see {AdministeringDocURL}creating-and-managing-roles[Creating and managing roles] in _{AdministeringDocTitle}_. * You must host your {ProjectServer} and {awx} on the same network or subnet. .Procedure diff --git a/guides/common/modules/proc_configuring-server-to-consume-content-from-a-custom-cdn.adoc b/guides/common/modules/proc_configuring-server-to-consume-content-from-a-custom-cdn.adoc index c5037c29ad8..ddcf370e718 100644 --- a/guides/common/modules/proc_configuring-server-to-consume-content-from-a-custom-cdn.adoc +++ b/guides/common/modules/proc_configuring-server-to-consume-content-from-a-custom-cdn.adoc @@ -1,5 +1,5 @@ [id="configuring-{project-context}-server-to-consume-content-from-a-custom-cdn_{context}"] -= Configuring {ProjectServerTitle} to consume content from a custom CDN += Configuring {ProjectServer} to consume content from a custom CDN If you have an internal Content Delivery Network (CDN) or serve content on an accessible web server, you can configure your {ProjectServer} to consume Red{nbsp}Hat repositories from this CDN server instead of the Red{nbsp}Hat CDN. A CDN server can be any web server that mirrors repositories in the same directory structure as the Red{nbsp}Hat CDN. diff --git a/guides/common/modules/proc_enabling-client-connections-to-satellite.adoc b/guides/common/modules/proc_enabling-client-connections-to-satellite.adoc index 8011e31fb6e..93276f7fe58 100644 --- a/guides/common/modules/proc_enabling-client-connections-to-satellite.adoc +++ b/guides/common/modules/proc_enabling-client-connections-to-satellite.adoc @@ -4,7 +4,7 @@ {SmartProxies} and Content Hosts that are clients of a {ProjectServer}'s internal {SmartProxy} require access through {Project}'s host-based firewall and any network-based firewalls. Use this procedure to configure the host-based firewall on the system that {Project} is installed on, to enable incoming connections from Clients, and to make the configuration persistent across system reboots. -For more information on the ports used, see {InstallingServerDocURL}{project-context}-port-and-firewall-requirements_{project-context}[Port and firewall requirements] in _{InstallingServerDocTitle}_. +For more information on the ports used, see {InstallingServerDocURL}Port_and_firewall_requirements_{project-context}[Port and firewall requirements] in _{InstallingServerDocTitle}_. include::snip_firewalld.adoc[] diff --git a/guides/common/modules/proc_installing-python-packages-from-server.adoc b/guides/common/modules/proc_installing-python-packages-from-server.adoc index 756c29983ff..72d6503b018 100644 --- a/guides/common/modules/proc_installing-python-packages-from-server.adoc +++ b/guides/common/modules/proc_installing-python-packages-from-server.adoc @@ -1,5 +1,5 @@ [id="Installing_Python_Packages_from_{project-context}_Server_{context}"] -= Installing Python packages from {ProjectServerTitle} += Installing Python packages from {ProjectServer} You can install Python packages from {Project} on hosts using `pip`. diff --git a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script.adoc b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script.adoc index 3c035328428..7b9b7aa280e 100644 --- a/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script.adoc +++ b/guides/common/modules/proc_setting-permissions-for-the-bootstrap-script.adoc @@ -56,4 +56,4 @@ $ hammer user add-role --id _user_id_ --role _Bootstrap_ ---- + Alternatively, you can create a new user and assign this new role to them. -For more information on creating users with Hammer, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing Users and Roles] in _{AdministeringDocTitle}_. +For more information on creating users with Hammer, see {AdministeringDocURL}Managing_Users_and_Roles_admin[Managing users and roles] in _{AdministeringDocTitle}_. diff --git a/guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc b/guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc index a5329b4c9e9..d8e194e136b 100644 --- a/guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc +++ b/guides/common/modules/proc_upgrading-a-disconnected-project-server.adoc @@ -23,9 +23,8 @@ endif::[] ==== .Before you begin - * Review and update your firewall configuration before upgrading your {ProjectServer}. -For more information, see {InstallingServerDisconnectedDocURL}Port_and_firewall_requirements_satellite[Port and firewall requirements] in _{InstallingServerDisconnectedDocTitle}_. +For more information, see {InstallingServerDisconnectedDocURL}Port_and_firewall_requirements_{project-context}[Port and firewall requirements] in _{InstallingServerDisconnectedDocTitle}_. * Ensure that you do not delete the manifest from the Customer Portal or in the {ProjectWebUI} because this removes all the entitlements of your content hosts. ifdef::satellite[] * All {ProjectServer}s must be on the same version. @@ -33,7 +32,6 @@ endif::[] .Upgrade disconnected {ProjectServer} - . Stop all {Project} services: + [options="nowrap" subs="+quotes,verbatim,attributes"] diff --git a/guides/common/modules/ref_configuring-external-authentication-in-foreman.adoc b/guides/common/modules/ref_configuring-external-authentication-in-foreman.adoc new file mode 100644 index 00000000000..c510764f385 --- /dev/null +++ b/guides/common/modules/ref_configuring-external-authentication-in-foreman.adoc @@ -0,0 +1,7 @@ +[id="configuring-external-authentication-in-{project-context}"] += Configuring external authentication in {Project} + +include::snip_table-authentication-methods.adoc[] + +.Additional resources +* For more information, see {ConfiguringUserAuthenticationDocURL}[_{ConfiguringUserAuthenticationDocTitle}_]. diff --git a/guides/common/modules/ref_list-of-key-open-source-components-of-foreman-server.adoc b/guides/common/modules/ref_list-of-key-open-source-components-of-foreman.adoc similarity index 86% rename from guides/common/modules/ref_list-of-key-open-source-components-of-foreman-server.adoc rename to guides/common/modules/ref_list-of-key-open-source-components-of-foreman.adoc index f3bec3b2387..ac0f8a62b08 100644 --- a/guides/common/modules/ref_list-of-key-open-source-components-of-foreman-server.adoc +++ b/guides/common/modules/ref_list-of-key-open-source-components-of-foreman.adoc @@ -1,5 +1,5 @@ -[id="List-of-Key-System-Components-of-{ProjectServerID}_{context}"] -= List of key open source components of {ProjectServerTitle} +[id="list-of-key-open-source-components-of-{project-context}"] += List of key open source components of {Project} {Project} consists of several open source projects integrated with each other, such as the following: @@ -7,10 +7,10 @@ Foreman:: Foreman is a lifecycle management application for physical and virtual It helps manage hosts throughout their lifecycle, from provisioning and configuration to orchestration and monitoring. Katello:: Katello is -ifdef::satellite[] +ifdef::satellite,orcharhino[] a plugin endif::[] -ifndef::satellite[] +ifndef::satellite,orcharhino[] an optional plugin endif::[] of Foreman that extends Foreman capabilities with additional features for content, subscription, and repository management. @@ -31,4 +31,4 @@ ifdef::satellite[] [role="_additional-resources"] .Additional resources * See https://access.redhat.com/articles/1343683[Satellite 6 Component Versions] for a complete list of the upstream components integrated into {Project} and for information about which upstream component versions were delivered with different versions of {Project}. -endif::[] \ No newline at end of file +endif::[] diff --git a/guides/common/modules/ref_overview-of-authentication-methods-in-foreman.adoc b/guides/common/modules/ref_overview-of-authentication-methods-in-foreman.adoc new file mode 100644 index 00000000000..7d068fa146c --- /dev/null +++ b/guides/common/modules/ref_overview-of-authentication-methods-in-foreman.adoc @@ -0,0 +1,4 @@ +[id="overview-of-authentication-methods-in-{project-context}"] += Overview of authentication methods in {Project} + +include::snip_table-authentication-methods.adoc[] diff --git a/guides/common/modules/ref_predefined-roles-available-in-project.adoc b/guides/common/modules/ref_predefined-roles-available-in-project.adoc index 33739b4df1d..58413444fce 100644 --- a/guides/common/modules/ref_predefined-roles-available-in-project.adoc +++ b/guides/common/modules/ref_predefined-roles-available-in-project.adoc @@ -1,4 +1,4 @@ -[id="Predefined_Roles_Available_in_{project-context}_{context}"] +[id="predefined-roles-available-in-{project-context}"] = Predefined roles available in {Project} The following table provides an overview of permissions that predefined roles in {Project} grant to a user. diff --git a/guides/common/modules/ref_technical-users-provided-and-required-by-foreman.adoc b/guides/common/modules/ref_technical-users-provided-and-required-by-foreman.adoc index e05be68e717..75d23367cfa 100644 --- a/guides/common/modules/ref_technical-users-provided-and-required-by-foreman.adoc +++ b/guides/common/modules/ref_technical-users-provided-and-required-by-foreman.adoc @@ -1,8 +1,8 @@ [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. @@ -10,7 +10,7 @@ Because some of the accounts have hard-coded UIDs and GIDs, it is not possible t 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. diff --git a/guides/common/modules/snip_creating-and-managing-roles.adoc b/guides/common/modules/snip_creating-and-managing-roles.adoc new file mode 100644 index 00000000000..6062ff8feb0 --- /dev/null +++ b/guides/common/modules/snip_creating-and-managing-roles.adoc @@ -0,0 +1,26 @@ +Users in {Project} can have one or more roles assigned. +These roles are associated with permissions that enable users to perform specified administrative actions in {Project}. +Permission filters define the actions allowed for a certain resource type. + +{Project} provides a set of predefined roles with permissions sufficient for standard tasks. +You can also configure custom roles. + +[NOTE] +==== +One of the predefined roles is the *Default role*. +{Project} assigns the *Default role* to every user in the system. +By default, the *Default role* grants only a limited set of permissions. +Be aware that if you add a permission to the *Default role*, every {Project} users will gain that permission. +Assigning a different role to a user does not remove the *Default role* from the user. +==== + +The following types of roles are commonly defined within various {Project} deployments: + +Roles related to applications or parts of infrastructure:: +For example, roles for owners of {client-os} as the operating system as opposed to roles for owners of application servers and database servers. + +Roles related to a particular stage of the software lifecycle:: +For example, roles divided among the development, testing, and production phases, where each phase has one or more owners. + +Roles related to specific tasks:: +For example, you can create a role for security managers and a role for license managers, depending on the specific tasks users need to be able to perform within your organization. diff --git a/guides/common/modules/ref_overview-of-authentication-methods-in-project.adoc b/guides/common/modules/snip_table-authentication-methods.adoc similarity index 84% rename from guides/common/modules/ref_overview-of-authentication-methods-in-project.adoc rename to guides/common/modules/snip_table-authentication-methods.adoc index 1d8058744b4..0e8070005d3 100644 --- a/guides/common/modules/ref_overview-of-authentication-methods-in-project.adoc +++ b/guides/common/modules/snip_table-authentication-methods.adoc @@ -1,11 +1,3 @@ -[id="overview-of-authentication-methods-in-{project-context}_{context}"] -ifeval::["{context}" == "authentication"] -= Overview of authentication methods in {Project} -endif::[] -ifeval::["{context}" == "planning"] -= Configuring external authentication in {Project} -endif::[] - {ProjectName} includes native support for authentication with a username and password. If you require additional methods of authentication, configure your {ProjectServer} to use an external authentication source. @@ -98,8 +90,3 @@ endif::[] |xref:configuring-an-ldap-server-as-an-external-identity-provider-for-project_{context}[] |==== endif::[] - -ifeval::["{context}" == "planning"] -.Additional resources -* For more information, see {ConfiguringUserAuthenticationDocURL}[_{ConfiguringUserAuthenticationDocTitle}_]. -endif::[] diff --git a/guides/doc-Configuring_User_Authentication/master.adoc b/guides/doc-Configuring_User_Authentication/master.adoc index 462256847a0..516a45b2027 100644 --- a/guides/doc-Configuring_User_Authentication/master.adoc +++ b/guides/doc-Configuring_User_Authentication/master.adoc @@ -14,7 +14,7 @@ ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] endif::[] -include::common/modules/ref_overview-of-authentication-methods-in-project.adoc[leveloffset=+1] +include::common/modules/ref_overview-of-authentication-methods-in-foreman.adoc[leveloffset=+1] include::common/assembly_accessing-server.adoc[leveloffset=+1] diff --git a/guides/doc-Planning_for_Project/master.adoc b/guides/doc-Planning_for_Project/master.adoc index 0b552c71486..716606a09ec 100644 --- a/guides/doc-Planning_for_Project/master.adoc +++ b/guides/doc-Planning_for_Project/master.adoc @@ -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] @@ -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: diff --git a/guides/image-sources/planning-for-foreman.drawio b/guides/image-sources/planning-for-foreman.drawio new file mode 100644 index 00000000000..826daa2bdd5 --- /dev/null +++ b/guides/image-sources/planning-for-foreman.drawio @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +