diff --git a/.cursor/skills/abstract/SKILL.md b/.cursor/skills/abstract/SKILL.md index edd7f7ea145..11aa813866f 100644 --- a/.cursor/skills/abstract/SKILL.md +++ b/.cursor/skills/abstract/SKILL.md @@ -8,11 +8,49 @@ description: Review or write abstract Review and improve the abstract for this file. Write it if it doesn't exist yet. +## Definition of an abstract + +An abstract is the first paragraph of the module. +It follows after the module heading. +It is prefixed by the `[role="_abstract"]` AsciiDoc tag. + +Abstracts, also called short descriptions, help readers and AI-powered search tools find the information that they need and confirm that they are in the right place. + +Abstracts typically contain the following information: + +- The "What" +- The "Why" +- Where appropriate, an example use case + ## Instructions -Follow these principles: +When reviewing or writing the abstract, follow these principles: + +- Ensure the abstract explains the What and the Why as defined in the section "Definition of an abstract". + - For the `What` part, state the action or feature clearly. For example, what the user must do or can do (in procedure modules), what the user needs to understand (in concept modules), or what is being listed (in reference modules). + - For the `Why` part, state the business value, benefit, or goal. For example, why the user should complete the action (in procedure modules), why the concept is important to users (in concept modules), or why the user would look up the information (in reference modules). + - For the `Example use case part`, consider including in what situations a user might find the contents of the module useful. + - Do not simply repeat the heading of the module; build upon it. +- Follow these user-centric language guidelines: + - Avoid documentation self-referential language (for example: avoid "This procedure..." or "This module"). + - Avoid feature-centric language (for example: avoid "This feature..."). + - Use user-centric language (for example: use phrases such as "You can [action] to [benefit]", "To [goal], configure [feature]", "[Action] [what] to [why]"). +- Follow these length constraints: 50-300 characters, 1-2 sentences, a single paragraph. + +## Examples of good abstracts + +| Heading | Example abstract (procedure) | +| :--- | :--- | +| Browsing hosts in {ProjectWebUI} | Find and categorize your hosts within {Project} to get a quick overview of your managed infrastructure. Browsing hosts helps you understand your environment and identify specific host types for targeted actions. | +| Cloning hosts in {Project} | Clone existing hosts in {Project} to quickly create new hosts with similar configurations. This streamlines deployment processes and improves consistency across your environment. | +| Editing system purpose | Edit the system purpose attributes for your Red Hat Enterprise Linux hosts to help ensure they receive correct subscriptions and accurate reporting. This optimizes license compliance and management. | + +| Heading | Example abstract (concept) | +| :--- | :--- | +| Security considerations in {Project} | {Project} supports multiple security mechanisms to provide additional layers of protection. Implementing these security features enhances the overall security of your {Project} deployment. | +| Overview of authentication methods in {Project} | The authentication methods you can configure depend on the authentication source you are using. If the native authentication features provided by {Project} are not sufficient for your use case, use this information to decide which external authentication provider best suits your requirements. | -* Make the abstract 50-300 characters long. -* Do not use documentation self-referential language (for example: avoid "This procedure..." or "This module"). -* Use user-centric language (for example: "You can...") rather than product-centric language (for example: "This feature..."). -* Where appropriate, include an example use case (for example: the reason why and when a user might find the contents of the module useful). +| Heading | Example abstract (reference) | +| :--- | :--- | +| Subscriptions usage data | For the purposes of expense management and to optimize your spending, track your subscriptions usage data that you can get from your {Project} environment and Red Hat. You can track usage, capacity, and utilization of your Red Hat subscriptions. | +| Host global status overview | You can use the host global status in {Project} to see at a glance whether a host is OK, needs attention (Warning), or has errors. The status appears on the Hosts Overview page and helps you prioritize which hosts to investigate. | diff --git a/guides/common/assembly_api-call-authentication.adoc b/guides/common/assembly_api-call-authentication.adoc index df9070f9343..ed1d5c020c2 100644 --- a/guides/common/assembly_api-call-authentication.adoc +++ b/guides/common/assembly_api-call-authentication.adoc @@ -5,7 +5,7 @@ include::modules/con_api-call-authentication.adoc[] include::modules/con_ssl-authentication-overview.adoc[leveloffset=+1] ifdef::katello,orcharhino,satellite[] -include::modules/proc_configuring-ssl-authentication.adoc[leveloffset=+2] +include::modules/proc_configuring-ssl-authentication.adoc[leveloffset=+1] endif::[] include::modules/con_http-authentication-overview.adoc[leveloffset=+1] diff --git a/guides/common/assembly_backing-up-server-and-proxy.adoc b/guides/common/assembly_backing-up-server-and-proxy.adoc index 375800ad277..b217d6c72d8 100644 --- a/guides/common/assembly_backing-up-server-and-proxy.adoc +++ b/guides/common/assembly_backing-up-server-and-proxy.adoc @@ -2,6 +2,8 @@ include::modules/con_backing-up-server-and-proxy.adoc[] +include::modules/con_backup-process-overview.adoc[leveloffset=+1] + ifdef::katello,orcharhino,satellite[] include::modules/proc_estimating-the-size-of-a-backup.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_building-cloud-images.adoc b/guides/common/assembly_building-cloud-images.adoc index 93f7489a276..92b8ea8eed0 100644 --- a/guides/common/assembly_building-cloud-images.adoc +++ b/guides/common/assembly_building-cloud-images.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY -include::modules/con_building-cloud-images.adoc[] +include::modules/ref_building-cloud-images.adoc[] include::modules/ref_host-requirements-for-custom-images.adoc[leveloffset=+1] diff --git a/guides/common/assembly_configuring-project-for-performance.adoc b/guides/common/assembly_configuring-project-for-performance.adoc index a4b36b8b54a..a1a09aef7a4 100644 --- a/guides/common/assembly_configuring-project-for-performance.adoc +++ b/guides/common/assembly_configuring-project-for-performance.adoc @@ -34,7 +34,7 @@ endif::[] include::modules/proc_tuning-postgresql.adoc[leveloffset=+1] -include::modules/con_benchmarking-raw-db-performance.adoc[leveloffset=+2] +include::modules/proc_benchmarking-raw-database-performance.adoc[leveloffset=+2] include::modules/con_redis-tuning.adoc[leveloffset=+1] diff --git a/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc b/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc index 1e4e284f13f..e99f603f275 100644 --- a/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc +++ b/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc @@ -13,3 +13,5 @@ include::modules/proc_deploying-a-custom-ssl-certificate-to-foreman-server.adoc[ :common-example-com: {foreman-example-com} include::modules/proc_deploying-a-custom-ssl-certificate-to-hosts.adoc[leveloffset=+1] :!common-example-com: + +include::modules/proc_deploying-a-custom-ssl-certificate-to-smartproxies.adoc[leveloffset=+1] diff --git a/guides/common/assembly_content-access-control-for-hosts.adoc b/guides/common/assembly_content-access-control-for-hosts.adoc index 0217bd2d786..30e253879bd 100644 --- a/guides/common/assembly_content-access-control-for-hosts.adoc +++ b/guides/common/assembly_content-access-control-for-hosts.adoc @@ -2,7 +2,7 @@ include::modules/con_content-access-control-for-hosts.adoc[] -include::modules/con_content-access-strategies.adoc[leveloffset=+1] +include::modules/ref_content-access-strategies.adoc[leveloffset=+1] include::modules/con_conditions-for-content-availability.adoc[leveloffset=+1] diff --git a/guides/common/assembly_example-playbooks-based-on-modules-from-project-ansible-collection.adoc b/guides/common/assembly_example-playbooks-based-on-modules-from-project-ansible-collection.adoc index 900608b7d25..1f066a05210 100644 --- a/guides/common/assembly_example-playbooks-based-on-modules-from-project-ansible-collection.adoc +++ b/guides/common/assembly_example-playbooks-based-on-modules-from-project-ansible-collection.adoc @@ -2,6 +2,8 @@ include::modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc[] +include::modules/ref_help-resources-for-example-playbooks-from-project-ansible-collection.adoc[leveloffset=+1] + include::modules/ref_playbook-example-enable-repositories-and-create-a-content-view.adoc[leveloffset=+1] include::modules/ref_playbook-example-synchronize-repositories-and-publish-a-content-view.adoc[leveloffset=+1] diff --git a/guides/common/assembly_introduction-to-managing-content.adoc b/guides/common/assembly_introduction-to-managing-content.adoc index ba903435327..84ef07a10c3 100644 --- a/guides/common/assembly_introduction-to-managing-content.adoc +++ b/guides/common/assembly_introduction-to-managing-content.adoc @@ -2,4 +2,6 @@ include::modules/con_introduction-to-content-management.adoc[] +include::modules/ref_content-management-capabilities-in-project.adoc[leveloffset=+1] + include::modules/con_content-types-in-project.adoc[leveloffset=+1] diff --git a/guides/common/assembly_managing-content-views.adoc b/guides/common/assembly_managing-content-views.adoc index 23630a5fa04..ef226aa98c9 100644 --- a/guides/common/assembly_managing-content-views.adoc +++ b/guides/common/assembly_managing-content-views.adoc @@ -2,6 +2,8 @@ include::modules/con_managing-content-views.adoc[] +include::modules/ref_workflow-for-creating-content-views.adoc[leveloffset=+1] + include::modules/con_content-views-in-project.adoc[leveloffset=+1] include::modules/ref_best-practices-for-content-views.adoc[leveloffset=+1] diff --git a/guides/common/assembly_managing-errata.adoc b/guides/common/assembly_managing-errata.adoc index 9b3feda31f4..a4ba2e0190f 100644 --- a/guides/common/assembly_managing-errata.adoc +++ b/guides/common/assembly_managing-errata.adoc @@ -36,7 +36,7 @@ endif::[] include::modules/con_applying-errata-to-hosts.adoc[leveloffset=+1] -include::modules/con_prerequisites-for-applying-errata.adoc[leveloffset=+2] +include::modules/ref_prerequisites-for-applying-errata.adoc[leveloffset=+2] include::modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc[leveloffset=+2] diff --git a/guides/common/assembly_migrating-from-internal-databases-to-external-databases.adoc b/guides/common/assembly_migrating-from-internal-databases-to-external-databases.adoc index 8c59e914f54..4eaca3f227c 100644 --- a/guides/common/assembly_migrating-from-internal-databases-to-external-databases.adoc +++ b/guides/common/assembly_migrating-from-internal-databases-to-external-databases.adoc @@ -4,7 +4,7 @@ ifdef::context[:parent-context: {context}] include::modules/con_migrating-from-internal-databases-to-external-databases.adoc[] -include::modules/con_postgresql-as-an-external-database-considerations.adoc[leveloffset=+1] +include::modules/ref_postgresql-as-an-external-database-considerations.adoc[leveloffset=+1] include::modules/proc_installing-postgresql.adoc[leveloffset=+1] diff --git a/guides/common/assembly_planning-project-server-installation.adoc b/guides/common/assembly_planning-project-server-installation.adoc index 1148f5c7ecf..e264634433c 100644 --- a/guides/common/assembly_planning-project-server-installation.adoc +++ b/guides/common/assembly_planning-project-server-installation.adoc @@ -16,4 +16,4 @@ ifeval::["{mode}" == "connected"] include::modules/ref_ipv6-and-ipv4-requirements.adoc[leveloffset=+1] endif::[] -include::modules/con_aws-requirements.adoc[leveloffset=+1] +include::modules/ref_aws-requirements.adoc[leveloffset=+1] diff --git a/guides/common/assembly_preparing-client-platforms.adoc b/guides/common/assembly_preparing-client-platforms.adoc index 6306964c807..3a10088e0d3 100644 --- a/guides/common/assembly_preparing-client-platforms.adoc +++ b/guides/common/assembly_preparing-client-platforms.adoc @@ -2,6 +2,8 @@ include::modules/con_preparing-client-platforms.adoc[] +include::modules/ref_compute-profiles.adoc[leveloffset=+1] + include::modules/proc_creating-operating-systems-by-using-web-ui.adoc[leveloffset=+1] include::modules/proc_creating-operating-systems-by-using-cli.adoc[leveloffset=+1] diff --git a/guides/common/assembly_preparing-networking.adoc b/guides/common/assembly_preparing-networking.adoc index 7f36392721c..e80642fab84 100644 --- a/guides/common/assembly_preparing-networking.adoc +++ b/guides/common/assembly_preparing-networking.adoc @@ -12,7 +12,7 @@ include::modules/ref_options-in-managed-dhcpv4.adoc[leveloffset=+2] include::modules/ref_options-in-unmanaged-dhcpv6.adoc[leveloffset=+2] -include::modules/con_prerequisites-for-image-based-provisioning.adoc[leveloffset=+1] +include::modules/ref_prerequisites-for-image-based-provisioning.adoc[leveloffset=+1] include::modules/ref_multiple-subnets-or-domains-using-installer.adoc[leveloffset=+2] diff --git a/guides/common/assembly_provisioning-cloud-instances-azure.adoc b/guides/common/assembly_provisioning-cloud-instances-azure.adoc index 1150f3aec89..a9c28ea3327 100644 --- a/guides/common/assembly_provisioning-cloud-instances-azure.adoc +++ b/guides/common/assembly_provisioning-cloud-instances-azure.adoc @@ -7,6 +7,8 @@ include::modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc[] +include::modules/ref_prerequisites-for-microsoft-azure-provisioning.adoc[leveloffset=+1] + ifndef::satellite[] include::modules/proc_installing-microsoft-azure-plugin.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_provisioning-cloud-instances-ec2.adoc b/guides/common/assembly_provisioning-cloud-instances-ec2.adoc index ba8c9d0af68..375e65b669a 100644 --- a/guides/common/assembly_provisioning-cloud-instances-ec2.adoc +++ b/guides/common/assembly_provisioning-cloud-instances-ec2.adoc @@ -44,7 +44,7 @@ ifndef::satellite[] include::modules/proc_uninstalling-amazon-ec2-plugin.adoc[leveloffset=+1] endif::[] -include::modules/con_more-information-about-amazon-web-services.adoc[leveloffset=+1] +include::modules/ref_more-information-about-amazon-web-services.adoc[leveloffset=+1] :!CRname: :!compute-resource-context: diff --git a/guides/common/assembly_provisioning-cloud-instances-gce.adoc b/guides/common/assembly_provisioning-cloud-instances-gce.adoc index f94bfa95442..8025c8d1805 100644 --- a/guides/common/assembly_provisioning-cloud-instances-gce.adoc +++ b/guides/common/assembly_provisioning-cloud-instances-gce.adoc @@ -7,6 +7,8 @@ include::modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc[] +include::modules/ref_prerequisites-for-google-compute-engine-provisioning.adoc[leveloffset=+1] + ifndef::satellite[] include::modules/proc_installing-gce-plugin.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_provisioning-cloud-instances-openstack.adoc b/guides/common/assembly_provisioning-cloud-instances-openstack.adoc index 45a7a29824d..f21337d63d8 100644 --- a/guides/common/assembly_provisioning-cloud-instances-openstack.adoc +++ b/guides/common/assembly_provisioning-cloud-instances-openstack.adoc @@ -7,6 +7,8 @@ include::modules/con_provisioning-cloud-instances-on-openstack.adoc[] +include::modules/ref_prerequisites-for-openstack-provisioning.adoc[leveloffset=+1] + include::modules/proc_adding-openstack-connection-by-using-web-ui.adoc[leveloffset=+1] include::modules/proc_adding-openstack-connection-by-using-cli.adoc[leveloffset=+1] diff --git a/guides/common/assembly_provisioning-requirements-in-project.adoc b/guides/common/assembly_provisioning-requirements-in-project.adoc index b0086211e5b..15e7bb5003e 100644 --- a/guides/common/assembly_provisioning-requirements-in-project.adoc +++ b/guides/common/assembly_provisioning-requirements-in-project.adoc @@ -4,7 +4,7 @@ include::modules/con_provisioning-requirements-in-project.adoc[] include::modules/con_pxe-booting-in-project.adoc[leveloffset=+1] -include::modules/con_http-booting-in-project.adoc[leveloffset=+1] +include::modules/ref_http-booting-in-project.adoc[leveloffset=+1] ifdef::foreman-el,katello,orcharhino[] include::modules/con_secure-boot-in-project.adoc[leveloffset=+1] diff --git a/guides/common/assembly_provisioning-virtual-machines-vmware.adoc b/guides/common/assembly_provisioning-virtual-machines-vmware.adoc index 343ec2377a7..da9be5449ca 100644 --- a/guides/common/assembly_provisioning-virtual-machines-vmware.adoc +++ b/guides/common/assembly_provisioning-virtual-machines-vmware.adoc @@ -11,7 +11,7 @@ ifndef::satellite[] include::modules/proc_installing-vmware-plugin.adoc[leveloffset=+1] endif::[] -include::modules/con_prerequisites-for-vmware-provisioning.adoc[leveloffset=+1] +include::modules/ref_prerequisites-for-vmware-provisioning.adoc[leveloffset=+1] include::modules/ref_vmware-user-privileges.adoc[leveloffset=+1] diff --git a/guides/common/assembly_restoring-server-or-smart-proxy-from-a-backup.adoc b/guides/common/assembly_restoring-server-or-smart-proxy-from-a-backup.adoc index a0845e6de19..c3b7315bd9d 100644 --- a/guides/common/assembly_restoring-server-or-smart-proxy-from-a-backup.adoc +++ b/guides/common/assembly_restoring-server-or-smart-proxy-from-a-backup.adoc @@ -6,8 +6,4 @@ include::modules/proc_restoring-from-a-full-backup.adoc[leveloffset=+1] include::modules/proc_restoring-from-incremental-backups.adoc[leveloffset=+1] -include::modules/con_backup-and-restore-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc[leveloffset=+1] - -ifdef::katello,orcharhino,satellite[] -include::modules/proc_synchronizing-content-from-project-server-to-smart-proxy-servers.adoc[leveloffset=+2] -endif::[] +include::modules/proc_restoring-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc[leveloffset=+1] diff --git a/guides/common/assembly_supported-usage-and-versions-of-project-components.adoc b/guides/common/assembly_supported-usage-and-versions-of-project-components.adoc index 4545fdee618..092f37145f2 100644 --- a/guides/common/assembly_supported-usage-and-versions-of-project-components.adoc +++ b/guides/common/assembly_supported-usage-and-versions-of-project-components.adoc @@ -3,7 +3,7 @@ include::modules/con_supported-usage-and-versions-of-project-components.adoc[] ifdef::satellite[] -include::modules/con_supported-usage-of-project-components.adoc[leveloffset=+1] +include::modules/ref_supported-usage-of-project-components.adoc[leveloffset=+1] include::modules/con_supported-client-architectures-for-content-management.adoc[leveloffset=+1] diff --git a/guides/common/assembly_synchronizing-content-between-servers.adoc b/guides/common/assembly_synchronizing-content-between-servers.adoc index e018c8827d1..8c727fa2bd9 100644 --- a/guides/common/assembly_synchronizing-content-between-servers.adoc +++ b/guides/common/assembly_synchronizing-content-between-servers.adoc @@ -2,6 +2,8 @@ include::modules/con_synchronizing-content-between-servers.adoc[] +include::modules/ref_iss-configuration-options-for-content-synchronization.adoc[leveloffset=+1] + include::modules/con_content-synchronization-by-using-export-and-import.adoc[leveloffset=+1] include::modules/proc_using-upstream-server-as-a-content-store.adoc[leveloffset=+2] diff --git a/guides/common/assembly_template-writing-reference.adoc b/guides/common/assembly_template-writing-reference.adoc index e8a9fb4bf9c..6f4b991e6c2 100644 --- a/guides/common/assembly_template-writing-reference.adoc +++ b/guides/common/assembly_template-writing-reference.adoc @@ -2,6 +2,8 @@ include::modules/con_template-writing-reference.adoc[] +include::modules/ref_template-rendering-and-erb-context.adoc[leveloffset=+1] + include::modules/proc_accessing-the-template-writing-reference.adoc[leveloffset=+1] include::modules/proc_using-autocompletion-in-templates.adoc[leveloffset=+1] diff --git a/guides/common/assembly_using-foreman-webhooks.adoc b/guides/common/assembly_using-foreman-webhooks.adoc index 3121b4caee9..0f01ab89baa 100644 --- a/guides/common/assembly_using-foreman-webhooks.adoc +++ b/guides/common/assembly_using-foreman-webhooks.adoc @@ -4,6 +4,8 @@ ifdef::context[:parent-context: {context}] include::modules/con_using-webhooks.adoc[] +include::modules/con_webhooks-behavior-and-integration.adoc[leveloffset=+1] + ifndef::satellite[] include::modules/proc_installing-webhooks-plugin.adoc[leveloffset=+1] endif::[] diff --git a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc index 07a9f51c8a5..b059336f0ce 100644 --- a/guides/common/assembly_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/assembly_using-network-boot-to-provision-hosts.adoc @@ -159,7 +159,7 @@ include::modules/proc_deploying-ssh-keys-during-provisioning.adoc[leveloffset=+1 include::modules/con_using-ipxe-to-reduce-provisioning-times.adoc[leveloffset=+1] -include::modules/con_prerequisites-for-using-ipxe.adoc[leveloffset=+2] +include::modules/ref_prerequisites-for-using-ipxe.adoc[leveloffset=+2] include::modules/proc_configuring-ipxe-environment.adoc[leveloffset=+2] diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc index 793fc7e7948..5b05a81f101 100644 --- a/guides/common/attributes-satellite.adoc +++ b/guides/common/attributes-satellite.adoc @@ -107,7 +107,6 @@ endif::[] :OpenStack: Red{nbsp}Hat OpenStack Services on OpenShift :project-package-check-update: satellite-maintain packages check-update :project-package-install: satellite-maintain packages install -:project-package-remove: satellite-maintain packages remove :project-package-update: satellite-maintain packages update :package-install: dnf install :package-upgrade: dnf upgrade diff --git a/guides/common/modules/con_adding-content-to-foreman.adoc b/guides/common/modules/con_adding-content-to-foreman.adoc index 0e4c3b35503..64194a11b9d 100644 --- a/guides/common/modules/con_adding-content-to-foreman.adoc +++ b/guides/common/modules/con_adding-content-to-foreman.adoc @@ -5,7 +5,3 @@ [role="_abstract"] This chapter outlines how you can import different types of {customcontent} to {Project}. -For example, you can use the following chapters for information on specific types of {customcontent} but the underlying procedures are the same: - -* xref:Managing_ISO_Images_{context}[] -* xref:managing-custom-file-type-content[] diff --git a/guides/common/modules/con_ansible-role-and-collection-paths-in-project.adoc b/guides/common/modules/con_ansible-role-and-collection-paths-in-project.adoc index 78966612c5a..75d58201956 100644 --- a/guides/common/modules/con_ansible-role-and-collection-paths-in-project.adoc +++ b/guides/common/modules/con_ansible-role-and-collection-paths-in-project.adoc @@ -20,6 +20,3 @@ If you want to add custom roles or collections, place them under `/etc/ansible`. ifdef::satellite[] Note that {Team} provides support only for Ansible roles and collections obtained from {Team}. endif::[] - -The paths are configured by {Project}. -For more information, see xref:customizing-ansible-configuration_{context}[]. diff --git a/guides/common/modules/con_api-cheat-sheet.adoc b/guides/common/modules/con_api-cheat-sheet.adoc index 28b13cae429..7a4b01d6275 100644 --- a/guides/common/modules/con_api-cheat-sheet.adoc +++ b/guides/common/modules/con_api-cheat-sheet.adoc @@ -21,4 +21,3 @@ endif::[] You can use these values to fully automate your scripts, removing any need to verify which ports to use. The following examples use `curl` for sending API requests. -For more information, see xref:calling-the-api-in-curl[]. diff --git a/guides/common/modules/con_backing-up-server-and-proxy.adoc b/guides/common/modules/con_backing-up-server-and-proxy.adoc index e53a0255ff6..a1e9c392d83 100644 --- a/guides/common/modules/con_backing-up-server-and-proxy.adoc +++ b/guides/common/modules/con_backing-up-server-and-proxy.adoc @@ -12,20 +12,3 @@ If your deployment uses custom configurations, you must consider how to handle t If you create a new instance of the {ProjectServer}, decommission the old instances after restoring the backup. Cloned instances are not supposed to run in parallel in a production environment. ==== - -To create a backup of your {ProjectServer} or {SmartProxyServer} and all associated data, use the `{foreman-maintain} backup` command. -Backing up to a separate storage device on a separate system is highly recommended. - -{Project} services are unavailable during the backup. -Therefore, you must ensure that no other tasks are scheduled by other administrators. -You can schedule a backup by using `cron`. -For more information, see the xref:Example_of_a_Weekly_Full_Backup_Followed_by_Daily_Incremental_Backups_{context}[]. - -During offline backups, the services are inactive and {Project} is in a maintenance mode. -All the traffic from outside on port 443 is rejected by a firewall to ensure there are no modifications triggered. - -ifndef::foreman-el,foreman-deb[] -A backup contains sensitive information from the `/root/ssl-build` directory. -For example, it can contain hostnames, ssh keys, request files and SSL certificates. -endif::[] -You must encrypt or move the backup to a secure location to minimize the risk of damage or unauthorized access to the hosts. diff --git a/guides/common/modules/con_backup-and-restore-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc b/guides/common/modules/con_backup-and-restore-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc deleted file mode 100644 index a8cb02d727e..00000000000 --- a/guides/common/modules/con_backup-and-restore-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc +++ /dev/null @@ -1,29 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="backup-and-restore-{smart-proxy-context}-server-by-using-a-virtual-machine-snapshot"] -= Backup and restore {SmartProxyServer} by using a virtual machine snapshot - -[role="_abstract"] -You can use virtual machine snapshots to back up and restore your {SmartProxyServer}. -This is useful for quick recovery in case of server failure or configuration issues. - -If your {SmartProxyServer} is a virtual machine, you can restore it from a snapshot. -Creating weekly snapshots to restore from is recommended. -ifdef::katello,orcharhino,satellite[] -In the event of failure, you can install, or configure a new {SmartProxyServer}, and then synchronize the database content from {ProjectServer}. -endif::[] -ifdef::foreman-el,foreman-deb[] -In the event of failure, you can install or configure a new {SmartProxyServer}. -endif::[] - -If required, deploy a new {SmartProxyServer}, ensuring the host name is the same as before, and then install the {SmartProxy} certificates. -ifdef::katello,orcharhino,satellite[] -You may still have them on {ProjectServer}, the package name ends in -certs.tar, alternately create new ones. -endif::[] -ifndef::katello,orcharhino,satellite[] -You may still have them, alternately create new ones. -endif::[] -Follow the procedures in {InstallingSmartProxyDocURL}[Installing {SmartProxyServer}] until you can confirm, in the {ProjectWebUI}, that {SmartProxyServer} is connected to {ProjectServer}. -ifdef::katello,orcharhino,satellite[] -Then use the procedure xref:Synchronizing_Content_from_{project-context}_Server_to_{smart-proxy-context-titlecase}_Servers_{context}[] to synchronize from {Project}. -endif::[] diff --git a/guides/common/modules/con_backup-process-overview.adoc b/guides/common/modules/con_backup-process-overview.adoc new file mode 100644 index 00000000000..93232d5d468 --- /dev/null +++ b/guides/common/modules/con_backup-process-overview.adoc @@ -0,0 +1,27 @@ +:_mod-docs-content-type: CONCEPT + +[id="backup-process-overview"] += Backup process overview + +[role="_abstract"] +You use the `{foreman-maintain} backup` command to capture your {ProjectServer} or {SmartProxyServer} and associated data. +Backups require downtime, therefore you must plan scheduling, storage, and security so you avoid disruption and protect sensitive content. + +The `{foreman-maintain} backup` command creates a backup of your {ProjectServer} or {SmartProxyServer} and all associated data. +{Team} recommends backing up {Project} to a separate storage device on a separate system. + +{Project} services are unavailable during the backup. +Therefore, you must ensure that no other tasks are scheduled by other administrators. +You can schedule a backup by using `cron`. + +During offline backups, the services are inactive and {Project} is in a maintenance mode. +All the traffic from outside on port 443 is rejected by a firewall to ensure there are no modifications triggered. + +ifndef::foreman-el,foreman-deb[] +A backup contains sensitive information from the `/root/ssl-build` directory. +For example, it can contain hostnames, ssh keys, request files and SSL certificates. +endif::[] +You must encrypt or move the backup to a secure location to minimize the risk of damage or unauthorized access to the hosts. + +.Additional resources +* xref:Example_of_a_Weekly_Full_Backup_Followed_by_Daily_Incremental_Backups_{context}[] diff --git a/guides/common/modules/con_benchmarking-raw-db-performance.adoc b/guides/common/modules/con_benchmarking-raw-db-performance.adoc deleted file mode 100644 index 1a5949c33e6..00000000000 --- a/guides/common/modules/con_benchmarking-raw-db-performance.adoc +++ /dev/null @@ -1,33 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="Benchmarking_raw_DB_Performance_{context}"] -= Benchmarking raw DB performance - -[role="_abstract"] -ifndef::orcharhino[] -To get a list of the top table sizes in disk space for -ifdef::katello,satellite[] -Candlepin, Foreman, and Pulp, -endif::[] -ifdef::foreman-el,foreman-deb[] -Foreman, -endif::[] -check https://github.com/RedHatSatellite/satellite-support/blob/master/postgres-size-report[postgres-size-report] script in https://github.com/RedHatSatellite/satellite-support[satellite-support] git repository. -endif::[] - -PGbench utility (note you may need to resize PostgreSQL data directory `{postgresql-lib-dir}` directory to 100 GiB or what does benchmark take to run) might be used to measure PostgreSQL performance on your system. -Use `{package-install} postgresql-contrib` to install it. -ifndef::orcharhino[] -For more information, see https://github.com/RedHatSatellite/satellite-support[github.com/RedHatSatellite/satellite-support]. -endif::[] - -// can we be more specific here? why would/could it matter? -Choice of filesystem for PostgreSQL data directory might matter as well. - -[WARNING] -==== -* Never do any testing on production system and without valid backup. -* Before you start testing, see how big the database files are. -Testing with a really small database would not produce any meaningful results. -For example, if the DB is only 20 GiB and the buffer pool is 32 GiB, it won't show problems with large number of connections because the data will be completely buffered. -==== diff --git a/guides/common/modules/con_boot-disk-types.adoc b/guides/common/modules/con_boot-disk-types.adoc index 2a79a1c1967..c2716c6087a 100644 --- a/guides/common/modules/con_boot-disk-types.adoc +++ b/guides/common/modules/con_boot-disk-types.adoc @@ -17,7 +17,6 @@ The provisioning template still downloads from {ProjectServer}. This image is based on SYSLINUX and GRUB2 and works with most network cards. + This image contains a provisioning security token, therefore the generated image has a limited lifespan. -For more information about configuring the security token, see xref:configuring-the-security-token-validity-duration[]. Subnet image:: A boot ISO that is not associated with a specific host. @@ -31,7 +30,6 @@ This image is generic to all hosts with a provisioning NIC on the same subnet. + This image is based on iPXE boot firmware. Only a limited number of network cards is supported. -For more information, see https://ipxe.org/appnote/hardware_drivers[supported hardware drivers at ipxe.org]. ifndef::satellite[] Generic image:: @@ -43,7 +41,6 @@ The image does not store IP address details and requires access to a DHCP server + This image is based on iPXE boot firmware. Only a limited number of network cards is supported. -For more information, see https://ipxe.org/appnote/hardware_drivers[supported hardware drivers at ipxe.org]. + This image does not support UEFI systems. @@ -54,10 +51,12 @@ You define the subnet data in {Project} and the image is created with static net + This image is based on iPXE boot firmware. Only a limited number of network cards is supported. -For more information, see https://ipxe.org/appnote/hardware_drivers[supported hardware drivers at ipxe.org]. + This image contains a provisioning security token, therefore the generated image has a limited lifespan. -For more information about configuring the security token, see xref:configuring-the-security-token-validity-duration[]. + This image does not support UEFI systems. endif::[] + +.Additional resources +* xref:configuring-the-security-token-validity-duration[] +* https://ipxe.org/appnote/hardware_drivers[Supported hardware drivers at ipxe.org] diff --git a/guides/common/modules/con_comparison-of-content-view-environments-and-composite-content-views.adoc b/guides/common/modules/con_comparison-of-content-view-environments-and-composite-content-views.adoc index 30f5eaf829b..8e666b66fbf 100644 --- a/guides/common/modules/con_comparison-of-content-view-environments-and-composite-content-views.adoc +++ b/guides/common/modules/con_comparison-of-content-view-environments-and-composite-content-views.adoc @@ -15,10 +15,12 @@ Hosts assigned to multiple content view environments immediately access the comb Conflict resolution:: Composite content views resolve conflicts at the time of publishing by merging duplicate repositories. For hosts assigned to multiple content view environments, repository conflicts are resolved based on the order of content view environments. -For more information about content view environment ordering and priority, see xref:content-view-environment-ordering-and-priority[]. Version selection:: Composite content views allow you to select specific versions of a content view, including older versions. With multiple content view environments, the host receives the version of the content view that is currently promoted to the selected lifecycle environment. Choose the approach that best suits your requirements based on these differences. + +.Additional resources +* xref:content-view-environment-ordering-and-priority[] diff --git a/guides/common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc b/guides/common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc index 2eb01a0010f..0d2558b284c 100644 --- a/guides/common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc +++ b/guides/common/modules/con_configuring-an-ldap-server-as-an-external-identity-provider-for-project.adoc @@ -6,18 +6,3 @@ [role="_abstract"] Lightweight Directory Access Protocol (LDAP) is a set of open protocols used to access centrally stored information over a network. With {Project}, you can use one or multiple LDAP directories for external authentication. - -[NOTE] -==== -While you can configure the LDAP server integrated with {FreeIPA} as an external authentication source, {FreeIPA} users will not be able to log in by using single sign-on. -Instead, consider configuring {FreeIPA} as an external identity provider. -For more information, see xref:configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[]. -==== - -[IMPORTANT] -==== -Users cannot use both {FreeIPA} and LDAP as an authentication method. -After a user authenticates by using one of these methods, they cannot use the other method. - -To change the authentication method for a user, remove the automatically created user from {Project}. -==== diff --git a/guides/common/modules/con_configuring-email-notifications.adoc b/guides/common/modules/con_configuring-email-notifications.adoc index f6857722bd4..04a9e94ad02 100644 --- a/guides/common/modules/con_configuring-email-notifications.adoc +++ b/guides/common/modules/con_configuring-email-notifications.adoc @@ -7,8 +7,6 @@ Email notifications are created by {ProjectServer} periodically or after completion of certain events. The periodic notifications can be sent daily, weekly or monthly. -For an overview of available notification types, see xref:Email_Notification_Types_{context}[]. - Users do not receive any email notifications by default. An administrator can configure users to receive notifications based on criteria such as the type of notification, and frequency. diff --git a/guides/common/modules/con_configuring-foreman-server-with-a-custom-ssl-certificate.adoc b/guides/common/modules/con_configuring-foreman-server-with-a-custom-ssl-certificate.adoc index 773fda0dc0d..2868331edd7 100644 --- a/guides/common/modules/con_configuring-foreman-server-with-a-custom-ssl-certificate.adoc +++ b/guides/common/modules/con_configuring-foreman-server-with-a-custom-ssl-certificate.adoc @@ -19,11 +19,3 @@ When you configure {ProjectName} with custom SSL certificates, you must fulfill * You must not set a passphrase for the private key. * If you use a certificate signed by an intermediate CA, you must provide the full chain of certificates. Your certificate must start with the Root CA, contain one or more intermediate CAs, and end with your server certificate. - -To configure your {ProjectServer} with a custom certificate, complete the following procedures: - -. xref:creating-a-custom-ssl-certificate_{project-context}[] -. xref:Deploying_a_Custom_SSL_Certificate_to_Server_{project-context}[] -. xref:deploying-a-custom-ssl-certificate-to-hosts_{project-context}[] -. If you have {SmartProxyServers} registered to {ProjectServer}, configure them with custom SSL certificates. -For more information, see {InstallingSmartProxyDocURL}configuring-{smart-proxy-context}-server-with-a-custom-ssl-certificate[Configuring {SmartProxyServer} with a custom SSL certificate] in _{InstallingSmartProxyDocTitle}_. diff --git a/guides/common/modules/con_configuring-kerberos-sso-for-active-directory-users-in-project.adoc b/guides/common/modules/con_configuring-kerberos-sso-for-active-directory-users-in-project.adoc index 8fa4e253efa..d13c83faaee 100644 --- a/guides/common/modules/con_configuring-kerberos-sso-for-active-directory-users-in-project.adoc +++ b/guides/common/modules/con_configuring-kerberos-sso-for-active-directory-users-in-project.adoc @@ -11,19 +11,3 @@ AD users can log in using the following methods: * Username and password * Kerberos single sign-on - -ifndef::foremanctl[] -[NOTE] -==== -You can also connect your {Project} deployment to AD in the following ways: - -* By using indirect AD integration. -With indirect integration, your {ProjectServer} is connected to a {FreeIPA} server which is then connected to AD. -For more information, see xref:configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[]. -* By attaching the LDAP server of the AD domain as an external authentication source with no single sign-on support. -For more information, see xref:configuring-an-ldap-server-as-an-external-identity-provider-for-project_{context}[]. -ifndef::orcharhino[] -For an example configuration, see https://access.redhat.com/solutions/1498773[How to configure Active Directory authentication with TLS on {Project}]. -endif::[] -==== -endif::[] diff --git a/guides/common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc b/guides/common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc index 578dccce9fb..cec430647e3 100644 --- a/guides/common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc +++ b/guides/common/modules/con_configuring-kerberos-sso-with-freeipa-in-project.adoc @@ -16,7 +16,3 @@ If cross-forest trust is configured between {FreeIPA} and Active{nbsp}Directory, * Kerberos single sign-on When cross-forest trust is configured between {FreeIPA} and Active{nbsp}Directory, Active{nbsp}Directory users can log in to {Project} with their user principal name (UPN) and password. - -ifndef::orcharhino[] -For information about {FreeIPA}, including its cross-forest trust functionality, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/planning_identity_management/index[{RHEL}{nbsp}9 _Planning Identity Management_] and link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/installing_identity_management/index[{RHEL}{nbsp}9 _Installing Identity Management_]. -endif::[] diff --git a/guides/common/modules/con_configuring-salt.adoc b/guides/common/modules/con_configuring-salt.adoc index 5ff73a89e32..b3ef7934674 100644 --- a/guides/common/modules/con_configuring-salt.adoc +++ b/guides/common/modules/con_configuring-salt.adoc @@ -10,7 +10,7 @@ This is required when adding Salt support to an existing {Project} installation, ifdef::orcharhino[] [NOTE] ==== -If you select Salt during the xref:sources/installation_and_maintenance/installing_orcharhino_server.adoc#orcharhino_Installer_GUI[main orcharhino installation steps], the installer automatically performs those steps on your {Project}. +If you select Salt during the main orcharhino installation steps, the installer automatically performs those steps on your {Project}. Use the following sections to manually install Salt on your {ProjectServer} or {SmartProxyServer}. ==== endif::[] diff --git a/guides/common/modules/con_configuring-smart-proxy-server-with-ssl-certificates.adoc b/guides/common/modules/con_configuring-smart-proxy-server-with-ssl-certificates.adoc index 06be04aff04..15a7db2aacb 100644 --- a/guides/common/modules/con_configuring-smart-proxy-server-with-ssl-certificates.adoc +++ b/guides/common/modules/con_configuring-smart-proxy-server-with-ssl-certificates.adoc @@ -6,8 +6,3 @@ [role="_abstract"] {ProjectName} uses SSL certificates to enable encrypted communications between {ProjectServer}, {SmartProxyServers}, and all hosts. Depending on the requirements of your organization, you must configure your {SmartProxyServer} with a default or custom certificate. - -* If you use a default SSL certificate, you must also configure each {SmartProxyServer} with a distinct default SSL certificate. -For more information, see xref:configuring-{smart-proxy-context}-server-with-a-default-ssl-certificate[]. -* If you use a custom SSL certificate, you must also configure each {SmartProxyServer} with a distinct custom SSL certificate. -For more information, see xref:configuring-{smart-proxy-context}-server-with-a-custom-ssl-certificate[]. diff --git a/guides/common/modules/con_configuring-smart-proxy-servers-with-a-custom-ssl-certificate.adoc b/guides/common/modules/con_configuring-smart-proxy-servers-with-a-custom-ssl-certificate.adoc index 4fee17dd0e2..68787bce9bc 100644 --- a/guides/common/modules/con_configuring-smart-proxy-servers-with-a-custom-ssl-certificate.adoc +++ b/guides/common/modules/con_configuring-smart-proxy-servers-with-a-custom-ssl-certificate.adoc @@ -5,9 +5,3 @@ [role="_abstract"] If you configure {ProjectServer} to use a custom SSL certificate, you must also configure each of your {SmartProxyServers} with a distinct custom SSL certificate. - -To configure your {SmartProxyServer} with a custom certificate, complete the following procedures on each {SmartProxyServer}: - -. xref:creating-a-custom-ssl-certificate_{smart-proxy-context}[] -. xref:deploying-a-custom-ssl-certificate-to-{smart-proxy-context}-server_{smart-proxy-context}[] -. xref:deploying-a-custom-ssl-certificate-to-hosts_{smart-proxy-context}[] diff --git a/guides/common/modules/con_configuring-smartproxyservers-with-custom-ssl-certificates-for-load-balancing-without-puppet.adoc b/guides/common/modules/con_configuring-smartproxyservers-with-custom-ssl-certificates-for-load-balancing-without-puppet.adoc index da82629e19f..0d59835c7ee 100644 --- a/guides/common/modules/con_configuring-smartproxyservers-with-custom-ssl-certificates-for-load-balancing-without-puppet.adoc +++ b/guides/common/modules/con_configuring-smartproxyservers-with-custom-ssl-certificates-for-load-balancing-without-puppet.adoc @@ -6,6 +6,3 @@ [role="_abstract"] You can configure one or more {SmartProxyServers} that use custom SSL certificates for load balancing. To do this, configure and install certificates on each {SmartProxyServer} you want to use for load balancing. - -If you use Puppet in your {Project} deployment, the configuration steps are different. -See xref:configuring-{smart-proxy-context}-servers-with-custom-ssl-certificates-for-load-balancing-with-puppet_{context}[]. diff --git a/guides/common/modules/con_configuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-without-puppet.adoc b/guides/common/modules/con_configuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-without-puppet.adoc index 370fe6c34da..8c9975fd4cc 100644 --- a/guides/common/modules/con_configuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-without-puppet.adoc +++ b/guides/common/modules/con_configuring-smartproxyservers-with-default-ssl-certificates-for-load-balancing-without-puppet.adoc @@ -5,6 +5,3 @@ [role="_abstract"] You can configure one or more {SmartProxyServers} that use default SSL certificates for load balancing. - -If you use Puppet in your {Project} deployment, the configuration steps are different. -See xref:configuring-{smart-proxy-context}-servers-with-default-ssl-certificates-for-load-balancing-with-puppet_{context}[]. diff --git a/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc b/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc index 0e8edaa71d8..fd1ef8e7079 100644 --- a/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc +++ b/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-quarkus-in-project.adoc @@ -21,10 +21,3 @@ You can integrate {ProjectServer} with your existing {keycloak-quarkus} server t ifndef::satellite,orcharhino[] * {PIV} cards endif::[] - -ifdef::satellite[] -For information about {RHBK}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak[{RHBK} documentation]. -endif::[] -ifndef::satellite[] -For information about {keycloak}, see link:https://www.keycloak.org/documentation[{keycloak} documentation]. -endif::[] diff --git a/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-wildfly-in-project.adoc b/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-wildfly-in-project.adoc index aa3a177f318..b4671f6c9ae 100644 --- a/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-wildfly-in-project.adoc +++ b/guides/common/modules/con_configuring-sso-and-2fa-with-keycloak-wildfly-in-project.adoc @@ -10,28 +10,6 @@ You can integrate {ProjectServer} with your existing {keycloak} server to delega :FeatureName: Configuring {Project} with {keycloak-wildfly} include::snip_deprecated-feature.adoc[] -ifndef::satellite[] -[NOTE] -==== -The default {keycloak} distribution is now based on Quarkus. - -{keycloak-quarkus} replaces {keycloak-wildfly} in {Project} deployments. -For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[]. - -For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://www.keycloak.org/migration/migrating-to-quarkus[Migrating to Quarkus distribution]. -==== -endif::[] -ifdef::satellite[] -[NOTE] -==== -The {keycloak-wildfly}{nbsp}7 product family has reached End of Full Support. -Use {keycloak-quarkus} instead in your {Project} deployments. -For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[]. - -For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[documentation for {keycloak-quarkus}]. -==== -endif::[] - {keycloak} users can log in using the following login methods: * User name and password in {ProjectWebUI} @@ -46,7 +24,3 @@ endif::[] ifndef::satellite,orcharhino[] * {PIV} cards endif::[] - -ifdef::satellite[] -For information about {RHSSO}, see link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on[{RHSSO} documentation]. -endif::[] diff --git a/guides/common/modules/con_content-synchronization-by-using-export-and-import.adoc b/guides/common/modules/con_content-synchronization-by-using-export-and-import.adoc index 499442a36b9..3ce32e0ddda 100644 --- a/guides/common/modules/con_content-synchronization-by-using-export-and-import.adoc +++ b/guides/common/modules/con_content-synchronization-by-using-export-and-import.adoc @@ -4,18 +4,8 @@ = Content synchronization by using export and import [role="_abstract"] -There are multiple approaches for synchronizing content by using the export and import workflow: - -* You employ the upstream {ProjectServer} as a content store, which means that you sync the whole Library rather than content view versions. -This approach offers the simplest export/import workflow. -In such case, you can manage the content view versions downstream. -For more information, see xref:Using_Upstream_Server_as_a_Content_Store_{context}[]. -* You use the upstream {ProjectServer} to sync content view versions. -This approach offers more control over what content is synced between {ProjectServer}s. -For more information, see xref:Using_Upstream_Server_to_Synchronize_Content_View_Versions_{context}[]. -* You sync a single repository. -This can be useful if you use the content-view syncing approach, but you want to sync an additional repository without adding it to an existing content view. -For more information, see xref:synchronizing-a-single-repository_{context}[]. +When synchronizing content by using export and import, you export content from one {ProjectServer}, which is the upstream server, and import it into another {ProjectServer}, which is the downstream server. +Pick an approach that suits your environment depending on what content you want to synchronize. [NOTE] ==== diff --git a/guides/common/modules/con_content-view-environments-overview.adoc b/guides/common/modules/con_content-view-environments-overview.adoc index 6adc8dae28a..7bb0383aa30 100644 --- a/guides/common/modules/con_content-view-environments-overview.adoc +++ b/guides/common/modules/con_content-view-environments-overview.adoc @@ -8,7 +8,6 @@ By default, you can assign multiple content view environments to hosts and activ This is controlled by the *Allow multiple content views* setting. Hosts registered with multiple activation keys handle content view environment assignments based on the order of activation keys and content view environments. -For more information, see xref:content-view-environment-ordering-and-priority[]. When you disable *Allow multiple content views*, multi-environment hosts remain assigned to multiple content view environments and retain access to all their content. Existing multi-environment activation keys remain associated with multiple content view environments, and both multi-environment hosts and activation keys remain visible in the {ProjectWebUI} and accessible through the Hammer CLI. @@ -20,3 +19,4 @@ You can also reassign a multi-environment activation key to a single content vie .Additional resources * {AdministeringDocURL}content_settings_admin[Content settings in _{AdministeringDocTitle}_] +* xref:content-view-environment-ordering-and-priority[] diff --git a/guides/common/modules/con_content-views-in-project.adoc b/guides/common/modules/con_content-views-in-project.adoc index 6b4cac64122..61f1183ea51 100644 --- a/guides/common/modules/con_content-views-in-project.adoc +++ b/guides/common/modules/con_content-views-in-project.adoc @@ -25,20 +25,6 @@ ifndef::satellite[] + You can access unprotected repositories in the _Default Organization View_ content view. The URL consists of your {SmartProxy} FQDN, `/pulp/content/`, your organization label, `/Library/custom/`, your product label, `/`, your repository label, and a trailing `/`, for example, `\https://{foreman-example-com}/pulp/content/Example/Library/custom/{client-content-product-label}/{client-content-repository-label}/`. -ifdef::content-management[] -For more information, see -ifdef::katello[] -xref:adding-deb-repositories-by-using-web-ui[] or xref:adding-custom-rpm-repositories-by-using-web-ui[]. -endif::[] -ifdef::orcharhino[] -ifdef::debian,ubuntu[] -xref:adding-deb-repositories-by-using-web-ui[]. -endif::[] -ifdef::almalinux,amazon_linux,centos,oracle_linux,red_hat_enterprise_linux,rocky_linux,suse_linux_enterprise_server[] -xref:adding-custom-rpm-repositories-by-using-web-ui[]. -endif::[] -endif::[] -endif::[] endif::[] Promoting a content view across environments:: diff --git a/guides/common/modules/con_disable-transparent-hugepage.adoc b/guides/common/modules/con_disable-transparent-hugepage.adoc index 8608dd071bf..209868b458a 100644 --- a/guides/common/modules/con_disable-transparent-hugepage.adoc +++ b/guides/common/modules/con_disable-transparent-hugepage.adoc @@ -10,5 +10,6 @@ To improve PostgreSQL and Redis performance, disable Transparent Hugepage. In deployments where the databases are running on separate servers, there may be a small benefit to using Transparent Hugepage on the {ProjectServer} only. ifndef::orcharhino[] -For more information on how to disable Transparent Hugepage, see https://access.redhat.com/solutions/1320153[How to disable transparent hugepages (THP) on Red Hat Enterprise Linux]. +.Additional resources +* https://access.redhat.com/solutions/1320153[How to disable transparent hugepages (THP) on Red Hat Enterprise Linux] endif::[] diff --git a/guides/common/modules/con_discovery-in-pxeless-mode.adoc b/guides/common/modules/con_discovery-in-pxeless-mode.adoc index 111f45f7b27..b4d877c0d1b 100644 --- a/guides/common/modules/con_discovery-in-pxeless-mode.adoc +++ b/guides/common/modules/con_discovery-in-pxeless-mode.adoc @@ -9,20 +9,14 @@ You discover unknown nodes by using the Discovery ISO from {ProjectServer}. When a discovered node is scheduled for installation, the `kexec` command reloads a Linux kernel with an operating system installer without rebooting the node. ifdef::satellite[] -[IMPORTANT] -==== -Discovery `kexec` is a Technology Preview feature only. - -Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. -Red Hat does not recommend using them in production. -These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. -For more information, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features {endash} Scope of Support]. -==== -endif::[] +:FeatureName: Discovery `kexec` +include::snip_technology-preview.adoc[] You might experience the following problems: + * The console might freeze during the process. * On some hardware, you might experience graphical hardware problems. +endif::[] .Discovery workflow in PXE-less mode ifdef::satellite[] diff --git a/guides/common/modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc b/guides/common/modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc index 42851f970a7..36dd27b43e6 100644 --- a/guides/common/modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc +++ b/guides/common/modules/con_example-playbooks-based-on-modules-from-project-ansible-collection.adoc @@ -8,12 +8,3 @@ These examples show how to create playbooks that use {Project} Ansible Collectio All playbooks based on modules from {Project} Ansible Collection must include parameters detailing how to connect to the {Project} API. The following examples use Ansible vault and module defaults group to provide these parameters, and they authenticate using a username and password. -For more information, see xref:creating-a-playbook-with-modules-from-{project-context}-ansible-collection[]. - -[NOTE] -==== -* Use the `ansible-doc --list {ansible-namespace}` command to display the {Project} Ansible modules installed on your system. -ifndef::orcharhino[] -* See {ansible-galaxy}[{ansible-galaxy-name}] for a complete list of {Project} Ansible modules and other related information. -endif::[] -==== diff --git a/guides/common/modules/con_high-level-steps-for-configuration-management-with-puppet.adoc b/guides/common/modules/con_high-level-steps-for-configuration-management-with-puppet.adoc index 525538d3f91..4b20b8c26ea 100644 --- a/guides/common/modules/con_high-level-steps-for-configuration-management-with-puppet.adoc +++ b/guides/common/modules/con_high-level-steps-for-configuration-management-with-puppet.adoc @@ -15,9 +15,11 @@ Configuration management with Puppet involves the following high-level steps: . Assigning Puppet classes or config groups to host groups or individual hosts. . Configuring intervals for runs of the OpenVox agent on hosts and for configuration enforcement runs of the OpenVox server. . Monitoring configuration management using reports in the {ProjectWebUI}. -For more information, see {AdministeringDocURL}monitoring-{project-context}-resources[Monitoring {Project} resources] in _{AdministeringDocTitle}_. . Configuring email notifications. -For more information, see {AdministeringDocURL}Configuring_Email_Notification_Preferences_admin[Configuring Email Notification Preferences] in _{AdministeringDocTitle}_. After assigning Puppet classes or config groups, {Project} runs configuration management automatically in the configured intervals to enforce Puppet configuration on your hosts, or you can initiate it manually on demand with the *Run Puppet Once* feature. -For more information, see xref:running-puppet-once-using-ssh_{context}[]. + +.Additional resources +* {AdministeringDocURL}monitoring-{project-context}-resources[Monitoring {Project} resources in _{AdministeringDocTitle}_] +* {AdministeringDocURL}Configuring_Email_Notification_Preferences_admin[Configuring email notification preferences in _{AdministeringDocTitle}_] +* xref:running-puppet-once-using-ssh_{context}[] diff --git a/guides/common/modules/con_http-authentication-overview.adoc b/guides/common/modules/con_http-authentication-overview.adoc index d61e4a89008..4c24d441c83 100644 --- a/guides/common/modules/con_http-authentication-overview.adoc +++ b/guides/common/modules/con_http-authentication-overview.adoc @@ -6,7 +6,6 @@ [role="_abstract"] All requests to the {Project} API require a valid {Project} user name and password. The API uses Basic HTTP authentication to encode these credentials and add to the `Authorization` header. -For more information about Basic authentication, see http://tools.ietf.org/html/rfc2617[RFC 2617 HTTP Authentication: Basic and Digest Access Authentication]. If a request does not include an appropriate `Authorization` header, the API returns a `401 Authorization Required` error. [IMPORTANT] @@ -18,3 +17,6 @@ The REST API requires HTTPS for transport-level encryption of plain text request Some base64 libraries break encoded credentials into multiple lines and terminate each line with a newline character. This invalidates the header and causes a faulty request. The `Authorization` header requires the encoded credentials to be on a single line within the header. + +.Additional resources +* http://tools.ietf.org/html/rfc2617[RFC 2617 HTTP Authentication: Basic and Digest Access Authentication] diff --git a/guides/common/modules/con_importing-red-hat-subscription-manifests-into-foreman.adoc b/guides/common/modules/con_importing-red-hat-subscription-manifests-into-foreman.adoc index 03702d4b99f..6dce2d95b78 100644 --- a/guides/common/modules/con_importing-red-hat-subscription-manifests-into-foreman.adoc +++ b/guides/common/modules/con_importing-red-hat-subscription-manifests-into-foreman.adoc @@ -13,4 +13,6 @@ Importing a manifest does not change your organization's Simple Content Access s ==== Simple Content Access simplifies the subscription experience for administrators. -For more information, see the link:https://access.redhat.com/subscription_mgmt_guide_for_RHEL[Subscription Management Administration Guide for Red Hat Enterprise Linux] on the Red Hat Customer Portal. + +.Additional resources +* link:https://access.redhat.com/subscription_mgmt_guide_for_RHEL[Subscription Management Administration Guide for Red Hat Enterprise Linux on the Red Hat Customer Portal] diff --git a/guides/common/modules/con_introduction-to-content-management.adoc b/guides/common/modules/con_introduction-to-content-management.adoc index 9aec1a7d204..08e931460ca 100644 --- a/guides/common/modules/con_introduction-to-content-management.adoc +++ b/guides/common/modules/con_introduction-to-content-management.adoc @@ -17,29 +17,3 @@ ifdef::foreman-el,katello[] The Katello plugin provides content management features to Foreman. You can only use this guide if you have the Katello plugin installed. endif::[] - -{ProjectName} provides the following management capabilities: - -ifdef::satellite[] -Subscription management:: -This provides organizations with a method to manage their Red Hat subscription information. -endif::[] - -ifndef::satellite[] -Red Hat Subscription management:: -This provides organizations with a method to store Red Hat content and organize it in various ways. - -SUSE Subscription management:: -This provides organizations with a method to store SUSE content and organize it in various ways. -Note that this requires the SCC Manager plugin. -For more information, see xref:Managing_SUSE_Content_{context}[]. -endif::[] - -Content management:: -ifdef::satellite[] -This provides organizations with a method to store Red Hat content and organize it in various ways. -endif::[] -ifdef::foreman-el,katello,orcharhino[] -This provides organizations with a method to store Deb and Yum content and organize it in various ways. -endif::[] -In the context of {Project}, _content_ is defined as the software installed on hosts. diff --git a/guides/common/modules/con_managing-content-view-environments.adoc b/guides/common/modules/con_managing-content-view-environments.adoc index ab65de97edd..92410921600 100644 --- a/guides/common/modules/con_managing-content-view-environments.adoc +++ b/guides/common/modules/con_managing-content-view-environments.adoc @@ -7,6 +7,3 @@ A content view environment combines a specific lifecycle environment with a content view and describes which version of the content view to use. You can assign hosts and activation keys to one or more content view environments instead of assigning lifecycle environments and content views separately. When you assign a host to multiple content view environments, the host gains access to the combined repositories from all its associated content view environments. - -You can also assign content view environments to an activation key to give hosts access to content during host registration. -For more information, see xref:assigning-content-view-environments-to-an-activation-key-by-using-web-ui[]. diff --git a/guides/common/modules/con_managing-content-views.adoc b/guides/common/modules/con_managing-content-views.adoc index 00d8501459b..5e9975962dc 100644 --- a/guides/common/modules/con_managing-content-views.adoc +++ b/guides/common/modules/con_managing-content-views.adoc @@ -6,27 +6,3 @@ [role="_abstract"] {ProjectName} uses content views to allow your hosts access to a deliberately curated subset of content. To do this, you must define which repositories to use and then apply certain filters to the content. - -The general workflow for creating content views for filtering and creating snapshots is as follows: - -. Create a content view. -. Add one or more repositories that you want to the content view. -. Optional: Create one or more filters to refine the content of the content view. -For more information, see xref:Content_Filter_Examples_{context}[]. -. Optional: Resolve any package dependencies for a content view. -For more information, see xref:Resolving_Package_Dependencies_{context}[]. -. Publish the content view. -. Optional: Promote the content view to another environment. -For more information, see xref:promoting-a-content-view-by-using-web-ui[]. -. Attach the host to the content view. - -ifdef::client-content-dnf[] -If a repository is not associated with the content view, the file `/etc/yum.repos.d/redhat.repo` remains empty and systems registered to it cannot receive updates. -endif::[] -ifdef::client-content-apt[] -If a repository is not associated with the content view, the file `/etc/apt/sources.list.d/rhsm.sources` remains empty and systems registered to it cannot receive updates. -endif::[] - -Hosts can only be associated with a single content view. -To associate a host with multiple content views, create a composite content view. -For more information, see xref:creating-a-composite-content-view-by-using-web-ui[]. diff --git a/guides/common/modules/con_managing-red-hat-subscriptions.adoc b/guides/common/modules/con_managing-red-hat-subscriptions.adoc index bccb433a963..e9f7953ca1f 100644 --- a/guides/common/modules/con_managing-red-hat-subscriptions.adoc +++ b/guides/common/modules/con_managing-red-hat-subscriptions.adoc @@ -25,9 +25,7 @@ When you add future-dated subscriptions to your manifest before the expiry date Subscriptions service:: The Subscriptions service on the {RHCloud} helps you track and manage Red{nbsp}Hat subscription usage across connected and disconnected systems. It collects usage data, displays trends in a centralized dashboard, and supports historical analysis for planning and compliance. -For more information, see xref:tracking-subscription-usage-by-using-the-subscriptions-service[]. -ifndef::orcharhino[] .Additional resources ifndef::satellite[] * {InstallingServerDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn-by-using-web-ui[Configuring {ProjectServer} to consume content from a custom CDN in _{InstallingServerDocTitle}_] @@ -36,4 +34,4 @@ ifdef::satellite[] * {InstallingServerDisconnectedDocURL}configuring-{project-context}-server-to-consume-content-from-a-custom-cdn-by-using-web-ui[Configuring {ProjectServer} to consume content from a custom CDN in _{InstallingServerDisconnectedDocTitle}_] * https://access.redhat.com/solutions/7065718[How to register and subscribe a system offline to the Red Hat Customer Portal?] endif::[] -endif::[] +* xref:tracking-subscription-usage-by-using-the-subscriptions-service[] diff --git a/guides/common/modules/con_manually-tuning-puma-workers-and-threads-count.adoc b/guides/common/modules/con_manually-tuning-puma-workers-and-threads-count.adoc index 7b5676979ef..ff7e7026836 100644 --- a/guides/common/modules/con_manually-tuning-puma-workers-and-threads-count.adoc +++ b/guides/common/modules/con_manually-tuning-puma-workers-and-threads-count.adoc @@ -4,7 +4,7 @@ = Manually tuning Puma workers and threads count [role="_abstract"] -If you decide not to rely on xref:Puma_Workers_and_Threads_Auto_Tuning_{context}[], you can apply custom numbers for these tunables. +If you decide not to rely on Puma workers and threads auto-tuning, you can apply custom numbers for these tunables. In the example below we are using 2 workers and 5 threads: [options="nowrap", subs="+attributes"] diff --git a/guides/common/modules/con_migrating-from-internal-databases-to-external-databases.adoc b/guides/common/modules/con_migrating-from-internal-databases-to-external-databases.adoc index 5162d93227e..e72e9a6e92e 100644 --- a/guides/common/modules/con_migrating-from-internal-databases-to-external-databases.adoc +++ b/guides/common/modules/con_migrating-from-internal-databases-to-external-databases.adoc @@ -19,15 +19,3 @@ Red Hat does not provide support or tools for external database maintenance. This includes backups, upgrades, and database tuning. You must have your own database administrator to support and maintain external databases. endif::[] - -To migrate from the default internal databases to external databases, you must complete the following procedures: - -. xref:installing-postgresql_{context}[]. -ifdef::katello,orcharhino,satellite[] -Prepare PostgreSQL with databases for Foreman, Pulp, and Candlepin with dedicated users owning them. -endif::[] -ifdef::foreman-el,foreman-deb[] -Prepare PostgreSQL with a database for Foreman with a dedicated user owning it. -endif::[] -. xref:migrating-to-external-databases_{context}[]. -Edit the parameters of `{foreman-installer}` to point to the new databases, and run `{foreman-installer}`. diff --git a/guides/common/modules/con_more-information-about-amazon-web-services.adoc b/guides/common/modules/con_more-information-about-amazon-web-services.adoc deleted file mode 100644 index c02174643b6..00000000000 --- a/guides/common/modules/con_more-information-about-amazon-web-services.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="More_Information_About_Amazon_Web_Services_{context}"] -= More information about Amazon Web Services and {Project} - -[role="_abstract"] -ifndef::orcharhino[] -For information about how to locate Red{nbsp}Hat Gold Images on Amazon Web Services EC2, see https://access.redhat.com/articles/2962171[How to Locate Red{nbsp}Hat Cloud Access Gold Images on AWS EC2]. -endif::[] - -For information about how to install and use the Amazon Web Service Client on Linux, see https://docs.aws.amazon.com/cli/latest/userguide/awscli-install-linux.html[Install the AWS Command Line Interface on Linux] in the Amazon Web Services documentation. - -For information about importing and exporting virtual machines in Amazon Web Services, see https://aws.amazon.com/ec2/vm-import/[VM Import/Export] in the Amazon Web Services documentation. diff --git a/guides/common/modules/con_network-resources.adoc b/guides/common/modules/con_network-resources.adoc index 418e3d1140e..d38bd7b004c 100644 --- a/guides/common/modules/con_network-resources.adoc +++ b/guides/common/modules/con_network-resources.adoc @@ -39,8 +39,6 @@ This IPAM is safe to use with concurrent host creation as IP addresses are retur + Options DHCP, Internal DB and Random DB can lead to DHCP conflicts on subnets with records created externally. These subnets must be under exclusive {Project} control. -+ -For more information about adding a subnet, see xref:adding-a-subnet-to-server-by-using-web-ui[]. DHCP Ranges:: You can define the same DHCP range in {ProjectServer} for both discovered and provisioned systems, but use a separate range for each service within the same subnet. diff --git a/guides/common/modules/con_overview-of-the-conversion-process.adoc b/guides/common/modules/con_overview-of-the-conversion-process.adoc index 327e31293c7..6afd19e912f 100644 --- a/guides/common/modules/con_overview-of-the-conversion-process.adoc +++ b/guides/common/modules/con_overview-of-the-conversion-process.adoc @@ -27,5 +27,10 @@ You can use the Ansible Playbook for other conversions as well, but in those cas However, this approach was not tested and is not supported. endif::[] -If you convert to a RHEL version that is in the https://access.redhat.com/support/policy/updates/errata#Extended_Life_Cycle_Phase[Extended Life Phase] and you do not plan to upgrade your host to a fully supported RHEL version, Red{nbsp}Hat recommends using an Extended Life Cycle Support (ELS) Add-On subscription during the conversion. -Note that the conversion and the subsequent upgrade without an ELS subscription come with a limited support scope per the https://access.redhat.com/support/policy/convert2rhel-support[RHEL Conversion Support Policy] and the https://access.redhat.com/support/policy/ipu-support[RHEL In-place upgrade Support Policy]. +If you convert to a RHEL version that is in the Extended Life Phase and you do not plan to upgrade your host to a fully supported RHEL version, Red{nbsp}Hat recommends using an Extended Life Cycle Support (ELS) Add-On subscription during the conversion. +Note that the conversion and the subsequent upgrade without an ELS subscription come with a limited support scope. + +.Additional resources +* https://access.redhat.com/support/policy/updates/errata#Extended_Life_Cycle_Phase[Extended Life Phase] +* https://access.redhat.com/support/policy/convert2rhel-support[RHEL Conversion Support Policy] +* https://access.redhat.com/support/policy/ipu-support[RHEL In-place upgrade Support Policy] diff --git a/guides/common/modules/con_preparing-client-platforms.adoc b/guides/common/modules/con_preparing-client-platforms.adoc index 832d44e689e..803f5d87943 100644 --- a/guides/common/modules/con_preparing-client-platforms.adoc +++ b/guides/common/modules/con_preparing-client-platforms.adoc @@ -13,22 +13,3 @@ ifdef::katello,orcharhino,satellite[] The records for Red{nbsp}Hat supported platforms are created automatically when you enable a Red{nbsp}Hat repository. ==== endif::[] - -Compute profiles:: -+ --- -You can predefine virtual machine hardware details such as CPUs, memory, and storage, by using compute profiles. - -A default installation of {ProjectName} contains three predefined profiles: - -* `1-Small` -* `2-Medium` -* `3-Large` - -You can apply compute profiles to all supported compute resources. For supported compute resources, see the following information: - -* xref:supported-cloud-providers[] -* xref:supported-virtualization-infrastructures[] - -For information on creating a custom compute profile, see xref:creating-compute-profiles-by-using-web-ui[]. --- diff --git a/guides/common/modules/con_products-and-repositories.adoc b/guides/common/modules/con_products-and-repositories.adoc index bf8936f49fd..ac4d940039f 100644 --- a/guides/common/modules/con_products-and-repositories.adoc +++ b/guides/common/modules/con_products-and-repositories.adoc @@ -24,7 +24,6 @@ Red Hat content is already organized into products. For example, {RHEL} Server is a _product_ in {Project}. The repositories for that product consist of different versions, architectures, and add-ons. For Red{nbsp}Hat repositories, products are created automatically after enabling the repository. -For more information, see xref:enabling-red-hat-repositories-by-using-web-ui[]. Other content can be organized into {customproduct}s however you want. For example, you might create an EPEL (Extra Packages for Enterprise Linux) Product and add an "EPEL 7 x86_64" repository to it. @@ -41,3 +40,6 @@ endif::[] ifdef::satellite[] For more information about creating and packaging RPMs, see the {RHELDocsBaseURL}7/html-single/rpm_packaging_guide/[_{RHEL}{nbsp}7 RPM Packaging Guide_]. endif::[] + +.Additional resources +* xref:enabling-red-hat-repositories-by-using-web-ui[] diff --git a/guides/common/modules/con_projectname-installation-helper-app.adoc b/guides/common/modules/con_projectname-installation-helper-app.adoc deleted file mode 100644 index bf075bcdec5..00000000000 --- a/guides/common/modules/con_projectname-installation-helper-app.adoc +++ /dev/null @@ -1,11 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="{ProjectNameID}-installation-helper-app"] -= {ProjectName} Installation Helper app - -[role="_abstract"] -You can use the {ProjectName} Installation Helper app to obtain customized upgrade instructions. - -For interactive instructions for performing the installation, you can use the {ProjectName} Installation Helper on the Red{nbsp}Hat Customer Portal. -This application provides you with an interactive way to prepare installation instructions customized for your required {Project} version number and configuration. -For more information, see https://access.redhat.com/labs/rhsih/[{ProjectName} Installation Helper] on the Red{nbsp}Hat Customer Portal. diff --git a/guides/common/modules/con_projectname-upgrade-helper-app.adoc b/guides/common/modules/con_projectname-upgrade-helper-app.adoc deleted file mode 100644 index ed69467f611..00000000000 --- a/guides/common/modules/con_projectname-upgrade-helper-app.adoc +++ /dev/null @@ -1,15 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id="{ProjectNameID}-upgrade-helper-app"] -= {ProjectName} Upgrade Helper app - -[role="_abstract"] -You can use the {ProjectName} Upgrade Helper app to obtain customized upgrade instructions. - -For interactive instructions for performing the upgrade, you can use the {ProjectName} Upgrade Helper on the Red{nbsp}Hat Customer Portal. -This application provides upgrade instructions customized for your current version number of {Project}. -As a result, you receive instructions that are specific to your upgrade path, as well as steps to prevent known issues. -For more information, see https://access.redhat.com/labs/satelliteupgradehelper/[{Project} Upgrade Helper] on the Red{nbsp}Hat Customer Portal. - -.Additional resources -* https://www.youtube.com/watch?v=Z0s1ZvKtJSg&list=PLbMP1JcGBmSE3euqNSXzbOq9FOpChYUQN&index=8[Upgrade Red{nbsp}Hat {Project} & {SmartProxy} Using {Project} Upgrade Helper – Step-by-Step Guide] diff --git a/guides/common/modules/con_projectserver-with-multiple-manifests.adoc b/guides/common/modules/con_projectserver-with-multiple-manifests.adoc index 41a8e4a1c27..7fec484bc4f 100644 --- a/guides/common/modules/con_projectserver-with-multiple-manifests.adoc +++ b/guides/common/modules/con_projectserver-with-multiple-manifests.adoc @@ -13,7 +13,6 @@ You can then use the multiple manifests in one {ProjectServer} to manage multipl 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. @@ -48,3 +47,8 @@ This enables uninterrupted access to repositories when future-dated subscription Note that the Red{nbsp}Hat subscription manifest can be modified and reloaded to {ProjectServer} in case of any changes in your infrastructure, or when adding more subscriptions. Manifests should not be deleted. If you delete the manifest from the Red Hat Customer Portal or in the {ProjectWebUI} it will unregister all of your hosts. + +ifdef::satellite[] +.Additional resources +* https://www.redhat.com/en/technologies/management/satellite[{Project} Add-On] +endif::[] diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc index 58bebe7411a..6016db98288 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-google-compute-engine.adoc @@ -9,16 +9,3 @@ ifdef::satellite[] You can only use golden images supported by {Team} with {Project} for creating GCE hosts. endif::[] - -Before you can provision cloud instances on Google Compute Engine, ensure that your environment meets the following requirements: - -include::snip_prerequisite-networking-for-provisioning.adoc[] -+ -include::snip_prerequisites-common-compute-resource.adoc[] -* In your GCE project, configure a service account with the necessary IAM Compute role. -For more information, see https://cloud.google.com/compute/docs/access/iam[Compute Engine IAM roles] in the GCE documentation. -* In your GCE project-wise metadata, set the `enable-oslogin` to `FALSE`. -For more information, see https://cloud.google.com/compute/docs/instances/managing-instance-access#enable_oslogin[Enabling or disabling OS Login] in the GCE documentation. -* Optional: If you want to use Puppet with GCE hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. -* Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. -For more information, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates] in _{ProvisioningDocTitle}_. diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc index 99251ec7d88..67aefd9d11a 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-microsoft-azure-resource-manager.adoc @@ -3,22 +3,7 @@ [id="Provisioning_Cloud_Instances_on_Microsoft_Azure_Resource_Manager_{context}"] = Provisioning cloud instances on Microsoft Azure Resource Manager -[role="_abstract"] +[role="_abstract"] {Project} can interact with Microsoft Azure Resource Manager, including creating new virtual machines and controlling their power management states. Only image-based provisioning is supported for creating Azure hosts. This includes provisioning by using Marketplace images, custom images, and shared image gallery. - -For more information about Azure Resource Manager concepts, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/[Azure Resource Manager documentation]. - -Before you can provision cloud instances on Microsoft Azure, ensure that your environment meets the following requirements: - -include::snip_prerequisites-common-compute-resource.adoc[] -* Ensure that you have the correct permissions to create an Azure Active Directory application. -For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#required-permissions[Check Azure AD permissions] in the _Microsoft identity platform (Azure Active Directory for developers)_ documentation. -* You must create and configure an Azure Active Directory application and service principle to obtain Application or _client_ ID, Directory or _tenant_ ID, and Client Secret. -For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal[Use the portal to create an Azure AD application and service principal that can access resources] in the _Microsoft identity platform (Azure Active Directory for developers)_ documentation. -* Optional: If you want to use Puppet with Azure hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. -* Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. -For more information about provisioning templates, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates]. -* Optional: If you want the virtual machine to use a static private IP address, create a subnet in {Project} with the *Network Address* field matching the Azure subnet address. -* Before creating {RHEL} BYOS images, you must accept the image terms either in the Azure CLI or Portal so that the image can be used to create and manage virtual machines for your subscription. diff --git a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc index 3dab984d902..28b33b4aa62 100644 --- a/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc +++ b/guides/common/modules/con_provisioning-cloud-instances-on-openstack.adoc @@ -7,15 +7,3 @@ {OpenStack} provides the foundation to build a private or public Infrastructure-as-a-Service (IaaS) cloud. It offers a massively scalable, fault-tolerant platform for the development of cloud-enabled workloads. In {Project}, you can interact with {OpenStack} REST API to create cloud instances and control their power management states. - -Before you can provision cloud instances on {OpenStack}, ensure that your environment meets the following requirements: - -include::snip_prerequisites-common-compute-resource.adoc[] -* A {SmartProxyServer} managing a network in your OpenStack environment. -For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. -* An image added to OpenStack Image Storage (glance) service for image-based provisioning. -ifndef::orcharhino[] -For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. -endif::[] - -include::snip_warning-destroy-vm-on-host-delete.adoc[] diff --git a/guides/common/modules/con_provisioning-fips-compliant-hosts.adoc b/guides/common/modules/con_provisioning-fips-compliant-hosts.adoc index 4ae7cb300f9..5a833509484 100644 --- a/guides/common/modules/con_provisioning-fips-compliant-hosts.adoc +++ b/guides/common/modules/con_provisioning-fips-compliant-hosts.adoc @@ -4,14 +4,4 @@ = Provisioning FIPS-compliant hosts [role="_abstract"] -{Project} supports provisioning hosts that comply with the National Institute of Standards and Technology's https://csrc.nist.gov/publications/detail/fips/140/2/final[Security Requirements for Cryptographic Modules] standard, reference number FIPS 140-2, referred to here as FIPS. - -To enable the provisioning of hosts that are FIPS-compliant, complete the following tasks: - -* Change the provisioning password hashing algorithm for the operating system -* Create a host group and set a host group parameter to enable FIPS - -For more information, see {ManagingHostsDocURL}Working_with_Host_Groups_managing-hosts[Working with host groups] in _{ManagingHostsDocTitle}_. - -The provisioned hosts have the FIPS-compliant settings applied. -To confirm that these settings are enabled, complete the steps in xref:Verifying_FIPS_Mode_Is_Enabled_{context}[]. +{Project} supports provisioning hosts that comply with the National Institute of Standards and Technology's Security Requirements for Cryptographic Modules standard, reference number FIPS 140-2, referred to here as FIPS. diff --git a/guides/common/modules/con_provisioning-hardware-types.adoc b/guides/common/modules/con_provisioning-hardware-types.adoc index 078425ce741..d0422e317e3 100644 --- a/guides/common/modules/con_provisioning-hardware-types.adoc +++ b/guides/common/modules/con_provisioning-hardware-types.adoc @@ -28,5 +28,6 @@ Cloud instances:: You can instruct {Project} to use a particular hardware profile by defining a compute profile. ifdef::orcharhino[] -For more information, see xref:sources/compute_resources.adoc[compute resources]. +.Additional resources +* xref:sources/compute_resources.adoc[compute resources] endif::[] diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc index f9337a37764..1a38ba1e2f2 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kubevirt.adoc @@ -21,13 +21,6 @@ Before you start provisioning virtual machines on {KubeVirt}, ensure that your e * You must have the `get`, `delete`, `create`, `update`, `patch`, `list`, and `watch` permissions for VMs and other {KubeVirt} resources for the {Kubernetes} cluster in the specified namespace. You can get these permissions with the `kubevirt.io:edit` cluster role. -For more information on {KubeVirt} cluster roles, see -ifdef::satellite[] -link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/virtualization/about#authorization_virt-security-policies[Authorization] for OpenShift Container Platform Virtualization. -endif::[] -ifndef::satellite[] -link:https://kubevirt.io/user-guide/cluster_admin/authorization/[Authorization] in the _KubeVirt user guide_. -endif::[] * To use auto-completion for network selection, you must have the `get` and `list` permissions for the `network-attachment-definitions.k8s.cni.cncf.io` resource. include::snip_prerequisites-common-compute-resource.adoc[] @@ -36,6 +29,14 @@ include::snip_prerequisites-common-compute-resource.adoc[] Ensure that no other DHCP services run on this network to avoid conflicts with {SmartProxyServer}. For more information about network service configuration for {SmartProxyServers}, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. * Ensure the provisioning user has the required permissions to provision hosts. -For more information, see xref:permissions-required-to-provision-hosts[]. include::snip_warning-destroy-vm-on-host-delete.adoc[] + +.Additional resources +ifdef::satellite[] +* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/virtualization/about#authorization_virt-security-policies[Authorization for OpenShift Container Platform Virtualization] +endif::[] +ifndef::satellite[] +* link:https://kubevirt.io/user-guide/cluster_admin/authorization/[Authorization in the KubeVirt user guide] +endif::[] +* xref:permissions-required-to-provision-hosts[] diff --git a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc index 837afe74c36..b717d8f25e6 100644 --- a/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc +++ b/guides/common/modules/con_provisioning-virtual-machines-on-kvm.adoc @@ -38,6 +38,8 @@ If you want to use a non-root user on the KVM server, you must add the user to t # usermod -a -G libvirt _non_root_user_ ---- * Ensure the provisioning user has the required permissions to provision hosts. -For more information, see xref:permissions-required-to-provision-hosts[]. include::snip_warning-destroy-vm-on-host-delete.adoc[] + +.Additional resources +* xref:permissions-required-to-provision-hosts[] diff --git a/guides/common/modules/con_pxe-booting-in-project.adoc b/guides/common/modules/con_pxe-booting-in-project.adoc index 6a6cbbc98e9..0fa8d497b3f 100644 --- a/guides/common/modules/con_pxe-booting-in-project.adoc +++ b/guides/common/modules/con_pxe-booting-in-project.adoc @@ -21,7 +21,6 @@ PXE booting requirements:: ** Optional: If the host and the DHCP server are separated by a router, configure the DHCP relay agent and point to the DHCP server. * Client requirements: ** Ensure that all the network-based firewalls are configured to allow clients on the subnet to access the {SmartProxy}. -For more information, see xref:networking-considerations-in-{project-context}[]. ** Ensure that your client has access to the DHCP and TFTP servers. * {Project} requirements: ** Ensure that both {ProjectServer} and {SmartProxy} have DNS configured and are able to resolve provisioned host names. @@ -39,3 +38,4 @@ For more information, see xref:networking-considerations-in-{project-context}[]. ifdef::satellite[] * https://access.redhat.com/solutions/163253[How to set-up/configure a PXE Server in the Red{nbsp}Hat Knowledgebase] endif::[] +* xref:networking-considerations-in-{project-context}[] diff --git a/guides/common/modules/con_query-syntax.adoc b/guides/common/modules/con_query-syntax.adoc index f02b331e8e1..e92470eef2f 100644 --- a/guides/common/modules/con_query-syntax.adoc +++ b/guides/common/modules/con_query-syntax.adoc @@ -15,5 +15,6 @@ Available fields, resources to search, and the way the query is interpreted all For example, the field "hostgroup" on the Hosts page is equivalent to the field "name" on the Host Groups page. The field type also determines available operators and accepted values. -For a list of all operators, see xref:Query_Operators_{context}[Operators]. -For descriptions of value formats, see xref:Query_Values_{context}[Values]. +.Additional resources +* xref:Query_Operators_{context}[] +* xref:Query_Values_{context}[] diff --git a/guides/common/modules/con_redis-tuning.adoc b/guides/common/modules/con_redis-tuning.adoc index 8a0b7459fb1..656b87c99a7 100644 --- a/guides/common/modules/con_redis-tuning.adoc +++ b/guides/common/modules/con_redis-tuning.adoc @@ -14,4 +14,6 @@ endif::[] Given the way {Project} uses Redis, its memory consumption should be stable. The Redis authors recommend disabling Transparent Hugepage on servers running Redis. -For more information, see xref:Disable_Transparent_Hugepage_{context}[]. + +.Additional resources +* xref:Disable_Transparent_Hugepage_{context}[] diff --git a/guides/common/modules/con_remote-execution-in-project.adoc b/guides/common/modules/con_remote-execution-in-project.adoc index 23422c802e9..7d76140318a 100644 --- a/guides/common/modules/con_remote-execution-in-project.adoc +++ b/guides/common/modules/con_remote-execution-in-project.adoc @@ -14,28 +14,28 @@ Use remote execution for the following benefits in {Project}: * Specify custom values for templates when you run the command. Communication for remote execution occurs through {SmartProxyServer}, which means that {ProjectServer} does not require direct access to the target host, and can scale to manage many hosts. -ifeval::["{context}" == "ansible"] -For more information, see xref:transport-modes-for-remote-execution_{context}[]. -endif::[] To use remote execution, you must define a job template. A job template is a command that you want to apply to remote hosts. You can execute a job template multiple times. {Project} uses ERB syntax job templates. -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}_. endif::[] By default, {Project} includes several job templates for shell scripts and Ansible. -ifdef::configuring-ansible,managing-hosts[] -For more information, see xref:customizing-job-templates[]. -endif::[] -ifeval::["{context}" == "planning"] .Additional resources +ifeval::["{context}" == "planning"] * {ManagingConfigurationsAnsibleDocURL}configuring-and-setting-up-remote-jobs[Configuring and setting up remote jobs in _{ManagingConfigurationsAnsibleDocTitle}_] endif::[] +ifeval::["{context}" == "ansible"] +* xref:transport-modes-for-remote-execution_{context}[] +endif::[] +ifdef::managing-hosts[] +* xref:Template_Writing_Reference_{context}[] +endif::[] +ifdef::configuring-ansible,managing-hosts[] +* xref:customizing-job-templates[] +endif::[] diff --git a/guides/common/modules/con_restoring-server-or-smart-proxy-from-a-backup.adoc b/guides/common/modules/con_restoring-server-or-smart-proxy-from-a-backup.adoc index a80fe3c9282..d116f057618 100644 --- a/guides/common/modules/con_restoring-server-or-smart-proxy-from-a-backup.adoc +++ b/guides/common/modules/con_restoring-server-or-smart-proxy-from-a-backup.adoc @@ -4,7 +4,7 @@ = Restoring {ProjectServer} or {SmartProxyServer} from a backup [role="_abstract"] -You can restore {ProjectServer} or {SmartProxyServer} from the backup data that you create as part of xref:backing-up-{project-context}-server-and-{smart-proxy-context}_{context}[]. +If you have created a backup of {ProjectServer} or {SmartProxyServer}, you can restore the server from the backup data. This process outlines how to restore the backup on the same server that generated the backup, and all data covered by the backup is deleted on the target system. If the original system is unavailable, provision a system with the same configuration settings and host name. diff --git a/guides/common/modules/con_salt-architecture.adoc b/guides/common/modules/con_salt-architecture.adoc index ab9ce55c281..282d11b0e31 100644 --- a/guides/common/modules/con_salt-architecture.adoc +++ b/guides/common/modules/con_salt-architecture.adoc @@ -7,8 +7,6 @@ You need a Salt Master that either runs on your {ProjectServer} or {SmartProxyServer} with the Salt plugin enabled. You can also use an existing Salt Master by installing and configuring the relevant {SmartProxy} features on the existing Salt Master host. -For more information on installing a Salt Master, see https://docs.saltproject.io/en/latest/contents.html[official Salt documentation]. - Salt uses the following terminology: * Hosts are referred to as _Salt Minions_. @@ -20,3 +18,6 @@ Use the same Salt version on the Salt Master as you are using on your Salt Minio ifdef::katello,orcharhino[] You can use content management in {Project} to provide hosts with the correct version of the Salt Minion client software. endif::[] + +.Additional resources +* https://docs.saltproject.io/en/latest/contents.html[official Salt documentation] diff --git a/guides/common/modules/con_scap-content-in-project.adoc b/guides/common/modules/con_scap-content-in-project.adoc index 2a70b88f660..ce5b6a9f842 100644 --- a/guides/common/modules/con_scap-content-in-project.adoc +++ b/guides/common/modules/con_scap-content-in-project.adoc @@ -5,7 +5,7 @@ [role="_abstract"] In {Project}, you use an XCCDF profile from SCAP content and, eventually, a tailoring file, to define a _compliance policy_. -{Project} includes default SCAP contents from SCAP Security Guide provided by the https://www.open-scap.org/[OpenSCAP project]. +{Project} includes default SCAP contents from SCAP Security Guide provided by the OpenSCAP project. SCAP content is a SCAP data-stream file that contains implementation of compliance, configuration, or security baselines. A single data stream usually includes multiple XCCDF profiles. @@ -13,3 +13,6 @@ An XCCDF profile defines an industry standard or custom security standard agains You can adapt existing XCCDF profiles according to your requirements by using _tailoring files_. {Project} supports content of SCAP versions 1.2 and 1.3. + +.Additional resources +* https://www.open-scap.org/[OpenSCAP project] diff --git a/guides/common/modules/con_secure-boot-in-project.adoc b/guides/common/modules/con_secure-boot-in-project.adoc index 9213613b250..0246f16c42c 100644 --- a/guides/common/modules/con_secure-boot-in-project.adoc +++ b/guides/common/modules/con_secure-boot-in-project.adoc @@ -13,7 +13,7 @@ On Debian and Ubuntu operating systems, the grub2 boot loader is created using t To perform the Secure Boot, the boot loader must be manually signed and key enrolled into the EFI firmware. Alternatively, grub2 from Ubuntu or {EL} can be copied to perform booting. -Grub2 in {EL} 8.0-8.3 were updated to mitigate https://access.redhat.com/security/vulnerabilities/grub2bootloader[Boot Hole Vulnerability] and keys of existing {EL} kernels were invalidated. +Grub2 in {EL} 8.0-8.3 were updated to mitigate Boot Hole Vulnerability and keys of existing {EL} kernels were invalidated. To boot any of the affected {EL} kernel (or operating system installer), you must enroll keys manually into the EFI firmware for each host: [options="nowrap" subs="+quotes,attributes"] @@ -22,3 +22,6 @@ To boot any of the affected {EL} kernel (or operating system installer), you mus # mokutil --import-hash # reboot ---- + +.Additional resources +* https://access.redhat.com/security/vulnerabilities/grub2bootloader[Boot Hole Vulnerability] diff --git a/guides/common/modules/con_shellhooks-plugin.adoc b/guides/common/modules/con_shellhooks-plugin.adoc index 7f53f90dfa7..4d23f9694e6 100644 --- a/guides/common/modules/con_shellhooks-plugin.adoc +++ b/guides/common/modules/con_shellhooks-plugin.adoc @@ -16,10 +16,6 @@ You must place your executable scripts in `/var/lib/foreman-proxy/shellhooks` wi You can pass input to shellhook script through the webhook payload. This input is redirected to standard input of the shellhook script. You can pass arguments to shellhook script by using HTTP headers in format `X-Shellhook-Arg-1` to `X-Shellhook-Arg-99`. -For more information on passing arguments to shellhook script, see: - -* xref:passing-arguments-to-shellhook-script-using-webhooks_{context}[] -* xref:passing-arguments-to-shellhook-script-using-curl_{context}[] The HTTP method must be POST. An example URL would be: `\https://{smartproxy-example-com}:{smartproxy_port}/shellhook/My_Script`. @@ -35,4 +31,7 @@ Standard output and standard error output are redirected to the {SmartProxy} log The shellhook HTTPS calls do not return a value. -For an example on creating a shellhook script, see xref:creating-a-shellhook-to-print-arguments_{context}[]. +.Additional resources +* xref:passing-arguments-to-shellhook-script-using-webhooks_{context}[] +* xref:passing-arguments-to-shellhook-script-using-curl_{context}[] +* xref:creating-a-shellhook-to-print-arguments_{context}[] diff --git a/guides/common/modules/con_smart-proxy-networking.adoc b/guides/common/modules/con_smart-proxy-networking.adoc index 76f2d028452..fe385c02cfc 100644 --- a/guides/common/modules/con_smart-proxy-networking.adoc +++ b/guides/common/modules/con_smart-proxy-networking.adoc @@ -7,13 +7,7 @@ The communication between {ProjectServer} and hosts registered to a {SmartProxyServer} is routed through that {SmartProxyServer}. {SmartProxyServer} also provides {Project} services to hosts. -ifndef::satellite[] -In a topology with hosts connecting to a {SmartProxyServer}, -endif::[] -ifdef::satellite[] -In xref:{project-context}-topology-with-hosts-connecting-to-a-{smart-proxy-context}[], -endif::[] -{SmartProxyServer} provides a single endpoint for all host network communications so that in remote network segments, only firewall ports to the {SmartProxyServer} itself must be open. +In a topology with hosts connecting to a {SmartProxyServer}, {SmartProxyServer} provides a single endpoint for all host network communications so that in remote network segments, only firewall ports to the {SmartProxyServer} itself must be open. Hosts do not need direct access to {ProjectServer}. // TODO: Replace graphic with simpler graphic and reference to "Port and firewall requirements" @@ -23,13 +17,7 @@ ifdef::satellite[] image::common/topology-isolated-satellite.png[{ProjectName} topology with a host] endif::[] -ifndef::satellite[] -In a topology with hosts connecting directly to {ProjectServer}, -endif::[] -ifdef::satellite[] -In xref:{project-context}-topology-with-hosts-connecting-directly-to-{project-context}-server[], -endif::[] -hosts need direct network access to {ProjectServer}. +In a topology with hosts connecting directly to {ProjectServer}, hosts need direct network access to {ProjectServer}. This applies to all {SmartProxyServers} because they are hosts of {ProjectServer}. // TODO: Replace graphic with simpler graphic and reference to "Port and firewall requirements" diff --git a/guides/common/modules/con_smartproxy-overview.adoc b/guides/common/modules/con_smartproxy-overview.adoc index fcc0841cc82..8d0f53ba4b1 100644 --- a/guides/common/modules/con_smartproxy-overview.adoc +++ b/guides/common/modules/con_smartproxy-overview.adoc @@ -13,5 +13,4 @@ ifdef::katello,orcharhino,satellite[] By registering a host to a {SmartProxyServer}, you can configure this host to receive content and configuration from the {SmartProxy} in their location instead of from the central {ProjectServer}. 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}[]. endif::[] diff --git a/guides/common/modules/con_ssl-authentication-overview.adoc b/guides/common/modules/con_ssl-authentication-overview.adoc index f664f2b9359..be6b7699dfe 100644 --- a/guides/common/modules/con_ssl-authentication-overview.adoc +++ b/guides/common/modules/con_ssl-authentication-overview.adoc @@ -10,8 +10,8 @@ By default, {ProjectServer} uses a self-signed certificate. This certificate acts as both the server certificate to verify the encryption key and the certificate authority (CA) to trust the identity of {ProjectServer}. -You can configure {ProjectServer} to use a custom SSL certificate. -For more information, see {InstallingServerDocURL}configuring-{project-context}-server-with-a-custom-ssl-certificate[Configuring {ProjectServer} with a custom SSL certificate] in _{InstallingServerDocTitle}_. +.Additional resources +* {InstallingServerDocURL}configuring-{project-context}-server-with-a-custom-ssl-certificate[Configuring {ProjectServer} with a custom SSL certificate in _{InstallingServerDocTitle}_] ifdef::satellite[] -For more information on disconnected {ProjectServer}, see {InstallingServerDisconnectedDocURL}configuring-{project-context}-server-with-a-custom-ssl-certificate[Configuring {ProjectServer} with a custom SSL certificate] in _{InstallingServerDisconnectedDocTitle}_. +* {InstallingServerDisconnectedDocURL}configuring-{project-context}-server-with-a-custom-ssl-certificate[Configuring {ProjectServer} with a custom SSL certificate in _{InstallingServerDisconnectedDocTitle}_] endif::[] diff --git a/guides/common/modules/con_synchronizing-content-between-servers.adoc b/guides/common/modules/con_synchronizing-content-between-servers.adoc index d8c3ddaabbf..5d746293640 100644 --- a/guides/common/modules/con_synchronizing-content-between-servers.adoc +++ b/guides/common/modules/con_synchronizing-content-between-servers.adoc @@ -5,27 +5,3 @@ [role="_abstract"] 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. - -There are two possible ISS configurations of {Project}, depending on how you deployed your infrastructure: - -ISS Network Sync:: -If your upstream server can communicate with the downstream server over a network, you can synchronize content over HTTPS. -+ -Configure your {Project} to synchronize content over a network. -ifndef::satellite[] -For more information, see xref:configuring-server-to-synchronize-content-over-a-network-by-using-web-ui[]. -endif::[] - -ISS Export Sync:: -If your upstream and downstream servers are air gapped, you can synchronize content by using export and import. -+ -Configure your {Project} to synchronize content by using export and import. -ifndef::satellite[] -For more information, see xref:configuring-projectserver-to-synchronize-content-through-exports-by-using-web-ui[]. -endif::[] - -.Additional resources -* {PlanningDocURL}iss-scenarios_planning[{ISS} scenarios in _{PlanningDocTitle}_] -ifdef::satellite[] -* https://access.redhat.com/solutions/7013903[Hammer content export fails with "Path '/the/path' is not an allowed export path" in the _Red{nbsp}Hat Knowledgebase_] -endif::[] diff --git a/guides/common/modules/con_template-writing-reference.adoc b/guides/common/modules/con_template-writing-reference.adoc index 0fb77185928..445eeda55ec 100644 --- a/guides/common/modules/con_template-writing-reference.adoc +++ b/guides/common/modules/con_template-writing-reference.adoc @@ -6,26 +6,3 @@ [role="_abstract"] Embedded Ruby (ERB) is a tool for generating text files based on templates that combine plain text with Ruby code. You can use the following {Project}-specific macros and variables in your ERB templates. - -When provisioning a host or running a remote job, the code in the ERB is executed and the variables are replaced with the host specific values. -This process is referred to as *rendering*. -{ProjectServer} has the safemode rendering option enabled by default, which prevents any harmful code being executed from templates. - -Note that the default templates provided by {ProjectName} (*Hosts* > *Templates* > *Provisioning Templates*, *Hosts* > *Templates* > *Job templates*, *Monitor* > *Reports* > *Report Templates* ) also provide a good source of ERB syntax examples. - -{ProjectName} uses ERB syntax in the following cases: - -Provisioning templates:: -For more information, see {ProvisioningDocURL}creating-provisioning-templates-by-using-web-ui[Creating provisioning templates in {ProjectWebUI}] in _{ProvisioningDocTitle}_. - -Remote execution job templates:: -For more information, see xref:configuring-and-setting-up-remote-jobs[]. - -Report templates:: -For more information, see xref:Using_Report_Templates_to_Monitor_Hosts_{context}[]. - -Templates for partition tables:: -For more information, see {ProvisioningDocURL}creating-partition-tables-by-using-web-ui[Creating partition tables by using {ProjectWebUI}] in _{ProvisioningDocTitle}_. - -Smart Class Parameters:: -For more information, see {ManagingConfigurationsPuppetDocURL}Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet[Configuring Puppet smart class parameters] in _{ManagingConfigurationsPuppetDocTitle}_. diff --git a/guides/common/modules/con_updating-project.adoc b/guides/common/modules/con_updating-project.adoc index d20ad1d3b12..f3d342b11a6 100644 --- a/guides/common/modules/con_updating-project.adoc +++ b/guides/common/modules/con_updating-project.adoc @@ -7,8 +7,6 @@ ifdef::orcharhino[] {Team} provides updates for your base operating system and backported bugfixes for {Project}. You can use this procedure to apply those updates. - -If you want to upgrade {Project} to the next version, see xref:sources/installation_and_maintenance/upgrading_orcharhino_server.adoc[Upgrading {ProjectServer}] or xref:sources/installation_and_maintenance/upgrading_orcharhino_proxy_server.adoc[Upgrading {SmartProxyServer}]. endif::[] ifndef::orcharhino[] diff --git a/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc b/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc index 9ec851516b0..7bdf47d5ab2 100644 --- a/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-boot-disks-to-provision-hosts.adoc @@ -8,6 +8,3 @@ Some hardware does not provide a PXE boot interface or your environment may not In {Project}, you can provision a host without PXE boot. This is also known as PXE-less provisioning and involves generating a boot ISO that hosts can use. Using this ISO, the host can boot the installation media, connect to {SmartProxy}, and install the operating system. - -{Project} also provides a PXE-less discovery service that operates without PXE-based services, such as DHCP and TFTP. -For more information, see xref:discovery-in-pxeless-mode[]. diff --git a/guides/common/modules/con_using-content-views.adoc b/guides/common/modules/con_using-content-views.adoc index 943506e7a0f..19503427725 100644 --- a/guides/common/modules/con_using-content-views.adoc +++ b/guides/common/modules/con_using-content-views.adoc @@ -10,7 +10,7 @@ You can then register hosts to this content view. These hosts have access only to repositories at the version specified in the content view. This means that you can continue to update repositories on your server while your hosts still consume only the versions of the repositories that they are registered to. If you do not use content views and lifecycle environments, all your hosts consume content from the Default content view and Library environment, which is a snapshot of the latest version of the content on your server. -For more information about content management using content views and application lifecycles, see: +.Additional resources * xref:Managing_Content_Views_{context}[] * xref:Managing_Application_Lifecycles_{context}[] diff --git a/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc b/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc index 6a2a6e75d2c..67127bd4039 100644 --- a/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc +++ b/guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc @@ -6,7 +6,6 @@ [role="_abstract"] iPXE is an open-source network-boot firmware. It provides a full PXE implementation enhanced with additional features, such as booting from an HTTP server. -For more information about iPXE, see link:https://ipxe.org[iPXE website]. ifdef::satellite[] [IMPORTANT] @@ -39,3 +38,6 @@ Chainbooting iPXE has the following workflow: . iPXE retrieves the network credentials, including an HTTP URL, by using DHCP again. . iPXE chainloads the iPXE template from your Templates {SmartProxy}. . iPXE loads the kernel and initial RAM disk of the installer. + +.Additional resources +* link:https://ipxe.org[ipxe.org] diff --git a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc index 724b39d8136..647499e4700 100644 --- a/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc +++ b/guides/common/modules/con_using-network-boot-to-provision-hosts.adoc @@ -23,9 +23,6 @@ ifndef::satellite[] By default, you can provision operating systems from the vendor of the operating system of your {ProjectServer} on Secure Boot enabled hosts. To provision operating systems on Secure Boot enabled hosts from different vendors, you have to provide signed shim and GRUB2 binaries provided by the vendor of your operating system. endif::[] -ifndef::orcharhino,satellite[] -For more information, see xref:configuring-{smart-proxy-context}-for-secure-boot[]. -endif::[] Bonded network interfaces:: You can configure a bonded interface that {Project} will use during the installation process, for example, to download installation content. @@ -38,3 +35,8 @@ After provisioning completes, the provisioned system can also use the bonded int After your host loads the kernel of an installer or the kernel of an operating system, bonding works as expected. Therefore, you can use a boot disk to work around PXE boot limitations when your bonded interface requires configuration on both a switch and your host. ==== + +ifndef::orcharhino,satellite[] +.Additional resources +* xref:configuring-{smart-proxy-context}-for-secure-boot[] +endif::[] diff --git a/guides/common/modules/con_using-the-kernelcare-plugin.adoc b/guides/common/modules/con_using-the-kernelcare-plugin.adoc index 0b0e8ada621..5156c31fb55 100644 --- a/guides/common/modules/con_using-the-kernelcare-plugin.adoc +++ b/guides/common/modules/con_using-the-kernelcare-plugin.adoc @@ -6,7 +6,6 @@ [role="_abstract"] You can use the KernelCare plugin to patch the Linux kernel on hosts without rebooting them. The plugin provides job templates to view and live-patch the Linux kernel on hosts and ensures hosts do not report to {ProjectServer} that a reboot is required through tracer. -For more information, see https://tuxcare.com/enterprise-live-patching-services/[tuxcare.com/enterprise-live-patching-services] and https://docs.tuxcare.com/live-patching-services/[docs.tuxcare.com/live-patching-services]. [IMPORTANT] ==== diff --git a/guides/common/modules/con_using-webhooks.adoc b/guides/common/modules/con_using-webhooks.adoc index 61bc494640c..9c1b733c647 100644 --- a/guides/common/modules/con_using-webhooks.adoc +++ b/guides/common/modules/con_using-webhooks.adoc @@ -6,30 +6,3 @@ [role="_abstract"] A webhook is a way for a web page or web application to provide other applications with information in real time. You can use webhooks to define a call to an external API based on {Project} internal event by using a fire-and-forget message exchange pattern. - -Webhooks are only triggered after an event occurs. -The request usually contains details of the event. -An event triggers callbacks, such as sending an e-mail confirming a host has been provisioned. -The application sending the request does not wait for the response, or ignores it. - -Payload of a webhook is created from webhook templates. -Webhook templates use the same ERB syntax as Provisioning templates. -Available variables: - -* `@event_name`: Name of an event. -* `@webhook_id`: Unique event ID. -* `@payload`: Payload data, different for each event type. To access individual fields, use `@payload[:key_name]` Ruby hash syntax. -* `@payload[:object]`: Database object for events triggered by database actions (create, update, delete). Not available for custom events. -* `@payload[:context]`: Additional information as hash like request and session UUID, remote IP address, user, organization and location. - -Because webhooks use HTTP, no new infrastructure needs be added to existing web services. - -The typical use case for webhooks in {Project} is making a call to a monitoring system when a host is created or deleted. - -Webhooks are useful where the action you want to perform in the external system can be achieved through its API. -Where it is necessary to run additional commands or edit files, the shellhooks plugin for {SmartProxies} is available. -The shellhooks plugin enables you to define a shell script on the {SmartProxy} that can be executed through the API. - -You can use webhooks successfully without installing the shellhooks plugin. - -For a list of available events, see xref:webhooks-available-events_{context}[Available webhook events]. diff --git a/guides/common/modules/con_webhooks-behavior-and-integration.adoc b/guides/common/modules/con_webhooks-behavior-and-integration.adoc new file mode 100644 index 00000000000..a7c99b517ae --- /dev/null +++ b/guides/common/modules/con_webhooks-behavior-and-integration.adoc @@ -0,0 +1,33 @@ +:_mod-docs-content-type: CONCEPT + +[id="webhook-behaviour-and-integration"] += Webhook behavior and integration + +[role="_abstract"] +Webhooks are only triggered after an event occurs. +The request usually contains details of the event. +An event triggers callbacks, such as sending an e-mail confirming a host has been provisioned. +The application sending the request does not wait for the response, or ignores it. + +Payload of a webhook is created from webhook templates. +Webhook templates use the same ERB syntax as Provisioning templates. +Available variables: + +* `@event_name`: Name of an event. +* `@webhook_id`: Unique event ID. +* `@payload`: Payload data, different for each event type. To access individual fields, use `@payload[:key_name]` Ruby hash syntax. +* `@payload[:object]`: Database object for events triggered by database actions (create, update, delete). Not available for custom events. +* `@payload[:context]`: Additional information as hash like request and session UUID, remote IP address, user, organization and location. + +Because webhooks use HTTP, no new infrastructure needs be added to existing web services. + +The typical use case for webhooks in {Project} is making a call to a monitoring system when a host is created or deleted. + +Webhooks are useful where the action you want to perform in the external system can be achieved through its API. +Where it is necessary to run additional commands or edit files, the shellhooks plugin for {SmartProxies} is available. +The shellhooks plugin enables you to define a shell script on the {SmartProxy} that can be executed through the API. + +You can use webhooks successfully without installing the shellhooks plugin. + +.Additional resources +* xref:webhooks-available-events_{context}[] diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc index b9a0fa4304d..a344736d306 100644 --- a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc +++ b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc @@ -15,6 +15,6 @@ For more information about registering hosts, see xref:registering-hosts-by-usin .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. . Click the name of the host you want to modify. -. In the *Host collections* card, click the vertical ellipsis and select *Add host to collections*. +. In the *Host collections* card, open the options menu and select *Add host to collections*. . Select the host collection. . Click *Add*. diff --git a/guides/common/modules/proc_applying-errata-to-a-host.adoc b/guides/common/modules/proc_applying-errata-to-a-host.adoc index 28d9248cff1..fc2a877f577 100644 --- a/guides/common/modules/proc_applying-errata-to-a-host.adoc +++ b/guides/common/modules/proc_applying-errata-to-a-host.adoc @@ -12,5 +12,5 @@ To patch security vulnerabilities and bugs, you can apply errata to a host. . Click *Content* and select the *Errata* tab. . Select the errata you want to apply to the host, or select the checkbox at the top of the list to apply all installable errata. Click the checkbox next to any errata you want to remove from a full list. -. Using the vertical ellipsis icon next to the errata you want to apply to the host, select *Apply via Remote Execution* to use Remote Execution, or select *Apply via customized remote execution* if you want to customize the remote execution. +. Open the options menu next to the errata you want to apply to the host, and select *Apply via Remote Execution* to use Remote Execution, or select *Apply via customized remote execution* if you want to customize the remote execution. . Click *Submit*. diff --git a/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc b/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc index cc63e1c8394..f274888f538 100644 --- a/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc +++ b/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc @@ -6,14 +6,6 @@ [role="_abstract"] You can use the {ProjectWebUI} to review and apply errata to hosts so that security and bugfix updates are installed on selected hosts. -.Prerequisites -* {ProjectName} repositories are synchronized with the latest errata available from Red{nbsp}Hat. -For more information, see {ContentManagementDocURL}synchronizing-repositories-on-demand[Synchronizing repositories on demand] in _{ContentManagementDocTitle}_. -* The hosts are registered to an environment and content view on {ProjectServer}. -For more information, see {ManagingHostsDocURL}registering-hosts-by-using-global-registration[Registering hosts by using global registration] in _{ManagingHostsDocTitle}_. -* The host is configured for remote execution. -For more information about running remote execution jobs, see {ManagingHostsDocURL}configuring-and-setting-up-remote-jobs[Configuring and setting up remote jobs] in _{ManagingHostsDocTitle}_. - .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Content Types* > *Errata*. . Click the name of an erratum you want to apply. diff --git a/guides/common/modules/proc_benchmarking-raw-database-performance.adoc b/guides/common/modules/proc_benchmarking-raw-database-performance.adoc new file mode 100644 index 00000000000..b3ad3339719 --- /dev/null +++ b/guides/common/modules/proc_benchmarking-raw-database-performance.adoc @@ -0,0 +1,45 @@ +:_mod-docs-content-type: PROCEDURE + +[id="benchmarking-raw-database-performance"] += Benchmarking raw database performance + +[role="_abstract"] +You can use `pgbench` to measure raw PostgreSQL performance on your system and validate storage behavior before or after tuning. +Interpreting benchmark results requires a database large enough relative to memory to avoid measuring only cached workloads. + +.Prerequisites +* A non-production system with a valid backup. + +[WARNING] +==== +* Never run benchmarks on a production system or without a valid backup. +* Before you start testing, determine how large the database files are. +Testing with a very small database does not produce meaningful results. +For example, if the database is only 20 GiB and the buffer pool is 32 GiB, the benchmark does not show problems with a large number of connections because the data fits entirely in the buffer pool. +==== + +.Procedure +ifndef::orcharhino[] +. To identify the largest tables by disk space for +ifdef::katello,satellite[] +Candlepin, Foreman, and Pulp, +endif::[] +ifdef::foreman-el,foreman-deb[] +Foreman, +endif::[] +use the https://github.com/RedHatSatellite/satellite-support/blob/master/postgres-size-report[postgres-size-report] script in the https://github.com/RedHatSatellite/satellite-support[satellite-support] Git repository. +For more information, see https://github.com/RedHatSatellite/satellite-support[github.com/RedHatSatellite/satellite-support]. +endif::[] +. Ensure the PostgreSQL data directory `{postgresql-lib-dir}` has enough space for the benchmark workload. +You might need to resize the volume to 100 GiB or more, depending on how long the benchmark runs and how much data it generates. ++ +[NOTE] +==== +Choice of filesystem for PostgreSQL data directory might matter as well. +==== +. Install the PGBench utility: ++ +[options="nowrap", subs="+quotes,attributes"] +---- +# {package-install} postgresql-contrib +---- diff --git a/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc b/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc index 759d084b8af..c7d4601b40e 100644 --- a/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc +++ b/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc @@ -10,7 +10,7 @@ This helps you balance load or point the host to a closer or preferred content s .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. . Click the name of the host you want to modify. -. Click the vertical ellipsis icon next to the *Edit* button and select *Change content source*. +. Open the options menu next to the *Edit* button and select *Change content source*. . Select *Content Source*, *Lifecycle Content View*, and *Content Source* from the lists. . Click *Change content source*. + diff --git a/guides/common/modules/proc_changing-the-module-stream-for-a-host.adoc b/guides/common/modules/proc_changing-the-module-stream-for-a-host.adoc index f0dec141d8f..cf30e21e64f 100644 --- a/guides/common/modules/proc_changing-the-module-stream-for-a-host.adoc +++ b/guides/common/modules/proc_changing-the-module-stream-for-a-host.adoc @@ -11,5 +11,5 @@ You can enable, disable, install, update, and remove module streams from your ho . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. . Click the name of the host you want to modify. . Click the *Content* tab, then click the *Module streams* tab. -. Click the vertical ellipsis next to the module and select the action you want to perform. +. Open the options menu next to the module and select the action you want to perform. You get a REX job notification once the remote execution job is complete. diff --git a/guides/common/modules/proc_configuring-project-to-use-ldap.adoc b/guides/common/modules/proc_configuring-project-to-use-ldap.adoc index ce7864ac55c..a1f3a203c4c 100644 --- a/guides/common/modules/proc_configuring-project-to-use-ldap.adoc +++ b/guides/common/modules/proc_configuring-project-to-use-ldap.adoc @@ -6,6 +6,21 @@ [role="_abstract"] Configure an LDAP authentication source to enable users to log in to {Project} with their existing LDAP credentials. +[NOTE] +==== +While you can configure the LDAP server integrated with {FreeIPA} as an external authentication source, {FreeIPA} users will not be able to log in by using single sign-on. +Instead, consider configuring {FreeIPA} as an external identity provider. +For more information, see xref:configuring-kerberos-sso-with-{FreeIPA-context}-in-{project-context}[]. +==== + +[IMPORTANT] +==== +Users cannot use both {FreeIPA} and LDAP as an authentication method. +After a user authenticates by using one of these methods, they cannot use the other method. + +To change the authentication method for a user, remove the automatically created user from {Project}. +==== + .Prerequisites * Your LDAP server complies with the link:https://datatracker.ietf.org/doc/html/rfc2307[RFC 2307] schema. * Your user account has the following permissions: diff --git a/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc b/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc index c6599d6c168..1b3c9b7618f 100644 --- a/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc +++ b/guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc @@ -16,7 +16,7 @@ As a result, you cannot promote an older version of a content view from the copi .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Select the content view you want to copy. -. Click the vertical ellipsis icon and click *Copy*. +. Open the options menu and click *Copy*. . In the *Name* field, enter a name for the new content view and click *Copy content view*. .Verification diff --git a/guides/common/modules/proc_creating-a-custom-alternate-content-source-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-custom-alternate-content-source-by-using-web-ui.adoc index f0aa45105df..022d5f5d1cd 100644 --- a/guides/common/modules/proc_creating-a-custom-alternate-content-source-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-custom-alternate-content-source-by-using-web-ui.adoc @@ -27,7 +27,7 @@ For example, if your base URL is `\https://{server-example-com}` and your subpat . If SSL verification is required, enable *Verify SSL* and select the SSL CA certificate. . Click *Add*. . Navigate to *Content* > *Alternate Content Sources*. -. Click the vertical ellipsis next to the newly created alternate content source and click *Refresh*. +. Open the options menu next to the newly created alternate content source and click *Refresh*. .Verification . In the {ProjectWebUI}, navigate to *Monitor* > *{Project} Tasks* > *Tasks*. diff --git a/guides/common/modules/proc_creating-a-simplified-alternate-content-source-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-simplified-alternate-content-source-by-using-web-ui.adoc index f14b098a5a7..17014564b0b 100644 --- a/guides/common/modules/proc_creating-a-simplified-alternate-content-source-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-a-simplified-alternate-content-source-by-using-web-ui.adoc @@ -22,7 +22,7 @@ This accelerates synchronization by downloading content directly from the upstre . Select the products that should use the alternate content source. . Click *Add*. . Navigate to *Content* > *Alternate Content Sources*. -. Click the vertical ellipsis next to the newly created alternate content source and click *Refresh*. +. Open the options menu next to the newly created alternate content source and click *Refresh*. .Verification . In the {ProjectWebUI}, navigate to *Monitor* > *{Project} Tasks* > *Tasks*. diff --git a/guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-web-ui.adoc b/guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-web-ui.adoc index 45792c804b4..8bbae3168cf 100644 --- a/guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-web-ui.adoc +++ b/guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-web-ui.adoc @@ -41,4 +41,4 @@ Ensure that you pass the repo labels of the desired repositories. . If SSL verification is required, enable *Verify SSL* and select the SSL CA certificate. . Click *Add*. . Navigate to *Content* > *Alternate Content Sources*. -. Click the vertical ellipsis next to the newly created alternate content source and click *Refresh*. +. Open the options menu next to the newly created alternate content source and click *Refresh*. diff --git a/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc b/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc index aea9edb5d8c..65a48279065 100644 --- a/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc +++ b/guides/common/modules/proc_deleting-multiple-content-view-versions.adoc @@ -10,7 +10,7 @@ You can delete multiple content view versions simultaneously. . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Select the content view you want to delete versions of. . On the *Versions* tab, select the checkbox of the version or versions you want to delete. -. Click the vertical ellipsis icon at the top of the list of content views. +. Open the options menu at the top of the list of content views. . Click *Delete* to open the deletion wizard that shows any affected environments. . If there are no affected environments, review the details and click *Delete*. . If there are any affected environments, reassign any hosts or activation keys before deletion. diff --git a/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-smartproxies.adoc b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-smartproxies.adoc new file mode 100644 index 00000000000..8a47aad5fb6 --- /dev/null +++ b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-smartproxies.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: PROCEDURE + +[id="deploying-a-custom-ssl-certificate-to-{smart-proxy-context}-servers"] += Deploying a {customssl} certificate to {SmartProxyServers} + +[role="_abstract"] +If you have {SmartProxyServers} registered to {Project}, configure them with {customssl} certificates. + +.Procedure +* Follow the procedure in {InstallingSmartProxyDocURL}configuring-capsule-custom-server-certificate_{smart-proxy-context}[Configuring {SmartProxyServer} with a Custom SSL Certificate] in _{InstallingSmartProxyDocTitle}_. diff --git a/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc b/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc index 9435f67bb0a..1516d0ea5e2 100644 --- a/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc +++ b/guides/common/modules/proc_enabling-and-disabling-repositories-on-hosts.adoc @@ -11,4 +11,4 @@ This affects which packages are available for installation or upgrade on the hos . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*, . Select a host. . On the *Content* tab, click the *Repository sets* tab. -. Click the vertical ellipsis to choose *Override to disabled* or *Override to enabled* to disable or enable repositories on hosts. +. Open the options menu and select *Override to disabled* or *Override to enabled* to disable or enable repositories on hosts. diff --git a/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc b/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc index 8f79c40e2c5..4f4a9c0d903 100644 --- a/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc +++ b/guides/common/modules/proc_enabling-custom-repositories-on-hosts.adoc @@ -11,4 +11,5 @@ This allows the host to install packages or consume other content from repositor . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select a host. . Select the *Content* tab, then select *Repository sets*. . From the dropdown, you can filter the *Repository type* column to *Custom*. -. Select the desired number of repositories or click the *Select All* checkbox to select all repositories, then click the vertical ellipsis, and select *Override to Enabled*. +. Select the desired number of repositories or click the *Select All* checkbox to select all repositories. +. Open the options menu, and select *Override to Enabled*. diff --git a/guides/common/modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.adoc b/guides/common/modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.adoc index 3642b53d8b5..c279c0d9bab 100644 --- a/guides/common/modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.adoc +++ b/guides/common/modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.adoc @@ -35,4 +35,4 @@ endif::[] . Click *Submit* to save the host details. This creates a host entry and the host details page appears. . Download the boot disk from {ProjectServer}. -On the host details page, click the vertical ellipsis and select *Full host '_My_Host_Name_' image*. +On the host details page, open the options menu and select *Full host '_My_Host_Name_' image*. diff --git a/guides/common/modules/proc_generating-a-host-boot-disk-by-using-web-ui.adoc b/guides/common/modules/proc_generating-a-host-boot-disk-by-using-web-ui.adoc index 7a20540c8ee..d87e04c2684 100644 --- a/guides/common/modules/proc_generating-a-host-boot-disk-by-using-web-ui.adoc +++ b/guides/common/modules/proc_generating-a-host-boot-disk-by-using-web-ui.adoc @@ -31,4 +31,4 @@ endif::[] . Click *Submit* to save the host details. This creates a host entry and the host details page appears. . Download the boot disk from {ProjectServer}. -On the host details page, click the vertical ellipsis and select *Host '_My_Host_Name_' image*. +On the host details page, open the options menu and select *Host '_My_Host_Name_' image*. diff --git a/guides/common/modules/proc_installing-packages-on-a-host.adoc b/guides/common/modules/proc_installing-packages-on-a-host.adoc index 00ee3dca190..ac0bce84503 100644 --- a/guides/common/modules/proc_installing-packages-on-a-host.adoc +++ b/guides/common/modules/proc_installing-packages-on-a-host.adoc @@ -14,7 +14,7 @@ Available packages depend on the content view environments assigned to the host. . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. . Select a host. . On the *Content* tab, click the *Packages* tab. -. On the vertical ellipsis icon next to the upgrade button, click *Install packages*. +. From the options icon next to the upgrade button, click *Install packages*. . In the *Install packages* window, select the package or packages that you want to install on the host. . Click *Install*. The {ProjectWebUI} shows a notification for the remote execution job. diff --git a/guides/common/modules/proc_installing-the-kernelcare-plugin.adoc b/guides/common/modules/proc_installing-the-kernelcare-plugin.adoc index 105790feadf..2b6c463472a 100644 --- a/guides/common/modules/proc_installing-the-kernelcare-plugin.adoc +++ b/guides/common/modules/proc_installing-the-kernelcare-plugin.adoc @@ -13,3 +13,7 @@ Use the following procedure to install the KernelCare plugin. ---- # {foreman-installer} --enable-foreman-plugin-kernel-care ---- + +.Additional resources +* https://tuxcare.com/enterprise-live-patching-services/[tuxcare.com/enterprise-live-patching-services] +* https://docs.tuxcare.com/live-patching-services/[docs.tuxcare.com/live-patching-services] diff --git a/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc b/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc index 2b6e25b4ed5..6bc8e66fc75 100644 --- a/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc +++ b/guides/common/modules/proc_managing-and-monitoring-hosts-using-cockpit.adoc @@ -18,7 +18,7 @@ For more information, see xref:Distributing_SSH_Keys_for_Remote_Execution_{conte .Procedure . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select the host that you want to manage and monitor with {the-Cockpit}. -. In the upper right of the host window, click the vertical ellipsis and select *Web Console*. +. In the upper right of the host window, open the options menu and select *Web Console*. + You can now access the full range of features available for host monitoring and management, for example, {LoraxCompose}, through {the-Cockpit}. diff --git a/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc b/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc index aa248341267..e52175ce29a 100644 --- a/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc +++ b/guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc @@ -12,7 +12,7 @@ Use this procedure to promote content views across different lifecycle environme .Procedure . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Select the content view that you want to promote. -. Select the version that you want to promote, click the vertical ellipsis icon, and click *Promote*. +. Select the version that you want to promote, click the options icon, and click *Promote*. . Select the environment where you want to promote the content view and click *Promote*. .Next steps diff --git a/guides/common/modules/proc_refreshing-content-counts-on-smart-proxy.adoc b/guides/common/modules/proc_refreshing-content-counts-on-smart-proxy.adoc index ab2487d3287..95f662ae190 100644 --- a/guides/common/modules/proc_refreshing-content-counts-on-smart-proxy.adoc +++ b/guides/common/modules/proc_refreshing-content-counts-on-smart-proxy.adoc @@ -17,4 +17,4 @@ You can then expand the content view to view the repositories associated with th . Expand the content view by clicking *>* to view repositories available to the content view and the specific version for the environment. . View the number of content counts under *Packages* specific to {client-content-type} repositories. . View the number of errata, package groups, files, container tags, container manifests, and Ansible collections under *Additional content*. -. Click the vertical ellipsis in the column to the right next to the environment and click *Refresh counts* to refresh the content counts synchronized on the {SmartProxy} under *Packages*. +. Click the options icon in the column to the right next to the environment and click *Refresh counts* to refresh the content counts synchronized on the {SmartProxy} under *Packages*. diff --git a/guides/common/modules/proc_removing-a-package-from-a-host.adoc b/guides/common/modules/proc_removing-a-package-from-a-host.adoc index 5cc5f42694f..2348c347d87 100644 --- a/guides/common/modules/proc_removing-a-package-from-a-host.adoc +++ b/guides/common/modules/proc_removing-a-package-from-a-host.adoc @@ -9,5 +9,5 @@ To uninstall software or resolve dependency issues, you can remove a package fro .Procedure . In the {ProjectWebUI}, navigate to *Hosts > All Hosts* and select the host containing the package you want to remove. . On the *Content* tab, select *Packages*. -. Click the vertical ellipsis icon at the end of the line for the package you want to remove, and choose the *Remove* option. +. Click the options icon at the end of the line for the package you want to remove, and click *Remove*. . Click *Submit*. diff --git a/guides/common/modules/proc_removing-packages-from-a-host.adoc b/guides/common/modules/proc_removing-packages-from-a-host.adoc index 86f479ac24b..9d634996e36 100644 --- a/guides/common/modules/proc_removing-packages-from-a-host.adoc +++ b/guides/common/modules/proc_removing-packages-from-a-host.adoc @@ -10,6 +10,6 @@ You can remove packages from a host from the {ProjectWebUI} to uninstall softwar . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*. . Select a host. . On the *Content* tab, click the *Packages* tab. -. Click the vertical ellipsis for the package you want to remove. +. Click the options icon for the package you want to remove. . Select *Remove*. The {ProjectWebUI} shows a notification for the remote execution job. diff --git a/guides/common/modules/proc_republishing-content-view-metadata-by-using-web-ui.adoc b/guides/common/modules/proc_republishing-content-view-metadata-by-using-web-ui.adoc index 41787f7594e..983ef3c8f25 100644 --- a/guides/common/modules/proc_republishing-content-view-metadata-by-using-web-ui.adoc +++ b/guides/common/modules/proc_republishing-content-view-metadata-by-using-web-ui.adoc @@ -13,4 +13,4 @@ Republishing repository metadata will regenerate metadata for all repositories i . In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Content Views*. . Select a content view. . On the *Versions* tab, select a content view version. -. To republish metadata for the content view version, click *Republish repository metadata* from the vertical ellipsis icon. +. To republish metadata for the content view version, click *Republish repository metadata* from the options icon. diff --git a/guides/common/modules/proc_restoring-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc b/guides/common/modules/proc_restoring-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc new file mode 100644 index 00000000000..37e1eaf0aea --- /dev/null +++ b/guides/common/modules/proc_restoring-smartproxyserver-by-using-a-virtual-machine-snapshot.adoc @@ -0,0 +1,35 @@ +:_mod-docs-content-type: PROCEDURE + +[id="restoring-{smart-proxy-context}-server-by-using-a-virtual-machine-snapshot"] += Restoring {SmartProxyServer} by using a virtual machine snapshot + +[role="_abstract"] +You can use virtual machine snapshots to back up and restore your {SmartProxyServer} for quick recovery after server failure or configuration issues. +Configure or redeploy the host and complete installation. +ifdef::katello,orcharhino,satellite[] +Then synchronize content from {ProjectServer} to your {SmartProxyServer}. +endif::[] + +ifdef::katello,orcharhino,satellite[] +.Prerequisites +* Ensure that you either select the relevant organization and location context of your {SmartProxyServer} or choose *Any Organization* and *Any Location*. +endif::[] + +.Procedure +. If your {SmartProxyServer} is a virtual machine, include it in your backup strategy by using VM snapshots. +Creating weekly snapshots that you can restore from is recommended. +. After a failure, either restore your {SmartProxyServer} from a snapshot by using your hypervisor tools, or deploy a new {SmartProxyServer} and ensure that the host name is the same as before, and then install the {SmartProxy} certificates. +ifdef::katello,orcharhino,satellite[] +You may still have them on {ProjectServer}, the package name ends in -certs.tar, alternately create new ones. +endif::[] +ifndef::katello,orcharhino,satellite[] +You may still have them, alternately create new ones. +endif::[] +. Follow the procedures in {InstallingSmartProxyDocURL}[Installing {SmartProxyServer}] until you can confirm, in the {ProjectWebUI}, that {SmartProxyServer} is connected to {ProjectServer}. +ifdef::katello,orcharhino,satellite[] +. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*. +. Select your {SmartProxyServer}. +. On the *Overview* tab, click *Synchronize*. +* Select *Optimized Sync* to synchronize content from your {ProjectServer} to your {SmartProxyServer} that bypasses unnecessary steps to speed up performance. +* Select *Complete Sync* to perform a complete sync from your {ProjectServer} to your {SmartProxyServer} that synchronizes content even if the metadata has not changed. +endif::[] diff --git a/guides/common/modules/proc_synchronizing-content-from-project-server-to-smart-proxy-servers.adoc b/guides/common/modules/proc_synchronizing-content-from-project-server-to-smart-proxy-servers.adoc deleted file mode 100644 index f297fc8a852..00000000000 --- a/guides/common/modules/proc_synchronizing-content-from-project-server-to-smart-proxy-servers.adoc +++ /dev/null @@ -1,17 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="Synchronizing_Content_from_{project-context}_Server_to_{smart-proxy-context-titlecase}_Servers_{context}"] -= Synchronizing content from {ProjectServer} to {SmartProxyServers} - -[role="_abstract"] -Use this procedure to synchronize content from your {ProjectServer} to your {SmartProxyServer}. - -.Prerequisites -* Ensure that you either select the relevant organization and location context of your {SmartProxyServer} or choose *Any Organization* and *Any Location*. - -.Procedure -. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*. -. Select your {SmartProxyServer}. -. On the *Overview* tab, click *Synchronize*. -* Select *Optimized Sync* to synchronize content from your {ProjectServer} to your {SmartProxyServer} that bypasses unnecessary steps to speed up performance. -* Select *Complete Sync* to perform a complete sync from your {ProjectServer} to your {SmartProxyServer} that synchronizes content even if the metadata has not changed. diff --git a/guides/common/modules/proc_synchronizing-insights-recommendations-for-hosts.adoc b/guides/common/modules/proc_synchronizing-insights-recommendations-for-hosts.adoc index 55f451ebb90..60ca72f18ee 100644 --- a/guides/common/modules/proc_synchronizing-insights-recommendations-for-hosts.adoc +++ b/guides/common/modules/proc_synchronizing-insights-recommendations-for-hosts.adoc @@ -16,4 +16,4 @@ If you leave the setting disabled, you can synchronize the recommendations manua * To get the recommendations manually: + . In the {ProjectWebUI}, navigate to *{Insights}* > *Recommendations*. -. On the vertical ellipsis, click *Sync Recommendations*. +. From the options menu, select *Sync Recommendations*. diff --git a/guides/common/modules/proc_synchronizing-smart-proxy-directly-from-red-hat-cdn-by-using-web-ui.adoc b/guides/common/modules/proc_synchronizing-smart-proxy-directly-from-red-hat-cdn-by-using-web-ui.adoc index 5d0ca397035..844d8f68279 100644 --- a/guides/common/modules/proc_synchronizing-smart-proxy-directly-from-red-hat-cdn-by-using-web-ui.adoc +++ b/guides/common/modules/proc_synchronizing-smart-proxy-directly-from-red-hat-cdn-by-using-web-ui.adoc @@ -20,4 +20,4 @@ You can configure your {SmartProxyServers} to sync Red{nbsp}Hat content directly . If you require synchronizing content through the HTTP proxy of your {SmartProxies}, select *Use HTTP proxies*. . Select the Red{nbsp}Hat products that should be synced to the {SmartProxy} from Red{nbsp}Hat CDN. . Review details and click *Add*. -. Navigate to *Content* > *Alternate Content Sources*, click the vertical ellipsis next to the newly created alternate content source, and select *Refresh*. +. Navigate to *Content* > *Alternate Content Sources*, click the options icon next to the newly created alternate content source, and select *Refresh*. diff --git a/guides/common/modules/proc_updating-foreman-server.adoc b/guides/common/modules/proc_updating-foreman-server.adoc index 579faeba542..c7b62df1261 100644 --- a/guides/common/modules/proc_updating-foreman-server.adoc +++ b/guides/common/modules/proc_updating-foreman-server.adoc @@ -6,6 +6,10 @@ [role="_abstract"] You can update your {ProjectServer} to the latest packages published by {Team}. +ifdef::orcharhino[] +If you want to upgrade {Project} to the next version, see xref:sources/installation_and_maintenance/upgrading_orcharhino_server.adoc[Upgrading {ProjectServer}] or xref:sources/installation_and_maintenance/upgrading_orcharhino_proxy_server.adoc[Upgrading {SmartProxyServer}]. +endif::[] + .Procedure . On your {ProjectServer}, start {Project} maintenance mode: + diff --git a/guides/common/modules/proc_upgrading-a-package.adoc b/guides/common/modules/proc_upgrading-a-package.adoc index f8aaead3cf4..d73be9c53e1 100644 --- a/guides/common/modules/proc_upgrading-a-package.adoc +++ b/guides/common/modules/proc_upgrading-a-package.adoc @@ -10,8 +10,8 @@ You can upgrade an installed package on a host to a newer version from the {Proj . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts* and select the name of the host that contains the package you want to upgrade. . On the *Content* tab, select *Packages*. + -The *Status* column displays whether the package is upgradable or Up-to date. +The *Status* column displays whether the package is upgradeable or Up-to date. You cannot update an up-to-date package. -. From the list of packages, choose the package you want to upgrade and click the vertical ellipsis icon at the end of the line. +. From the list of packages, choose the package you want to upgrade and click the options icon at the end of the line. . Choose the *Apply via Remote Execution* to use Remote Execution, or *Apply via customized remote execution* if you want to customize the remote execution, for example, to set a time when it should be applied. . Click *Submit* to upgrade the package. diff --git a/guides/common/modules/con_aws-requirements.adoc b/guides/common/modules/ref_aws-requirements.adoc similarity index 98% rename from guides/common/modules/con_aws-requirements.adoc rename to guides/common/modules/ref_aws-requirements.adoc index eb7c0ba9128..c654eec2a55 100644 --- a/guides/common/modules/con_aws-requirements.adoc +++ b/guides/common/modules/ref_aws-requirements.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="aws-requirements"] = AWS Requirements diff --git a/guides/common/modules/con_building-cloud-images.adoc b/guides/common/modules/ref_building-cloud-images.adoc similarity index 97% rename from guides/common/modules/con_building-cloud-images.adoc rename to guides/common/modules/ref_building-cloud-images.adoc index 215974f4c11..7e0aa9af5b7 100644 --- a/guides/common/modules/con_building-cloud-images.adoc +++ b/guides/common/modules/ref_building-cloud-images.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="Building_Cloud_Images_{context}"] = Building cloud images for {ProjectName} diff --git a/guides/common/modules/ref_compute-profiles.adoc b/guides/common/modules/ref_compute-profiles.adoc new file mode 100644 index 00000000000..9305a603f32 --- /dev/null +++ b/guides/common/modules/ref_compute-profiles.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: REFERENCE + +[id="compute-profiles"] += Compute profiles + +[role="_abstract"] +You can predefine virtual machine hardware details such as CPUs, memory, and storage, by using compute profiles. + +A default installation of {ProjectName} contains three predefined profiles: + +* `1-Small` +* `2-Medium` +* `3-Large` + +You can apply compute profiles to all supported compute resources. +For supported compute resources, see the following information: + +* xref:supported-cloud-providers[] +* xref:supported-virtualization-infrastructures[] + +For information on creating a custom compute profile, see xref:creating-compute-profiles-by-using-web-ui[]. diff --git a/guides/common/modules/con_content-access-strategies.adoc b/guides/common/modules/ref_content-access-strategies.adoc similarity index 99% rename from guides/common/modules/con_content-access-strategies.adoc rename to guides/common/modules/ref_content-access-strategies.adoc index 80d49c552dd..20e9daa2bd7 100644 --- a/guides/common/modules/con_content-access-strategies.adoc +++ b/guides/common/modules/ref_content-access-strategies.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="content-access-strategies"] = Content access strategies diff --git a/guides/common/modules/ref_content-management-capabilities-in-project.adoc b/guides/common/modules/ref_content-management-capabilities-in-project.adoc new file mode 100644 index 00000000000..4b95145aaf6 --- /dev/null +++ b/guides/common/modules/ref_content-management-capabilities-in-project.adoc @@ -0,0 +1,33 @@ +:_mod-docs-content-type: REFERENCE + +[id="content-management-capabilities-in-{project-context}"] += Content management capabilities in {ProjectName} + +[role="_abstract"] +Understand how {ProjectName} groups subscription-related work and repository content so you can plan imports, lifecycle environments, and host access. + +{ProjectName} provides the following management capabilities: + +ifdef::satellite[] +Subscription management:: +This provides organizations with a method to manage their Red Hat subscription information. +endif::[] + +ifndef::satellite[] +Red Hat Subscription management:: +This provides organizations with a method to store Red Hat content and organize it in various ways. + +SUSE Subscription management:: +This provides organizations with a method to store SUSE content and organize it in various ways. +Note that this requires the SCC Manager plugin. +For more information, see xref:Managing_SUSE_Content_{context}[]. +endif::[] + +Content management:: +ifdef::satellite[] +This provides organizations with a method to store Red Hat content and organize it in various ways. +endif::[] +ifdef::foreman-el,katello,orcharhino[] +This provides organizations with a method to store Deb and Yum content and organize it in various ways. +endif::[] +In the context of {Project}, _content_ is defined as the software installed on hosts. diff --git a/guides/common/modules/con_guide-not-ready.adoc b/guides/common/modules/ref_guide-not-ready.adoc similarity index 92% rename from guides/common/modules/con_guide-not-ready.adoc rename to guides/common/modules/ref_guide-not-ready.adoc index 498842233ae..793687b0ab1 100644 --- a/guides/common/modules/con_guide-not-ready.adoc +++ b/guides/common/modules/ref_guide-not-ready.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="guide-not-ready-yet"] = Guide not ready yet diff --git a/guides/common/modules/con_hammer-configuration.adoc b/guides/common/modules/ref_hammer-configuration.adoc similarity index 88% rename from guides/common/modules/con_hammer-configuration.adoc rename to guides/common/modules/ref_hammer-configuration.adoc index 86580d36c92..d4c983903c2 100644 --- a/guides/common/modules/con_hammer-configuration.adoc +++ b/guides/common/modules/ref_hammer-configuration.adoc @@ -1,9 +1,11 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="hammer-configuration"] = Hammer configuration [role="_abstract"] +Hammer reads global configuration from `/etc/hammer/` and user-specific configuration from `~/.hammer/`. + The default location for global Hammer configuration is: * `/etc/hammer/cli_config.yml` for general Hammer settings @@ -36,6 +38,7 @@ These directives affect only the current user and are not applied globally. Similarly, you can configure user interface settings. For example, set the number of entries displayed per request in the Hammer output by changing the following line: +[options="nowrap", subs="verbatim,quotes,attributes"] ---- :per_page: 30 ---- diff --git a/guides/common/modules/ref_help-resources-for-example-playbooks-from-project-ansible-collection.adoc b/guides/common/modules/ref_help-resources-for-example-playbooks-from-project-ansible-collection.adoc new file mode 100644 index 00000000000..5600170af25 --- /dev/null +++ b/guides/common/modules/ref_help-resources-for-example-playbooks-from-project-ansible-collection.adoc @@ -0,0 +1,13 @@ +:_mod-docs-content-type: REFERENCE + +[id="help-resources-for-example-playbooks-from-{project-context}-ansible-collection"] += Help resources for example playbooks from {Project} Ansible Collection + +[role="_abstract"] +You can use the following resources when you create example playbooks based on {Project} Ansible Collection modules. + +* xref:creating-a-playbook-with-modules-from-{project-context}-ansible-collection[] +* Use the `ansible-doc --list {ansible-namespace}` command to display the {Project} Ansible modules installed on your system. +ifndef::orcharhino[] +* See {ansible-galaxy}[{ansible-galaxy-name}] for a complete list of {Project} Ansible modules and other related information. +endif::[] diff --git a/guides/common/modules/con_http-booting-in-project.adoc b/guides/common/modules/ref_http-booting-in-project.adoc similarity index 92% rename from guides/common/modules/con_http-booting-in-project.adoc rename to guides/common/modules/ref_http-booting-in-project.adoc index d82b6f9a8af..7b45f0dbe45 100644 --- a/guides/common/modules/con_http-booting-in-project.adoc +++ b/guides/common/modules/ref_http-booting-in-project.adoc @@ -1,10 +1,11 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="http-booting-in-{project-context}"] = HTTP booting in {Project} [role="_abstract"] -You can use HTTP booting to boot systems over a network using HTTP. +You can use HTTP booting to boot networked systems over HTTP. +Requirements differ depending on whether DHCP is managed or unmanaged. HTTP booting requirements with managed DHCP:: * Client requirements: @@ -44,7 +45,7 @@ In case DNS is not available, use IP address to configure clients. + [NOTE] ==== -Although TFTP protocol is not used for HTTP UEFI Booting, {Project} use TFTP {SmartProxy} API to deploy boot loader configuration. +Although TFTP protocol is not used for HTTP UEFI Booting, {Project} uses TFTP {SmartProxy} API to deploy boot loader configuration. ==== + ** Ensure that both {ProjectServer} and {SmartProxy} have DNS configured and are able to resolve provisioned host names. diff --git a/guides/common/modules/ref_iss-configuration-options-for-content-synchronization.adoc b/guides/common/modules/ref_iss-configuration-options-for-content-synchronization.adoc new file mode 100644 index 00000000000..2a1e8328c0f --- /dev/null +++ b/guides/common/modules/ref_iss-configuration-options-for-content-synchronization.adoc @@ -0,0 +1,31 @@ +:_mod-docs-content-type: REFERENCE + +[id="iss-configuration-options-for-content-synchronization"] += ISS configuration options for content synchronization + +[role="_abstract"] +{Project} offers network sync and export sync, depending on whether your upstream and downstream servers can exchange data over a network. + +There are two possible ISS configurations of {Project}, depending on how you deployed your infrastructure: + +ISS Network Sync:: +If your upstream server can communicate with the downstream server over a network, you can synchronize content over HTTPS. ++ +Configure your {Project} to synchronize content over a network. +ifndef::satellite[] +For more information, see xref:configuring-server-to-synchronize-content-over-a-network-by-using-web-ui[]. +endif::[] + +ISS Export Sync:: +If your upstream and downstream servers are air gapped, you can synchronize content by using export and import. ++ +Configure your {Project} to synchronize content by using export and import. +ifndef::satellite[] +For more information, see xref:configuring-projectserver-to-synchronize-content-through-exports-by-using-web-ui[]. +endif::[] + +.Additional resources +* {PlanningDocURL}iss-scenarios_planning[{ISS} scenarios in _{PlanningDocTitle}_] +ifdef::satellite[] +* https://access.redhat.com/solutions/7013903[Hammer content export fails with "Path '/the/path' is not an allowed export path" in the _Red{nbsp}Hat Knowledgebase_] +endif::[] diff --git a/guides/common/modules/ref_more-information-about-amazon-web-services.adoc b/guides/common/modules/ref_more-information-about-amazon-web-services.adoc new file mode 100644 index 00000000000..30426c98d4f --- /dev/null +++ b/guides/common/modules/ref_more-information-about-amazon-web-services.adoc @@ -0,0 +1,13 @@ +:_mod-docs-content-type: REFERENCE + +[id="more-information-about-amazon-web-services-and-{project-context}"] += More information about Amazon Web Services and {Project} + +[role="_abstract"] +You can use the following external documentation to work with Amazon Web Services together with {Project}. + +ifndef::orcharhino[] +* https://access.redhat.com/articles/2962171[How to Locate Red{nbsp}Hat Cloud Access Gold Images on AWS EC2] +endif::[] +* https://docs.aws.amazon.com/cli/latest/userguide/awscli-install-linux.html[Install the AWS Command Line Interface on Linux] in the Amazon Web Services documentation +* https://aws.amazon.com/ec2/vm-import/[VM Import/Export] in the Amazon Web Services documentation diff --git a/guides/common/modules/con_postgresql-as-an-external-database-considerations.adoc b/guides/common/modules/ref_postgresql-as-an-external-database-considerations.adoc similarity index 98% rename from guides/common/modules/con_postgresql-as-an-external-database-considerations.adoc rename to guides/common/modules/ref_postgresql-as-an-external-database-considerations.adoc index 034318418c0..c10145dff34 100644 --- a/guides/common/modules/con_postgresql-as-an-external-database-considerations.adoc +++ b/guides/common/modules/ref_postgresql-as-an-external-database-considerations.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="postgresql-as-an-external-database-considerations_{context}"] = PostgreSQL as an external database considerations diff --git a/guides/common/modules/con_prerequisites-for-applying-errata.adoc b/guides/common/modules/ref_prerequisites-for-applying-errata.adoc similarity index 87% rename from guides/common/modules/con_prerequisites-for-applying-errata.adoc rename to guides/common/modules/ref_prerequisites-for-applying-errata.adoc index b0283270476..3da91f66187 100644 --- a/guides/common/modules/con_prerequisites-for-applying-errata.adoc +++ b/guides/common/modules/ref_prerequisites-for-applying-errata.adoc @@ -1,10 +1,10 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="prerequisites-for-applying-errata"] = Prerequisites for applying errata [role="_abstract"] -To apply errata to hosts, you must meet the following prerequisites. +Before you apply errata to hosts, ensure the following prerequisites are met. ifdef::satellite[] * Synchronize {ProjectName} repositories with the latest errata available from Red{nbsp}Hat. diff --git a/guides/common/modules/ref_prerequisites-for-configuring-project-with-keycloak-wildfly-authentication.adoc b/guides/common/modules/ref_prerequisites-for-configuring-project-with-keycloak-wildfly-authentication.adoc index a4367d501f3..3c2f8694725 100644 --- a/guides/common/modules/ref_prerequisites-for-configuring-project-with-keycloak-wildfly-authentication.adoc +++ b/guides/common/modules/ref_prerequisites-for-configuring-project-with-keycloak-wildfly-authentication.adoc @@ -6,6 +6,28 @@ [role="_abstract"] Your {ProjectServer} and {keycloak} server must meet the following requirements before you configure {keycloak-wildfly} authentication. +ifndef::satellite[] +[NOTE] +==== +The default {keycloak} distribution is now based on Quarkus. + +{keycloak-quarkus} replaces {keycloak-wildfly} in {Project} deployments. +For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[]. + +For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://www.keycloak.org/migration/migrating-to-quarkus[Migrating to Quarkus distribution]. +==== +endif::[] +ifdef::satellite[] +[NOTE] +==== +The {keycloak-wildfly}{nbsp}7 product family has reached End of Full Support. +Use {keycloak-quarkus} instead in your {Project} deployments. +For information about configuring {keycloak-quarkus} authentication, see xref:configuring-sso-and-2fa-with-keycloak-in-project_keycloak-quarkus[]. + +For information about migrating from {keycloak-wildfly} to {keycloak-quarkus}, see link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0[documentation for {keycloak-quarkus}]. +==== +endif::[] + On your {ProjectServer}: * Install the packages required for registering a {keycloak} client: diff --git a/guides/common/modules/ref_prerequisites-for-google-compute-engine-provisioning.adoc b/guides/common/modules/ref_prerequisites-for-google-compute-engine-provisioning.adoc new file mode 100644 index 00000000000..da24dc561cf --- /dev/null +++ b/guides/common/modules/ref_prerequisites-for-google-compute-engine-provisioning.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: REFERENCE + +[id="prerequisites-for-google-compute-engine-provisioning"] += Prerequisites for Google Compute Engine provisioning + +[role="_abstract"] +Before you can provision cloud instances on Google Compute Engine (GCE), ensure that your environment meets the following requirements. + +include::snip_prerequisite-networking-for-provisioning.adoc[] ++ +include::snip_prerequisites-common-compute-resource.adoc[] +* In your GCE project, configure a service account with the necessary IAM Compute role. +For more information, see https://cloud.google.com/compute/docs/access/iam[Compute Engine IAM roles] in the GCE documentation. +* In your GCE project-wise metadata, set the `enable-oslogin` to `FALSE`. +For more information, see https://cloud.google.com/compute/docs/instances/managing-instance-access#enable_oslogin[Enabling or disabling OS Login] in the GCE documentation. +* Optional: If you want to use Puppet with GCE hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. +* Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. +For more information, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates] in _{ProvisioningDocTitle}_. diff --git a/guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc b/guides/common/modules/ref_prerequisites-for-image-based-provisioning.adoc similarity index 76% rename from guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc rename to guides/common/modules/ref_prerequisites-for-image-based-provisioning.adoc index f012f638f8b..195e33365d1 100644 --- a/guides/common/modules/con_prerequisites-for-image-based-provisioning.adoc +++ b/guides/common/modules/ref_prerequisites-for-image-based-provisioning.adoc @@ -1,12 +1,11 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE -[id="Prerequisites_for_Image_Based_Provisioning_{context}"] +[id="prerequisites-for-image-based-provisioning_{context}"] = Prerequisites for image-based provisioning [role="_abstract"] -Before you can deploy pre-built cloud instances or virtual machines, ensure that DNS and TFTP options are correctly configured so that hosts across multiple subnets or domains can successfully locate and retrieve the image installation content. - -The requirements differ depending on the boot configuration method: +Before you deploy pre-built cloud instances or virtual machines, DNS and TFTP must be configured so that hosts across multiple subnets or domains can locate and retrieve image installation content. +The requirements depend on the boot configuration method. Post-boot configuration method:: + @@ -17,7 +16,7 @@ The host must be created with a subnet associated with a DHCP {SmartProxy}, and It is possible to use an external DHCP service, but IP addresses must be entered manually. The SSH credentials corresponding to the configuration in the image must be configured in {Project} to enable the post-boot configuration to be made. -Check the following items when troubleshooting a virtual machine booted from an image that depends on post-configuration scripts: +When you troubleshoot a virtual machine booted from an image that depends on post-configuration scripts, verify the following: * The host has a subnet assigned in {ProjectServer}. * The subnet has a DHCP {SmartProxy} assigned in {ProjectServer}. @@ -36,7 +35,7 @@ Images that use the `cloud-init` scripts require a DHCP server to avoid having t A managed DHCP {SmartProxy} is preferred. The image must have the `cloud-init` service configured to start when the system boots and fetch a script or configuration data to use in completing the configuration. -Check the following items when troubleshooting a virtual machine booted from an image that depends on initialization scripts included in the image: +When you troubleshoot a virtual machine booted from an image that depends on initialization scripts included in the image, verify the following: * There is a DHCP server on the subnet. * The virtual machine has the `cloud-init` service installed and enabled. diff --git a/guides/common/modules/ref_prerequisites-for-microsoft-azure-provisioning.adoc b/guides/common/modules/ref_prerequisites-for-microsoft-azure-provisioning.adoc new file mode 100644 index 00000000000..194138dc0c3 --- /dev/null +++ b/guides/common/modules/ref_prerequisites-for-microsoft-azure-provisioning.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: REFERENCE + +[id="prerequisites-for-microsoft-azure-provisioning"] += Prerequisites for Microsoft Azure provisioning + +[role="_abstract"] +Before you can provision cloud instances on Microsoft Azure, ensure that your environment meets the following requirements. + +include::snip_prerequisites-common-compute-resource.adoc[] +* Ensure that you have the correct permissions to create an Azure Active Directory application. +For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal#required-permissions[Check Azure AD permissions] in the _Microsoft identity platform (Azure Active Directory for developers)_ documentation. +* You must create and configure an Azure Active Directory application and service principle to obtain Application or _client_ ID, Directory or _tenant_ ID, and Client Secret. +For more information, see https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal[Use the portal to create an Azure AD application and service principal that can access resources] in the _Microsoft identity platform (Azure Active Directory for developers)_ documentation. +* Optional: If you want to use Puppet with Azure hosts, navigate to *Administer* > *Settings* > *Puppet* and enable the `Use UUID for certificates` setting to configure Puppet to use consistent Puppet certificate IDs. +* Based on your needs, associate a `finish` or `user_data` provisioning template with the operating system you want to use. +For more information about provisioning templates, see {ProvisioningDocURL}provisioning-templates[Provisioning Templates]. +* Optional: If you want the virtual machine to use a static private IP address, create a subnet in {Project} with the *Network Address* field matching the Azure subnet address. +* Before creating {RHEL} BYOS images, you must accept the image terms either in the Azure CLI or Portal so that the image can be used to create and manage virtual machines for your subscription. + +.Additional resources +* https://docs.microsoft.com/en-us/azure/azure-resource-manager/[Azure Resource Manager documentation] diff --git a/guides/common/modules/ref_prerequisites-for-openstack-provisioning.adoc b/guides/common/modules/ref_prerequisites-for-openstack-provisioning.adoc new file mode 100644 index 00000000000..b8641398eed --- /dev/null +++ b/guides/common/modules/ref_prerequisites-for-openstack-provisioning.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: REFERENCE + +[id="prerequisites-for-openstack-provisioning"] += Prerequisites for {OpenStack} provisioning + +[role="_abstract"] +Before you can provision cloud instances on {OpenStack}, ensure that your environment meets the following requirements. + +include::snip_prerequisites-common-compute-resource.adoc[] +* A {SmartProxyServer} managing a network in your {OpenStack} environment. +For more information, see {ProvisioningDocURL}preparing-networking[Preparing networking] in _{ProvisioningDocTitle}_. +* An image added to {OpenStack} Image Storage (glance) service for image-based provisioning. +ifndef::orcharhino[] +For more information, see the {RHDocsBaseURL}red_hat_openstack_platform/16.0/html/instances_and_images_guide/index[{OpenStack} _Instances and Images Guide_]. +endif::[] + +include::snip_warning-destroy-vm-on-host-delete.adoc[] diff --git a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc b/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc similarity index 91% rename from guides/common/modules/con_prerequisites-for-using-ipxe.adoc rename to guides/common/modules/ref_prerequisites-for-using-ipxe.adoc index 20a4e57a195..d71ebac0e98 100644 --- a/guides/common/modules/con_prerequisites-for-using-ipxe.adoc +++ b/guides/common/modules/ref_prerequisites-for-using-ipxe.adoc @@ -1,10 +1,10 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="prerequisites-for-using-ipxe_{context}"] = Prerequisites for using iPXE [role="_abstract"] -To use iPXE for booting virtual machines, ensure that your environment meets the following requirements. +Before you use iPXE to boot virtual machines, verify that your environment meets the following requirements. You can use iPXE to boot virtual machines in the following cases: diff --git a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc b/guides/common/modules/ref_prerequisites-for-vmware-provisioning.adoc similarity index 87% rename from guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc rename to guides/common/modules/ref_prerequisites-for-vmware-provisioning.adoc index dbc519b3d98..7691be8a05a 100644 --- a/guides/common/modules/con_prerequisites-for-vmware-provisioning.adoc +++ b/guides/common/modules/ref_prerequisites-for-vmware-provisioning.adoc @@ -1,9 +1,9 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE -[id="Prerequisites_for_VMware_Provisioning_{context}"] +[id="prerequisites-for-vmware-provisioning"] = Prerequisites for VMware provisioning -[role="_abstract"] +[role="_abstract"] Before you can deploy virtual machines to VMware vSphere, ensure that your environment meets the following requirements. The requirements for VMware vSphere provisioning include: diff --git a/guides/common/modules/con_supported-usage-of-project-components.adoc b/guides/common/modules/ref_supported-usage-of-project-components.adoc similarity index 98% rename from guides/common/modules/con_supported-usage-of-project-components.adoc rename to guides/common/modules/ref_supported-usage-of-project-components.adoc index b517bd138ed..c0e16d7a5b6 100644 --- a/guides/common/modules/con_supported-usage-of-project-components.adoc +++ b/guides/common/modules/ref_supported-usage-of-project-components.adoc @@ -1,4 +1,4 @@ -:_mod-docs-content-type: CONCEPT +:_mod-docs-content-type: REFERENCE [id="supported-usage-of-project-components_{context}"] = Supported usage of {Project} components diff --git a/guides/common/modules/ref_template-rendering-and-erb-context.adoc b/guides/common/modules/ref_template-rendering-and-erb-context.adoc new file mode 100644 index 00000000000..4ed7066b387 --- /dev/null +++ b/guides/common/modules/ref_template-rendering-and-erb-context.adoc @@ -0,0 +1,30 @@ +:_mod-docs-content-type: REFERENCE + +[id="template-rendering-and-erb-context"] += Template rendering and ERB context + +[role="_abstract"] +You can review how {ProjectName} renders ERB templates during provisioning and remote jobs, why safemode is enabled by default, and which features use ERB syntax. + +When you provision a host or run a remote job, the code in the ERB runs and variables are replaced with host-specific values. +This process is called *rendering*. +{ProjectServer} enables the safemode rendering option by default so harmful template code cannot execute. + +Note that the default templates provided by {ProjectName} (*Hosts* > *Templates* > *Provisioning Templates*, *Hosts* > *Templates* > *Job templates*, *Monitor* > *Reports* > *Report Templates* ) also provide a good source of ERB syntax examples. + +{ProjectName} uses ERB syntax in the following cases: + +Provisioning templates:: +For more information, see {ProvisioningDocURL}creating-provisioning-templates-by-using-web-ui[Creating provisioning templates in {ProjectWebUI}] in _{ProvisioningDocTitle}_. + +Remote execution job templates:: +For more information, see xref:configuring-and-setting-up-remote-jobs[]. + +Report templates:: +For more information, see xref:Using_Report_Templates_to_Monitor_Hosts_{context}[]. + +Templates for partition tables:: +For more information, see {ProvisioningDocURL}creating-partition-tables-by-using-web-ui[Creating partition tables by using {ProjectWebUI}] in _{ProvisioningDocTitle}_. + +Smart Class Parameters:: +For more information, see {ManagingConfigurationsPuppetDocURL}Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet[Configuring Puppet smart class parameters] in _{ManagingConfigurationsPuppetDocTitle}_. diff --git a/guides/common/modules/ref_workflow-for-creating-content-views.adoc b/guides/common/modules/ref_workflow-for-creating-content-views.adoc new file mode 100644 index 00000000000..30e04ff86fc --- /dev/null +++ b/guides/common/modules/ref_workflow-for-creating-content-views.adoc @@ -0,0 +1,31 @@ +:_mod-docs-content-type: REFERENCE + +[id="workflows-for-creating-content-views"] += Workflow for creating content views + +[role="_abstract"] +Follow this sequence to add repositories, optionally refine content with filters and dependency resolution, publish and promote the content view, and attach hosts. + +The general workflow for creating content views for filtering and creating snapshots is as follows: + +. Create a content view. +. Add one or more repositories that you want to the content view. +. Optional: Create one or more filters to refine the content of the content view. +For more information, see xref:Content_Filter_Examples_{context}[]. +. Optional: Resolve any package dependencies for a content view. +For more information, see xref:Resolving_Package_Dependencies_{context}[]. +. Publish the content view. +. Optional: Promote the content view to another environment. +For more information, see xref:promoting-a-content-view-by-using-web-ui[]. +. Attach the host to the content view. + +ifdef::client-content-dnf[] +If a repository is not associated with the content view, the file `/etc/yum.repos.d/redhat.repo` remains empty and systems registered to it cannot receive updates. +endif::[] +ifdef::client-content-apt[] +If a repository is not associated with the content view, the file `/etc/apt/sources.list.d/rhsm.sources` remains empty and systems registered to it cannot receive updates. +endif::[] + +Hosts can only be associated with a single content view. +To associate a host with multiple content views, create a composite content view. +For more information, see xref:creating-a-composite-content-view-by-using-web-ui[]. diff --git a/guides/doc-Hammer_CLI/master.adoc b/guides/doc-Hammer_CLI/master.adoc index 7f21b403c05..3d6345cd9ba 100644 --- a/guides/doc-Hammer_CLI/master.adoc +++ b/guides/doc-Hammer_CLI/master.adoc @@ -27,7 +27,7 @@ include::common/modules/proc_authenticating-hammer-using-cli-options.adoc[levelo include::common/modules/proc_authenticating-hammer-using-sessions.adoc[leveloffset=+2] -include::common/modules/con_hammer-configuration.adoc[leveloffset=+1] +include::common/modules/ref_hammer-configuration.adoc[leveloffset=+1] include::common/modules/proc_setting-a-default-organization-and-location-context.adoc[leveloffset=+2] diff --git a/guides/doc-Installing_Proxy/master.adoc b/guides/doc-Installing_Proxy/master.adoc index 726fa11367d..357ce68d081 100644 --- a/guides/doc-Installing_Proxy/master.adoc +++ b/guides/doc-Installing_Proxy/master.adoc @@ -10,7 +10,7 @@ include::common/header.adoc[] // This guide is not ready for stable releases and on Debian // Though it also contains many errors on EL ifdef::HideDocumentOnStable,foreman-deb[] -include::common/modules/con_guide-not-ready.adoc[leveloffset=+1] +include::common/modules/ref_guide-not-ready.adoc[leveloffset=+1] endif::[] ifndef::HideDocumentOnStable,foreman-deb[] @@ -18,10 +18,6 @@ ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] endif::[] -ifdef::satellite[] -include::common/modules/con_projectname-installation-helper-app.adoc[leveloffset=+1] -endif::[] - // Preparing your Environment for Installation include::common/assembly_preparing-environment-for-capsule-installation.adoc[leveloffset=+1] diff --git a/guides/doc-Installing_Server/master.adoc b/guides/doc-Installing_Server/master.adoc index 568de305850..60c320cfa73 100644 --- a/guides/doc-Installing_Server/master.adoc +++ b/guides/doc-Installing_Server/master.adoc @@ -16,7 +16,7 @@ endif::[] // This guide is not ready for stable releases ifdef::HideDocumentOnStable[] -include::common/modules/con_guide-not-ready.adoc[leveloffset=+1] +include::common/modules/ref_guide-not-ready.adoc[leveloffset=+1] endif::[] ifndef::HideDocumentOnStable[] @@ -24,12 +24,6 @@ ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] endif::[] -ifndef::foremanctl[] -ifdef::satellite[] -include::common/modules/con_projectname-installation-helper-app.adoc[leveloffset=+1] -endif::[] -endif::[] - include::common/assembly_planning-project-server-installation.adoc[leveloffset=+1] include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1] diff --git a/guides/doc-Installing_Server_Disconnected/master.adoc b/guides/doc-Installing_Server_Disconnected/master.adoc index 100b9167322..5167573161e 100644 --- a/guides/doc-Installing_Server_Disconnected/master.adoc +++ b/guides/doc-Installing_Server_Disconnected/master.adoc @@ -25,8 +25,6 @@ endif::[] ifdef::satellite[] include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] -include::common/modules/con_projectname-installation-helper-app.adoc[leveloffset=+1] - include::common/assembly_planning-project-server-installation.adoc[leveloffset=+1] include::common/assembly_preparing-environment-for-project-server-installation.adoc[leveloffset=+1] diff --git a/guides/doc-Upgrading_Project/master.adoc b/guides/doc-Upgrading_Project/master.adoc index 0efeed75acf..63a8b2295d2 100644 --- a/guides/doc-Upgrading_Project/master.adoc +++ b/guides/doc-Upgrading_Project/master.adoc @@ -25,10 +25,6 @@ If you have installed the Katello plugin, you must use {BaseURL}Upgrading_Projec ==== endif::[] -ifdef::satellite[] -include::common/modules/con_projectname-upgrade-helper-app.adoc[leveloffset=+1] -endif::[] - include::common/assembly_preparing-for-project-upgrade.adoc[leveloffset=+1] include::common/modules/con_upgrading-project.adoc[leveloffset=+1] diff --git a/guides/doc-Upgrading_Project_Disconnected/master.adoc b/guides/doc-Upgrading_Project_Disconnected/master.adoc index 0a5d0437126..1ff5b4e8f16 100644 --- a/guides/doc-Upgrading_Project_Disconnected/master.adoc +++ b/guides/doc-Upgrading_Project_Disconnected/master.adoc @@ -19,8 +19,6 @@ include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[le include::common/modules/con_red-hat-offline-knowledge-portal.adoc[leveloffset=+1] -include::common/modules/con_projectname-upgrade-helper-app.adoc[leveloffset=+1] - include::common/assembly_preparing-for-project-upgrade.adoc[leveloffset=+1] include::common/modules/con_upgrading-project.adoc[leveloffset=+1]