diff --git a/guides/common/assembly_configuring-capsule-custom-server-certificate.adoc b/guides/common/assembly_configuring-capsule-custom-server-certificate.adoc index 17c1405c31..65be19aa02 100644 --- a/guides/common/assembly_configuring-capsule-custom-server-certificate.adoc +++ b/guides/common/assembly_configuring-capsule-custom-server-certificate.adoc @@ -3,20 +3,20 @@ ifdef::context[:parent-context: {context}] [id="configuring-capsule-custom-server-certificate_{context}"] -= Configuring Capsule Server with a Custom SSL Certificate += Configuring {SmartProxyServer} with a Custom SSL Certificate -If you configure Satellite Server to use a custom SSL certificate, you must also configure each of your external Capsule Servers with a distinct custom SSL certificate. +If you configure {ProjectServer} to use a custom SSL certificate, you must also configure each of your external {SmartProxyServer}s with a distinct custom SSL certificate. -To configure your Capsule Server with a custom certificate, complete the following procedures on each Capsule{nbsp}Server: +To configure your {SmartProxyServer} with a custom certificate, complete the following procedures on each {SmartProxyServer}: . xref:creating-a-custom-certificate_capsule[] . xref:deploying-a-custom-ssl-certificate-to-capsule-server_capsule[] . xref:deploying-a-custom-ssl-certificate-to-hosts_capsule[] -//Creating a Custom SSL Certificate for Capsule Server +//Creating a Custom SSL Certificate for {SmartProxyServer} include::modules/proc_creating-a-custom-certificate.adoc[leveloffset=+1] -//Deploying a Custom SSL Certificate to Capsule Server +//Deploying a Custom SSL Certificate to {SmartProxyServer} include::modules/proc_deploying-a-custom-ssl-certificate-to-capsule-server.adoc[leveloffset=+1] //Deploying a Custom SSL Certificate to Hosts diff --git a/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc b/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc index 16de8f100d..c863d2406f 100644 --- a/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc +++ b/guides/common/assembly_configuring-satellite-custom-server-certificate.adoc @@ -3,21 +3,21 @@ ifdef::context[:parent-context: {context}] [id="configuring-satellite-custom-server-certificate_{context}"] -= Configuring Satellite Server with a Custom SSL Certificate += Configuring {ProjectServer} with a Custom SSL Certificate -By default, Red{nbsp}Hat Satellite{nbsp}6 uses a self-signed SSL certificate to enable encrypted communications between Satellite{nbsp}Server, external Capsule{nbsp}Servers, and all hosts. If you cannot use a Satellite self-signed certificate, you can configure Satellite Server to use an SSL certificate signed by an external Certificate Authority. +By default, {ProjectNameX} uses a self-signed SSL certificate to enable encrypted communications between {ProjectServer}, external {SmartProxyServer}s, and all hosts. If you cannot use a {Project} self-signed certificate, you can configure {ProjectServer} to use an SSL certificate signed by an external Certificate Authority. -To configure your Satellite{nbsp}Server with a custom certificate, complete the following procedures: +To configure your {ProjectServer} with a custom certificate, complete the following procedures: . xref:creating-a-custom-certificate_satellite[] . xref:deploying-a-custom-ssl-certificate-to-satellite-server_satellite[] . xref:deploying-a-custom-ssl-certificate-to-hosts_satellite[] -. If you have external Capsule{nbsp}Servers registered to Satellite Server, you must configure them with custom SSL certificates. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/installing-capsule-server#configuring-capsule-custom-server-certificate_capsule[Configuring Capsule Server with a Custom SSL Certificate] in _Installing Capsule Server_. +. If you have external {SmartProxyServer}s registered to {ProjectServer}, you must configure them with custom SSL certificates. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/installing-capsule-server#configuring-capsule-custom-server-certificate_capsule[Configuring {SmartProxyServer} with a Custom SSL Certificate] in _Installing {SmartProxyServer}_. -//Creating a Custom SSL Certificate for Satellite Server +//Creating a Custom SSL Certificate for {ProjectServer} include::modules/proc_creating-a-custom-certificate.adoc[leveloffset=+1] -//Deploying a Custom SSL Certificate to Satellite Server +//Deploying a Custom SSL Certificate to {ProjectServer} include::modules/proc_deploying-a-custom-ssl-certificate-to-satellite-server.adoc[leveloffset=+1] //Deploying a Custom SSL Certificate to Hosts diff --git a/guides/common/assembly_installing-capsule-server.adoc b/guides/common/assembly_installing-capsule-server.adoc index 83b96101eb..1c14f71743 100644 --- a/guides/common/assembly_installing-capsule-server.adoc +++ b/guides/common/assembly_installing-capsule-server.adoc @@ -1,14 +1,14 @@ [id="installing-capsule-server"] -= Installing Capsule Server += Installing {SmartProxyServer} -Before you install Capsule Server, you must ensure that your environment meets the requirements for installation. +Before you install {SmartProxyServer}, you must ensure that your environment meets the requirements for installation. For more information, see xref:system-requirements_capsule[]. -// Registering Capsule Server to Satellite Server +// Registering {SmartProxyServer} to {ProjectServer} include::modules/proc_registering-to-satellite-server.adoc[leveloffset=+1] -// Attaching the Satellite Infrastructure Subscription +// Attaching the {Project} Infrastructure Subscription include::modules/proc_attaching-satellite-infrastructure-subscription.adoc[leveloffset=+1] // Configuring Repositories @@ -17,22 +17,22 @@ include::modules/proc_configuring-repositories.adoc[leveloffset=+1] // Synchronizing the System Clock With chronyd include::modules/proc_synchronizing-the-system-clock-with-chronyd.adoc[leveloffset=+1] -// Installing Capsule Server Packages +// Installing {SmartProxyServer} Packages include::modules/proc_installing-capsule-server-packages.adoc[leveloffset=+1] [id="configuring-capsule-server-with-ssl-certificates"] -== Configuring Capsule Server with SSL Certificates +== Configuring {SmartProxyServer} with SSL Certificates -Red Hat Satellite uses SSL certificates to enable encrypted communications between Satellite Server, external Capsule Servers, and all hosts. Depending on the requirements of your organization, you must configure your Capsule Server with a default or custom certificate. +{ProjectName} uses SSL certificates to enable encrypted communications between {ProjectServer}, external {SmartProxyServer}s, 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 external Capsule Server with a distinct default SSL certificate. For more information, see xref:configuring-capsule-default-certificate_capsule[]. -* If you use a custom SSL certificate, you must also configure each external Capsule Server with a distinct custom SSL certificate. For more information, see xref:configuring-capsule-custom-server-certificate_capsule[]. +* If you use a default SSL certificate, you must also configure each external {SmartProxyServer} with a distinct default SSL certificate. For more information, see xref:configuring-capsule-default-certificate_capsule[]. +* If you use a custom SSL certificate, you must also configure each external {SmartProxyServer} with a distinct custom SSL certificate. For more information, see xref:configuring-capsule-custom-server-certificate_capsule[]. -// Configuring Capsule Server Using the Default Certificate +// Configuring {SmartProxyServer} Using the Default Certificate include::modules/proc_configuring-capsule-default-certificate.adoc[leveloffset=+2] -// Configuring Capsule Server with a Custom Server Certificate +// Configuring {SmartProxyServer} with a Custom Server Certificate include::assembly_configuring-capsule-custom-server-certificate.adoc[leveloffset=+2] diff --git a/guides/common/assembly_performing-additional-configuration-on-capsule-server.adoc b/guides/common/assembly_performing-additional-configuration-on-capsule-server.adoc index 8523d641cf..5fc664d4a5 100644 --- a/guides/common/assembly_performing-additional-configuration-on-capsule-server.adoc +++ b/guides/common/assembly_performing-additional-configuration-on-capsule-server.adoc @@ -1,8 +1,8 @@ [id="performing-additional-configuration-on-capsule-server"] -= Performing Additional Configuration on Capsule Server += Performing Additional Configuration on {SmartProxyServer} -Use this chapter to configure additional settings on your Capsule Server. +Use this chapter to configure additional settings on your {SmartProxyServer}. // Installing the Katello Agent include::modules/proc_installing-the-katello-agent.adoc[leveloffset=+1] @@ -13,13 +13,13 @@ include::modules/proc_enabling-remote-execution.adoc[leveloffset=+1] // Enabling OpenSCAP include::modules/proc_enabling-openscap.adoc[leveloffset=+1] -// Adding Life Cycle Environments to Capsule Servers +// Adding Life Cycle Environments to {SmartProxyServer}s include::modules/proc_adding-life-cycle-environments.adoc[leveloffset=+1] // Enabling Power Management on Managed Hosts include::modules/proc_enabling-power-management-on-managed-hosts.adoc[leveloffset=+1] -// Configuring DNS, DHCP, and TFTP on Capsule Server +// Configuring DNS, DHCP, and TFTP on {SmartProxyServer} include::modules/proc_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+1] // Restricting Access to mongod diff --git a/guides/common/assembly_preparing-environment-for-capsule-installation.adoc b/guides/common/assembly_preparing-environment-for-capsule-installation.adoc index b5c614d0d0..04139926ac 100644 --- a/guides/common/assembly_preparing-environment-for-capsule-installation.adoc +++ b/guides/common/assembly_preparing-environment-for-capsule-installation.adoc @@ -17,10 +17,10 @@ include::modules/ref_supported-operating-systems.adoc[leveloffset=+1] include::modules/con_ports-and-firewalls-requirements.adoc[leveloffset=+1] include::modules/ref_capsule-ports-and-firewalls-requirements.adoc[leveloffset=+1] -// Enabling Connections from Capsule Server to Satellite Server +// Enabling Connections from {SmartProxyServer} to {ProjectServer} include::modules/proc_enabling-connections-from-capsule-to-satellite.adoc[leveloffset=+1] -// Enabling Connections from Satellite Server and Clients to a Capsule Server +// Enabling Connections from {ProjectServer} and Clients to a {SmartProxyServer} include::modules/proc_enabling-connections-to-capsule.adoc[leveloffset=+1] // Verifying Firewall Settings diff --git a/guides/common/attributes.adoc b/guides/common/attributes.adoc index 0e7f75e20f..57d7e0656d 100644 --- a/guides/common/attributes.adoc +++ b/guides/common/attributes.adoc @@ -20,6 +20,7 @@ ifeval::["{build}" == "foreman"] :foreman-installer: foreman-installer +:foreman-maintain: foreman-maintain :foreman-example-com: foreman.example.com :OVirt: oVirt :OVirtShort: oVirt @@ -49,6 +50,7 @@ endif::[] ifeval::["{build}" == "satellite"] :foreman-installer: satellite-installer +:foreman-maintain: satellite-maintain :foreman-example-com: satellite.example.com :OVirt: Red{nbsp}Hat{nbsp}Virtualization :OVirtShort: RHV diff --git a/guides/common/modules/AWS_Deployment_Scenarios.adoc b/guides/common/modules/AWS_Deployment_Scenarios.adoc index ae13e4f08a..e5f12f1078 100644 --- a/guides/common/modules/AWS_Deployment_Scenarios.adoc +++ b/guides/common/modules/AWS_Deployment_Scenarios.adoc @@ -3,7 +3,7 @@ == Deployment Scenarios -There are three deployment scenarios for Red Hat Satellite in Amazon Web Services: +There are three deployment scenarios for {ProjectName} in Amazon Web Services: . One region setup . Connecting on-premise and AWS region @@ -13,15 +13,15 @@ There are three deployment scenarios for Red Hat Satellite in Amazon Web Service image:aws_image1.png[] -The least complex configuration of Satellite Server in Amazon Web Services consists of both the Satellite Server and the content hosts residing within the same region and within the Virtual Private Cloud (VPC). +The least complex configuration of {ProjectServer} in Amazon Web Services consists of both the {ProjectServer} and the content hosts residing within the same region and within the Virtual Private Cloud (VPC). You can also use a different availability zone. .Scenario 2: Connecting on-premise and AWS region -Create a VPN connection between the on-premise location and the AWS region where the Capsule resides. +Create a VPN connection between the on-premise location and the AWS region where the {SmartProxy} resides. -It is also possible to use the external host name of Satellite Server when you register the instance which runs Capsule Server. +It is also possible to use the external host name of {ProjectServer} when you register the instance which runs {SmartProxyServer}. *Option 1: Site-to-Site VPN connection between the AWS region and the On-Premise Datacenter* @@ -33,9 +33,9 @@ image:aws_image3.png[] .Scenario 3: Connecting different regions -Create a site-to-site VPN connection between the different regions so that you can use the Internal DNS host name when you register the instance that runs Capsule Server to the Satellite Server. +Create a site-to-site VPN connection between the different regions so that you can use the Internal DNS host name when you register the instance that runs {SmartProxyServer} to the {ProjectServer}. -If you do not establish a site-to-site VPN connection, use the external DNS host name when you register the instance that runs Capsule Server to the Satellite Server. +If you do not establish a site-to-site VPN connection, use the external DNS host name when you register the instance that runs {SmartProxyServer} to the {ProjectServer}. [NOTE] Most Public Cloud Providers do not charge for data being transferred into a region, or between availability zones within a single region; however, they do charge for data leaving the region to the Internet. diff --git a/guides/common/modules/AWS_Installing_Capsule_on_AWS.adoc b/guides/common/modules/AWS_Installing_Capsule_on_AWS.adoc index 6805f97514..955fcddcc3 100644 --- a/guides/common/modules/AWS_Installing_Capsule_on_AWS.adoc +++ b/guides/common/modules/AWS_Installing_Capsule_on_AWS.adoc @@ -1,14 +1,14 @@ -== Installing Capsule on AWS +== Installing {SmartProxy} on AWS On your AWS environment, complete the following steps: . Connect to the new instance. -. Install Capsule Server. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/index.html[Installing Capsule Server]. +. Install {SmartProxyServer}. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/index.html[Installing {SmartProxyServer}]. -== Registering Hosts to Satellite Using The Bootstrap Script +== Registering Hosts to {Project} Using The Bootstrap Script -When you install Satellite Server and Capsule Server, you must then register the content hosts on EC2 instances to Satellite with the bootstrap script. +When you install {ProjectServer} and {SmartProxyServer}, you must then register the content hosts on EC2 instances to {Project} with the bootstrap script. -For more information about using the bootstrap script, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/managing_hosts/registering_hosts#registering-a-host-to-satellite-using-the-bootstrap-script[Registering Hosts to Red{nbsp}Hat Satellite Using The Bootstrap Script] in the _Managing Hosts_ guide. +For more information about using the bootstrap script, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/managing_hosts/registering_hosts#registering-a-host-to-satellite-using-the-bootstrap-script[Registering Hosts to {ProjectName} Using The Bootstrap Script] in the _Managing Hosts_ guide. Install the Katello Agent. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/performing-additional-configuration-on-capsule-server#installing-the-katello-agent_capsule[Installing the katello Agent]. diff --git a/guides/common/modules/AWS_Installing_Satellite_AWS.adoc b/guides/common/modules/AWS_Installing_Satellite_AWS.adoc index 0fc366d660..fc2d76e8bb 100644 --- a/guides/common/modules/AWS_Installing_Satellite_AWS.adoc +++ b/guides/common/modules/AWS_Installing_Satellite_AWS.adoc @@ -1,6 +1,6 @@ -== Installing Satellite Server on AWS +== Installing {ProjectServer} on AWS On your AWS environment, complete the following steps: . Connect to the new instance. -. Use link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#installing_overview[Installing Satellite Server] to install Satellite Server. +. Use link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#installing_overview[Installing {ProjectServer}] to install {ProjectServer}. diff --git a/guides/common/modules/AWS_Introduction.adoc b/guides/common/modules/AWS_Introduction.adoc index ca4a5f718b..9ee8754487 100644 --- a/guides/common/modules/AWS_Introduction.adoc +++ b/guides/common/modules/AWS_Introduction.adoc @@ -1,10 +1,10 @@ -= Running Red Hat Satellite on Amazon Web Services += Running {ProjectName} on Amazon Web Services -Use this guide to ensure that you make all the necessary preparations for installing Red Hat Satellite Server and Capsules in Amazon Web Services (AWS) Elastic Compute Cloud (Amazon EC2). +Use this guide to ensure that you make all the necessary preparations for installing {ProjectName} Server and {SmartProxies} in Amazon Web Services (AWS) Elastic Compute Cloud (Amazon EC2). -Use the xref:Deployment_Scenarios[Deployment Scenarios] section to understand the different architecture setups that are available for Satellite and Capsule installation on AWS. +Use the xref:Deployment_Scenarios[Deployment Scenarios] section to understand the different architecture setups that are available for {Project} and {SmartProxy} installation on AWS. -Use the xref:Prerequisites[Prerequisites] section to prepare your Red Hat and Amazon Web resources for the Red Hat Satellite installation. +Use the xref:Prerequisites[Prerequisites] section to prepare your Red Hat and Amazon Web resources for the {ProjectName} installation. .Subscriptions @@ -15,34 +15,34 @@ You can create additional organizations and then import additional manifests to == Use case considerations -Because Amazon Web Services is an image-only service, there are common Satellite use cases that do not work, or require extra configuration in an Amazon Web Service environment. If you plan to use Satellite on AWS, ensure that the use case scenarios that you want to use are available in an AWS environment. +Because Amazon Web Services is an image-only service, there are common {Project} use cases that do not work, or require extra configuration in an Amazon Web Service environment. If you plan to use {Project} on AWS, ensure that the use case scenarios that you want to use are available in an AWS environment. === Use Cases Known to Work -You can perform the following Red Hat Satellite use cases on AWS: +You can perform the following {ProjectName} use cases on AWS: * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/managing_subscriptions[Subscription Management] * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/importing_red_hat_content[Content Management] * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/errata_management_guide/[Errata Management] * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/managing_hosts/registering_hosts#registering-a-host-to-satellite[Configuring Hosts] * https://access.redhat.com/products/red-hat-insights/#satellite6[Red Hat Insights] -* https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication#sect-Red_Hat_Satellite-Administering_Red_Hat_Satellite-Configuring_External_Authentication-External_Authentication_for_Provisioned_Hosts[Realm Integration via IdM] +* https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication#sect-{Project_Link}-Administering_{Project_Link}-Configuring_External_Authentication-External_Authentication_for_Provisioned_Hosts[Realm Integration via IdM] * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-security_compliance_management[OpenSCAP] * https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/managing_hosts/chap-managing_hosts-running_remote_jobs_on_hosts[Remote Execution] -.Multi-homed Satellite and Capsule -If you want Satellite to use multiple interfaces with distinct host names, you must perform additional configuration of the Satellite Server and Satellite Capsule Server CA certificates. If you want to deploy Satellite in this configuration, contact Red Hat. +.Multi-homed {Project} and {SmartProxy} +If you want {Project} to use multiple interfaces with distinct host names, you must perform additional configuration of the {ProjectServer} and {Project} {SmartProxyServer} CA certificates. If you want to deploy {Project} in this configuration, contact Red Hat. -You must do this when Satellite Server or Capsule Server has different internal and external DNS host names and there is no site-to-site VPN connection between the locations where you deploy Satellite Server and Capsule Server. +You must do this when {ProjectServer} or {SmartProxyServer} has different internal and external DNS host names and there is no site-to-site VPN connection between the locations where you deploy {ProjectServer} and {SmartProxyServer}. .On demand content sources -You can use the *On demand* download policy to reduce the storage footprint of the Red Hat Enterprise Linux server that runs Satellite. When you set the download policy to *On Demand*, content syncs to the Satellite Server or Capsule Server when a content host requests it. +You can use the *On demand* download policy to reduce the storage footprint of the Red Hat Enterprise Linux server that runs {Project}. When you set the download policy to *On Demand*, content syncs to the {ProjectServer} or {SmartProxyServer} when a content host requests it. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/importing_red_hat_content[Importing Red Hat Content] in the _Content Management Guide_. === Use Cases that Do Not Work -In AWS, you cannot manage the DHCP. Because of this, most of Satellite Server’s kickstart and PXE provisioning models are unusable. This includes: +In AWS, you cannot manage the DHCP. Because of this, most of {ProjectServer}’s kickstart and PXE provisioning models are unusable. This includes: * PXE Provisioning * Discovery and Discovery Rules diff --git a/guides/common/modules/AWS_Prerequisites.adoc b/guides/common/modules/AWS_Prerequisites.adoc index 808cf26ee3..68a686fcf5 100644 --- a/guides/common/modules/AWS_Prerequisites.adoc +++ b/guides/common/modules/AWS_Prerequisites.adoc @@ -2,7 +2,7 @@ == Prerequisites -Before you can install and register Red Hat Satellite and Capsule, you must set up accounts with Amazon Web Services (AWS) and create and start Red Hat Enterprise Linux instances on AWS. +Before you can install and register {ProjectName} and {SmartProxy}, you must set up accounts with Amazon Web Services (AWS) and create and start Red Hat Enterprise Linux instances on AWS. === Amazon Web Service Assumptions @@ -15,9 +15,9 @@ To use this guide, you must have a working knowledge of the following aspects of * Importing and exporting virtual machines in AWS. * Using AWS Direct Connect -To install Satellite in an AWS environment, you must ensure that your AWS set up meets the xref:system-requirements_satellite[] in _Installing Satellite Server from a Connected Network_. +To install {Project} in an AWS environment, you must ensure that your AWS set up meets the xref:system-requirements_satellite[] in _Installing {ProjectServer} from a Connected Network_. -To install Capsule in an AWS environment, you must ensure that your AWS set up meets the https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/preparing-environment-for-capsule-installation#system-requirements_capsule[System Requirements] in _Installing Capsule Server_. +To install {SmartProxy} in an AWS environment, you must ensure that your AWS set up meets the https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/preparing-environment-for-capsule-installation#system-requirements_capsule[System Requirements] in _Installing {SmartProxyServer}_. For more information about Amazon Web Services and terminology, see https://aws.amazon.com/documentation/ec2/[Amazon Elastic Compute Cloud Documentation]. @@ -34,16 +34,16 @@ To use this guide, you must complete the following steps: For more information about deploying Red Hat Enterprise Linux in AWS, see https://access.redhat.com/articles/2962171[How to Locate Red Hat Cloud Access Gold Images on AWS EC2]. -=== Red Hat Satellite-specific prerequisites +=== {ProjectName}-specific prerequisites * Ensure that the Amazon EC2 instance type meets or exceeds the system and storage requirements in xref:preparing_your_environment_for_installation[]. For the best performance, use an AWS Storage Optimized instance. * Use xref:preparing_your_environment_for_installation[] to understand and assign the correct storage to your AWS EBS volumes. * Store the synced content on an EBS volume that is separate to the boot volume. * Mount the synced content EBS volume separately in the operating system. * Optional: store other data, for example, the *mongodb* directory on a separate EBS volume. -* If you want the Satellite Server and Capsule Server to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance. +* If you want the {ProjectServer} and {SmartProxyServer} to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance. -=== Preparing for the Red Hat Satellite Installation +=== Preparing for the {ProjectName} Installation In your AWS environment, complete the following steps: diff --git a/guides/common/modules/applying_custom_configuration_to_red_hat_satellite.adoc b/guides/common/modules/applying_custom_configuration_to_red_hat_satellite.adoc index 3d58c78a98..8184a9d45e 100644 --- a/guides/common/modules/applying_custom_configuration_to_red_hat_satellite.adoc +++ b/guides/common/modules/applying_custom_configuration_to_red_hat_satellite.adoc @@ -1,12 +1,12 @@ [appendix] [[applying_custom_configuration_to_red_hat_satellite]] -= Applying Custom Configuration to Red Hat Satellite += Applying Custom Configuration to {ProjectName} -When you install and configure Satellite for the first time using `satellite-installer`, you can specify that the DNS and DHCP configuration files are not to be managed by Puppet using the installer flags `--foreman-proxy-dns-managed=false` and `--foreman-proxy-dhcp-managed=false`. If these flags are not specified during the initial installer run, rerunning of the installer overwrites all manual changes, for example, rerun for upgrade purposes. If changes are overwritten, you must run the restore procedure to restore the manual changes. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/applying_custom_configuration_to_red_hat_satellite#How_to_restore_manual_changes_overwritten_by_a_Puppet_run[How to Restore Manual Changes Overwritten by a Puppet Run] in _Installing Satellite Server from a Connected Network_. +When you install and configure {Project} for the first time using `{foreman-installer}`, you can specify that the DNS and DHCP configuration files are not to be managed by Puppet using the installer flags `--foreman-proxy-dns-managed=false` and `--foreman-proxy-dhcp-managed=false`. If these flags are not specified during the initial installer run, rerunning of the installer overwrites all manual changes, for example, rerun for upgrade purposes. If changes are overwritten, you must run the restore procedure to restore the manual changes. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/applying_custom_configuration_to_red_hat_satellite#How_to_restore_manual_changes_overwritten_by_a_Puppet_run[How to Restore Manual Changes Overwritten by a Puppet Run] in _Installing {ProjectServer} from a Connected Network_. -To view all installer flags available for custom configuration, run `satellite-installer --scenario satellite --full-help`. Some Puppet classes are not exposed to the Satellite installer. To manage them manually and prevent the installer from overwriting their values, specify the configuration values by adding entries to configuration file `/etc/foreman-installer/custom-hiera.yaml`. This configuration file is in YAML format, consisting of one entry per line in the format of `::: `. Configuration values specified in this file persist across installer reruns. +To view all installer flags available for custom configuration, run `{foreman-installer} --scenario satellite --full-help`. Some Puppet classes are not exposed to the {Project} installer. To manage them manually and prevent the installer from overwriting their values, specify the configuration values by adding entries to configuration file `/etc/foreman-installer/custom-hiera.yaml`. This configuration file is in YAML format, consisting of one entry per line in the format of `::: `. Configuration values specified in this file persist across installer reruns. Common examples include: @@ -28,9 +28,9 @@ apache::server_signature: Off pulp::num_workers: 8 ---- -The Puppet modules for the Satellite installer are stored under `/usr/share/foreman-installer/modules`. Check the `.pp` files (for example: _moduleName_/manifests/_example_.pp) to look up the classes, parameters, and values. Alternatively, use the `grep` command to do keyword searches. +The Puppet modules for the {Project} installer are stored under `/usr/share/foreman-installer/modules`. Check the `.pp` files (for example: _moduleName_/manifests/_example_.pp) to look up the classes, parameters, and values. Alternatively, use the `grep` command to do keyword searches. -Setting some values may have unintended consequences that affect the performance or functionality of Red{nbsp}Hat Satellite. Consider the impact of the changes before you apply them, and test the changes in a non-production environment first. If you do not have a non-production Satellite environment, run the Satellite installer with the `--noop` and `--verbose` options. If your changes cause problems, remove the offending lines from `custom-hiera.yaml` and rerun the Satellite installer. If you have any specific questions about whether a particular value is safe to alter, contact Red Hat support. +Setting some values may have unintended consequences that affect the performance or functionality of {ProjectName}. Consider the impact of the changes before you apply them, and test the changes in a non-production environment first. If you do not have a non-production {Project} environment, run the {Project} installer with the `--noop` and `--verbose` options. If your changes cause problems, remove the offending lines from `custom-hiera.yaml` and rerun the {Project} installer. If you have any specific questions about whether a particular value is safe to alter, contact Red Hat support. [[How_to_restore_manual_changes_overwritten_by_a_Puppet_run]] diff --git a/guides/common/modules/capsule_server_scalability.adoc b/guides/common/modules/capsule_server_scalability.adoc index e6a02b0d5b..a90355aaa4 100644 --- a/guides/common/modules/capsule_server_scalability.adoc +++ b/guides/common/modules/capsule_server_scalability.adoc @@ -1,17 +1,17 @@ [appendix] [[capsule_server_scalability]] -= Capsule Server Scalability Considerations += {SmartProxyServer} Scalability Considerations -The maximum number of Capsule Servers that the Satellite Server can support has no fixed limit. The tested limit is 17 Capsule Servers with 2 vCPUs on a Satellite Server with Red Hat Enterprise Linux 7. However, scalability is highly variable, especially when managing Puppet clients. +The maximum number of {SmartProxyServer}s that the {ProjectServer} can support has no fixed limit. The tested limit is 17 {SmartProxyServer}s with 2 vCPUs on a {ProjectServer} with Red Hat Enterprise Linux 7. However, scalability is highly variable, especially when managing Puppet clients. -Capsule Server scalability when managing Puppet clients depends on the number of CPUs, the run-interval distribution, and the number of Puppet managed resources. The Capsule Server has a limitation of 100 concurrent Puppet agents running at any single point in time. Running more than 100 concurrent Puppet agents results in a 503 HTTP error. +{SmartProxyServer} scalability when managing Puppet clients depends on the number of CPUs, the run-interval distribution, and the number of Puppet managed resources. The {SmartProxyServer} has a limitation of 100 concurrent Puppet agents running at any single point in time. Running more than 100 concurrent Puppet agents results in a 503 HTTP error. -For example, assuming that Puppet agent runs are evenly distributed with less than 100 concurrent Puppet agents running at any single point during a run-interval, a Capsule Server with 4 CPUs has a maximum of 1250-1600 Puppet clients with a moderate workload of 10 Puppet classes assigned to each Puppet client. Depending on the number of Puppet clients required, the Satellite installation can scale out the number of Capsule Servers to support them. +For example, assuming that Puppet agent runs are evenly distributed with less than 100 concurrent Puppet agents running at any single point during a run-interval, a {SmartProxyServer} with 4 CPUs has a maximum of 1250-1600 Puppet clients with a moderate workload of 10 Puppet classes assigned to each Puppet client. Depending on the number of Puppet clients required, the {Project} installation can scale out the number of {SmartProxyServer}s to support them. -If you want to scale your Capsule Server when managing Puppet clients, the following assumptions are made: +If you want to scale your {SmartProxyServer} when managing Puppet clients, the following assumptions are made: -* There are no external Puppet clients reporting directly to the Satellite 6 integrated Capsule. -* All other Puppet clients report directly to an external Capsule. +* There are no external Puppet clients reporting directly to the {ProjectX} integrated {SmartProxy}. +* All other Puppet clients report directly to an external {SmartProxy}. * There is an evenly distributed run-interval of all Puppet agents. NOTE: Deviating from the even distribution increases the risk of filling the passenger request queue. The limit of 100 concurrent requests applies. diff --git a/guides/common/modules/con_ports-and-firewalls-requirements.adoc b/guides/common/modules/con_ports-and-firewalls-requirements.adoc index 2461328f31..131ce8140b 100644 --- a/guides/common/modules/con_ports-and-firewalls-requirements.adoc +++ b/guides/common/modules/con_ports-and-firewalls-requirements.adoc @@ -2,20 +2,20 @@ = Ports and Firewalls Requirements -For the components of Satellite architecture to communicate, ensure that the required network ports are open and free on the base operating system. You must also ensure that the required network ports are open on any network-based firewalls. +For the components of {Project} architecture to communicate, ensure that the required network ports are open and free on the base operating system. You must also ensure that the required network ports are open on any network-based firewalls. ifeval::["{context}" == "capsule"] -The installation of a Capsule Server fails if the ports between Satellite Server and Capsule Server are not open before installation starts. +The installation of a {SmartProxyServer} fails if the ports between {ProjectServer} and {SmartProxyServer} are not open before installation starts. endif::[] Use this information to configure any network-based firewalls. Note that some cloud solutions must be specifically configured to allow communications between machines because they isolate machines similarly to network-based firewalls. If you use an application-based firewall, ensure that the application-based firewall permits all applications that are listed in the tables and known to your firewall. If possible, disable the application checking and allow open port communication based on the protocol. -.Integrated Capsule -Satellite Server has an integrated Capsule and any host that is directly connected to Satellite Server is a Client of Satellite in the context of this section. This includes the base system on which Capsule Server is running. +.Integrated {SmartProxy} +{ProjectServer} has an integrated {SmartProxy} and any host that is directly connected to {ProjectServer} is a Client of {Project} in the context of this section. This includes the base system on which {SmartProxyServer} is running. -.Clients of Capsule -Hosts which are clients of Capsules, other than Satellite's integrated Capsule, do not need access to Satellite Server. For more information on Satellite Topology, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/planning_for_red_hat_satellite_6/chap-documentation-architecture_guide-capsule_server_overview#sect-Documentation-Architecture_Guide-Capsule_Networking[Capsule Networking] in _Planning for Red Hat Satellite 6_. +.Clients of {SmartProxy} +Hosts which are clients of {SmartProxies}, other than {Project}'s integrated {SmartProxy}, do not need access to {ProjectServer}. For more information on {Project} Topology, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/planning_for_red_hat_satellite_6/chap-documentation-architecture_guide-capsule_server_overview#sect-Documentation-Architecture_Guide-{SmartProxy}_Networking[{SmartProxy} Networking] in _Planning for {ProjectNameX}_. Required ports can change based on your configuration. diff --git a/guides/common/modules/configuring_satellite_external_dns.adoc b/guides/common/modules/configuring_satellite_external_dns.adoc index cd1140eb56..776272d902 100644 --- a/guides/common/modules/configuring_satellite_external_dns.adoc +++ b/guides/common/modules/configuring_satellite_external_dns.adoc @@ -1,8 +1,8 @@ [[configuring_satellite_external_dns]] -= Configuring Satellite with External DNS += Configuring {Project} with External DNS -You can configure Satellite to use an external server to provide DNS service. +You can configure {Project} to use an external server to provide DNS service. . Deploy a Red Hat Enterprise Linux Server and install the ISC DNS Service. + @@ -13,7 +13,7 @@ You can configure Satellite to use an external server to provide DNS service. . Create the configuration file for a domain. + -The following example configures a domain `virtual.lan` as one subnet 192.168.38.0/24, a security key named `capsule`, and sets forwarders to Google's public DNS addresses (8.8.8.8 and 8.8.4.4). 192.168.38.2 is the IP address of a DNS server and 192.168.38.1 is the IP address of a Satellite{nbsp}Server or a Capsule{nbsp}Server. +The following example configures a domain `virtual.lan` as one subnet 192.168.38.0/24, a security key named `capsule`, and sets forwarders to Google's public DNS addresses (8.8.8.8 and 8.8.4.4). 192.168.38.2 is the IP address of a DNS server and 192.168.38.1 is the IP address of a {ProjectServer} or a {SmartProxyServer}. + [options="nowrap"] ---- diff --git a/guides/common/modules/configuring_satellite_external_idm_dns.adoc b/guides/common/modules/configuring_satellite_external_idm_dns.adoc index 8cd8897822..9fe095112b 100644 --- a/guides/common/modules/configuring_satellite_external_idm_dns.adoc +++ b/guides/common/modules/configuring_satellite_external_idm_dns.adoc @@ -1,27 +1,27 @@ [[configuring_satellite_external_idm_dns]] -= Configuring Satellite or Capsule with External IdM DNS += Configuring {Project} or {SmartProxy} with External IdM DNS -Red{nbsp}Hat Satellite can be configured to use a Red{nbsp}Hat Identity Management (IdM) server to provide the DNS service. Two methods are described here to achieve this, both using a transaction key. For more information on Red{nbsp}Hat Identity Management, see the https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/[Linux Domain Identity, Authentication, and Policy Guide]. +{ProjectName} can be configured to use a Red{nbsp}Hat Identity Management (IdM) server to provide the DNS service. Two methods are described here to achieve this, both using a transaction key. For more information on Red{nbsp}Hat Identity Management, see the https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/[Linux Domain Identity, Authentication, and Policy Guide]. -The first method is to install the IdM client which automates the process with the _generic security service algorithm for secret key transaction_ (GSS-TSIG) technology defined in https://tools.ietf.org/html/rfc3645[RFC3645]. This method requires installing the IdM client on the Satellite Server or Capsule's base system and having an account created by the IdM server administrator for use by the Satellite administrator. See xref:configuring_dynamic_dns_Update_with_gss-tsig_authentication[] to use this method. +The first method is to install the IdM client which automates the process with the _generic security service algorithm for secret key transaction_ (GSS-TSIG) technology defined in https://tools.ietf.org/html/rfc3645[RFC3645]. This method requires installing the IdM client on the {ProjectServer} or {SmartProxy}'s base system and having an account created by the IdM server administrator for use by the {Project} administrator. See xref:configuring_dynamic_dns_Update_with_gss-tsig_authentication[] to use this method. -The second method, _secret key transaction authentication for DNS_ (TSIG), uses an `rndc.key` for authentication. It requires root access to the IdM server to edit the BIND configuration file, installing the `BIND` utility on the Satellite Server's base system, and coping the `rndc.key` to between the systems. This technology is defined in https://tools.ietf.org/html/rfc2845[RFC2845]. See xref:configuring_dynamic_dns_update_with_tsig_authentication[] to use this method. +The second method, _secret key transaction authentication for DNS_ (TSIG), uses an `rndc.key` for authentication. It requires root access to the IdM server to edit the BIND configuration file, installing the `BIND` utility on the {ProjectServer}'s base system, and coping the `rndc.key` to between the systems. This technology is defined in https://tools.ietf.org/html/rfc2845[RFC2845]. See xref:configuring_dynamic_dns_update_with_tsig_authentication[] to use this method. [NOTE] -You are not required to use Satellite to manage DNS. If you are using the Realm enrollment feature of Satellite, where provisioned hosts are enrolled automatically to IdM, then the `ipa-client-install` script creates DNS records for the client. The following procedure and Realm enrollment are therefore mutually exclusive. For more information on configuring Realm enrollment, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication#sect-Red_Hat_Satellite-Administering_Red_Hat_Satellite-Configuring_External_Authentication-External_Authentication_for_Provisioned_Hosts[External Authentication for Provisioned Hosts] in _Administering Red Hat Satellite_. +You are not required to use {Project} to manage DNS. If you are using the Realm enrollment feature of {Project}, where provisioned hosts are enrolled automatically to IdM, then the `ipa-client-install` script creates DNS records for the client. The following procedure and Realm enrollment are therefore mutually exclusive. For more information on configuring Realm enrollment, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication#sect-{Project_Link}-Administering_{Project_Link}-Configuring_External_Authentication-External_Authentication_for_Provisioned_Hosts[External Authentication for Provisioned Hosts] in _Administering {ProjectName}_. .Determining where to install the IdM Client -When Satellite Server wants to add a DNS record for a host, it first determines which Capsule is providing DNS for that domain. It then communicates with the Capsule and adds the record. The hosts themselves are not involved in this process. This means you should install and configure the IdM client on the Satellite or Capsule that is currently configured to provide a DNS service for the domain you want to manage using the IdM server. +When {ProjectServer} wants to add a DNS record for a host, it first determines which {SmartProxy} is providing DNS for that domain. It then communicates with the {SmartProxy} and adds the record. The hosts themselves are not involved in this process. This means you should install and configure the IdM client on the {Project} or {SmartProxy} that is currently configured to provide a DNS service for the domain you want to manage using the IdM server. [[configuring_dynamic_dns_Update_with_gss-tsig_authentication]] == Configuring Dynamic DNS Update with GSS-TSIG Authentication -In this example, Satellite Server has the following settings. +In this example, {ProjectServer} has the following settings. [cols="50%,50%"] |==== -|Host name | `satellite.example.com` +|Host name | `{foreman-example-com}` | Network | `192.168.55.0/24` |==== @@ -37,8 +37,8 @@ The IdM server has the following settings. . Confirm the IdM server is deployed and the host-based firewall has been configured correctly. For more information, see https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/installing-ipa.html#prereq-ports[Port Requirements] in the _Linux Domain Identity, Authentication, and Policy Guide_. . Obtain an account on the IdM server with permissions to create zones on the IdM server. -. Confirm if the Satellite or an external Capsule is managing DNS for a domain. -. Confirm that the Satellite or external Capsule are currently working as expected. +. Confirm if the {Project} or an external {SmartProxy} is managing DNS for a domain. +. Confirm that the {Project} or external {SmartProxy} are currently working as expected. . In the case of a newly installed system, complete the installation procedures in this guide first. In particular, DNS and DHCP configuration should have been completed. . Make a backup of the answer file in case you have to revert the changes. See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#specifying_installation_options[Specifying Installation Options] for more information. @@ -52,27 +52,27 @@ The IdM server has the following settings. ---- Where _idm_user_ is the account created for you by the IdM administrator. -. Create a new Kerberos principal for the Satellite or Capsule to use to authenticate to the IdM server. +. Create a new Kerberos principal for the {Project} or {SmartProxy} to use to authenticate to the IdM server. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# ipa service-add capsule/_satellite.example.com_ +# ipa service-add capsule/_{foreman-example-com}_ ---- .Install and Configure the IdM Client. -Do this on the Satellite or Capsule Server that is managing the DNS service for a domain. +Do this on the {Project} or {SmartProxyServer} that is managing the DNS service for a domain. -. Install the `ipa-client` package on Satellite Server or Capsule Server: +. Install the `ipa-client` package on {ProjectServer} or {SmartProxyServer}: + -* On Satellite Server, enter the following command: +* On {ProjectServer}, enter the following command: + -[options="nowrap" subs="+quotes,verbatim"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-maintain packages install ipa-client +# {foreman-maintain} packages install ipa-client ---- + -* On Capsule Server, enter the following command: +* On {SmartProxyServer}, enter the following command: + ---- # yum install ipa-client @@ -101,9 +101,9 @@ Do this on the Satellite or Capsule Server that is managing the DNS service for . Get the keytab created for this system. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# ipa-getkeytab -p capsule/_satellite.example.com@EXAMPLE.COM_ \ +# ipa-getkeytab -p capsule/_{foreman-example-com}@EXAMPLE.COM_ \ -s _idm1.example.com_ -k /etc/foreman-proxy/dns.keytab ---- [NOTE] @@ -118,10 +118,10 @@ When adding a keytab to a standby system with the same host name as the original . If required, check the keytab is valid. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- # kinit -kt /etc/foreman-proxy/dns.keytab \ -capsule/_satellite.example.com@EXAMPLE.COM_ +capsule/_{foreman-example-com}@EXAMPLE.COM_ ---- .Configure DNS Zones in the IdM web UI. @@ -132,9 +132,9 @@ capsule/_satellite.example.com@EXAMPLE.COM_ .. Click *Add and Edit*. .. On the Settings tab, in the *BIND update policy* box, add an entry as follows to the semi-colon separated list. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -grant capsule\047__satellite.example.com@EXAMPLE.COM__ wildcard * ANY; +grant capsule\047__{foreman-example-com}@EXAMPLE.COM__ wildcard * ANY; ---- .. Ensure *Dynamic update* is set to *True*. @@ -148,43 +148,43 @@ grant capsule\047__satellite.example.com@EXAMPLE.COM__ wildcard * ANY; .. Click *Add and Edit*. .. On the *Settings* tab, in the *BIND update policy* box, add an entry as follows to the semi-colon separated list: + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -grant capsule\047__satellite.example.com@EXAMPLE.COM__ wildcard * ANY; +grant capsule\047__{foreman-example-com}@EXAMPLE.COM__ wildcard * ANY; ---- .. Ensure *Dynamic update* is set to *True*. .. Select *Save* to save the changes. -.Configure the Satellite or Capsule Server Managing the DNS Service for the Domain. +.Configure the {Project} or {SmartProxyServer} Managing the DNS Service for the Domain. -- On a Satellite Server's Base System. +- On a {ProjectServer}'s Base System. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -satellite-installer --scenario satellite \ +{foreman-installer} --scenario satellite \ --foreman-proxy-dns=true \ --foreman-proxy-dns-managed=true \ --foreman-proxy-dns-provider=nsupdate_gss \ --foreman-proxy-dns-server="_idm1.example.com_" \ ---foreman-proxy-dns-tsig-principal="capsule/_satellite.example.com@EXAMPLE.COM_" \ +--foreman-proxy-dns-tsig-principal="capsule/_{foreman-example-com}@EXAMPLE.COM_" \ --foreman-proxy-dns-tsig-keytab=/etc/foreman-proxy/dns.keytab \ --foreman-proxy-dns-reverse="55.168.192.in-addr.arpa" \ --foreman-proxy-dns-zone=_example.com_ \ --foreman-proxy-dns-ttl=86400 ---- -- On a Capsule Server's Base System. +- On a {SmartProxyServer}'s Base System. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -satellite-installer --scenario capsule \ +{foreman-installer} --scenario capsule \ --foreman-proxy-dns=true \ --foreman-proxy-dns-managed=true \ --foreman-proxy-dns-provider=nsupdate_gss \ --foreman-proxy-dns-server="_idm1.example.com_" \ ---foreman-proxy-dns-tsig-principal="capsule/_satellite.example.com@EXAMPLE.COM_" \ +--foreman-proxy-dns-tsig-principal="capsule/_{foreman-example-com}@EXAMPLE.COM_" \ --foreman-proxy-dns-tsig-keytab=/etc/foreman-proxy/dns.keytab \ --foreman-proxy-dns-reverse="55.168.192.in-addr.arpa" \ --foreman-proxy-dns-zone=_example.com_ \ @@ -192,7 +192,7 @@ satellite-installer --scenario capsule \ ---- -Restart the Satellite or Capsule's Proxy Service. +Restart the {Project} or {SmartProxy}'s Proxy Service. [options="nowrap"] ---- @@ -201,25 +201,25 @@ Restart the Satellite or Capsule's Proxy Service. -.Update the Configuration in Satellite web UI. +.Update the Configuration in {Project} web UI. -After you have run the installation script to make any changes to a Capsule, instruct Satellite to scan the configuration on each affected Capsule as follows: +After you have run the installation script to make any changes to a {SmartProxy}, instruct {Project} to scan the configuration on each affected {SmartProxy} as follows: -. Navigate to *Infrastructure* > *Capsules*. +. Navigate to *Infrastructure* > *{SmartProxies}*. -. For each Capsule to be updated, from the *Actions* drop-down menu, select *Refresh*. +. For each {SmartProxy} to be updated, from the *Actions* drop-down menu, select *Refresh*. . Configure the domain: .. Go to *Infrastructure* > *Domains* and select the domain name. -.. On the *Domain* tab, ensure *DNS Capsule* is set to the Capsule where the subnet is connected. +.. On the *Domain* tab, ensure *DNS {SmartProxy}* is set to the {SmartProxy} where the subnet is connected. . Configure the subnet: .. Go to *Infrastructure* > *Subnets* and select the subnet name. .. On the *Subnet* tab, set *IPAM* to *None*. .. On the *Domains* tab, ensure the domain to be managed by the IdM server is selected. -.. On the *Capsules* tab, ensure *Reverse DNS Capsule* is set to the Capsule where the subnet is connected. +.. On the *{SmartProxies}* tab, ensure *Reverse DNS {SmartProxy}* is set to the {SmartProxy} where the subnet is connected. .. Click *Submit* to save the changes. @@ -227,11 +227,11 @@ After you have run the installation script to make any changes to a Capsule, ins == Configuring Dynamic DNS Update with TSIG Authentication -In this example, Satellite Server has the following settings. +In this example, {ProjectServer} has the following settings. [cols="50%,50%"] |==== |IP address | `192.168.25.1` -|Host name | `satellite.example.com` +|Host name | `{foreman-example-com}` |==== The IdM server has the following settings. @@ -246,8 +246,8 @@ The IdM server has the following settings. . Confirm the IdM Server is deployed and the host-based firewall has been configured correctly. For more information, see https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/installing-ipa.html#prereq-ports[Port Requirements] in the _Linux Domain Identity, Authentication, and Policy Guide_. . Obtain `root` user privileges on the IdM server. -. Confirm if the Satellite or an external Capsule is managing DNS for a domain. -. Confirm that the Satellite or external Capsule are currently working as expected. +. Confirm if the {Project} or an external {SmartProxy} is managing DNS for a domain. +. Confirm that the {Project} or external {SmartProxy} are currently working as expected. . In the case of a newly installed system, complete the installation procedures in this guide first. In particular, DNS and DHCP configuration should have been completed. . Make a backup of the answer file in case you have to revert the changes. See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#specifying_installation_options[Specifying Installation Options] for more information. @@ -268,7 +268,7 @@ inet 192.168.25.2 port 953 allow { 192.168.25.1; } keys { "rndc-key"; }; . Reload `named` to make the changes take effect. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- # systemctl reload named ---- @@ -287,11 +287,11 @@ grant "rndc-key" zonesub ANY; .. Click *Update* to save the changes. -. Copy the `/etc/rndc.key` file from the IdM server to Satellite's base system as follows. +. Copy the `/etc/rndc.key` file from the IdM server to {Project}'s base system as follows. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# scp /etc/rndc.key root@_satellite.example.com_:/etc/rndc.key +# scp /etc/rndc.key root@_{foreman-example-com}_:/etc/rndc.key ---- . Ensure that the ownership, permissions, and SELinux context are correct. @@ -304,11 +304,11 @@ grant "rndc-key" zonesub ANY; ---- -. On Satellite Server, run the installation script as follows to use the external DNS server. +. On {ProjectServer}, run the installation script as follows to use the external DNS server. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite \ +# {foreman-installer} --scenario satellite \ --foreman-proxy-dns=true \ --foreman-proxy-dns-managed=false \ --foreman-proxy-dns-provider=nsupdate \ @@ -325,7 +325,7 @@ grant "rndc-key" zonesub ANY; # yum install bind-utils ---- -. Ensure the key in the `/etc/rndc.key` file on Satellite Server is the same one as used on the IdM server. +. Ensure the key in the `/etc/rndc.key` file on {ProjectServer} is the same one as used on the IdM server. + [options="nowrap" subs="+quotes"] ---- @@ -335,7 +335,7 @@ key "rndc-key" { }; ---- -. On Satellite Server, create a test DNS entry for a host. For example, host `_test.example.com_` with an A record of `192.168.25.20` on the IdM server at `192.168.25.1`. +. On {ProjectServer}, create a test DNS entry for a host. For example, host `_test.example.com_` with an A record of `192.168.25.20` on the IdM server at `192.168.25.1`. + [options="nowrap" subs="+quotes"] ---- @@ -344,7 +344,7 @@ update add _test.example.com_ 3600 IN A 192.168.25.20\n \ send\n" | nsupdate -k /etc/rndc.key ---- -. On Satellite Server, test the DNS entry. +. On {ProjectServer}, test the DNS entry. + [options="nowrap" subs="+quotes"] ---- @@ -377,52 +377,52 @@ The above `nslookup` command fails and returns the SERVFAIL error message if the == Reverting to Internal DNS Service -To revert to using Satellite Server and Capsule Server as DNS providers, follow this procedure. +To revert to using {ProjectServer} and {SmartProxyServer} as DNS providers, follow this procedure. -.On the Satellite or Capsule Server that is to manage DNS for the domain. +.On the {Project} or {SmartProxyServer} that is to manage DNS for the domain. - If you backed up the answer file before the change to external DNS, restore the answer file and then run the installation script: + -[options="nowrap", subs="+quotes"] +[options="nowrap", subs="+quotes,attributes"] ----- -# satellite-installer +# {foreman-installer} ----- + - - If you do not have a suitable backup of the answer file, back up the answer file now, and then run the installation script on Satellite and Capsules as described below. + - If you do not have a suitable backup of the answer file, back up the answer file now, and then run the installation script on {Project} and {SmartProxies} as described below. + See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#specifying_installation_options[Specifying Installation Options] for more information on the answer file. -.To configure Satellite or Capsule as DNS server without using an answer file. -[options="nowrap" subs="+quotes"] +.To configure {Project} or {SmartProxy} as DNS server without using an answer file. +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer \ +# {foreman-installer} \ --foreman-proxy-dns=true \ --foreman-proxy-dns-managed=true \ --foreman-proxy-dns-provider=nsupdate \ --foreman-proxy-dns-server="127.0.0.1" \ ---foreman-proxy-dns-tsig-principal="foremanproxy/_satellite.example.com@EXAMPLE.COM_" \ +--foreman-proxy-dns-tsig-principal="foremanproxy/_{foreman-example-com}@EXAMPLE.COM_" \ --foreman-proxy-dns-tsig-keytab=/etc/foreman-proxy/dns.keytab ---- -See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/performing-additional-configuration-on-capsule-server#configuring-dns-dhcp-and-tftp_capsule[Configuring DNS, DHCP, and TFTP on Capsule Server] for more information. +See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/performing-additional-configuration-on-capsule-server#configuring-dns-dhcp-and-tftp_capsule[Configuring DNS, DHCP, and TFTP on {SmartProxyServer}] for more information. -.Update the Configuration in Satellite web UI. +.Update the Configuration in {Project} web UI. -After you have run the installation script to make any changes to a Capsule, instruct Satellite to scan the configuration on each affected Capsule as follows: +After you have run the installation script to make any changes to a {SmartProxy}, instruct {Project} to scan the configuration on each affected {SmartProxy} as follows: -. Navigate to *Infrastructure* > *Capsules*. +. Navigate to *Infrastructure* > *{SmartProxies}*. -. For each Capsule to be updated, from the *Actions* drop-down menu, select *Refresh*. +. For each {SmartProxy} to be updated, from the *Actions* drop-down menu, select *Refresh*. . Configure the domain: .. Go to *Infrastructure* > *Domains* and select the domain name. -.. On the *Domain* tab, ensure *DNS Capsule* is set to the Capsule where the subnet is connected. +.. On the *Domain* tab, ensure *DNS {SmartProxy}* is set to the {SmartProxy} where the subnet is connected. . Configure the subnet: .. Go to *Infrastructure* > *Subnets* and select the subnet name. .. On the *Subnet* tab, set *IPAM* to *DHCP* or *Internal DB*. -.. On the *Domains* tab, ensure the domain to be managed by the Satellite or Capsule is selected. -.. On the *Capsules* tab, ensure *Reverse DNS Capsule* is set to the Capsule where the subnet is connected. +.. On the *Domains* tab, ensure the domain to be managed by the {Project} or {SmartProxy} is selected. +.. On the *{SmartProxies}* tab, ensure *Reverse DNS {SmartProxy}* is set to the {SmartProxy} where the subnet is connected. .. Click *Submit* to save the changes. diff --git a/guides/common/modules/configuring_satellite_external_services.adoc b/guides/common/modules/configuring_satellite_external_services.adoc index a3ac604001..10b3ea786f 100644 --- a/guides/common/modules/configuring_satellite_external_services.adoc +++ b/guides/common/modules/configuring_satellite_external_services.adoc @@ -1,5 +1,5 @@ [[configuring_satellite_external_services]] -Some environments have existing DNS, DHCP, and TFTP services and do not need to use the Satellite Server to provide these services. If you want to use external servers to provide DNS, DHCP, or TFTP, you can configure them for use with Satellite Server. +Some environments have existing DNS, DHCP, and TFTP services and do not need to use the {ProjectServer} to provide these services. If you want to use external servers to provide DNS, DHCP, or TFTP, you can configure them for use with {ProjectServer}. -If you want to disable these services in Satellite in order to manage them manually, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#disabling_dns_dhcp_tftp_for_unmanaged_networks[Disabling DNS, DHCP, and TFTP for Unmanaged Networks] for more information. +If you want to disable these services in {Project} in order to manage them manually, see link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#disabling_dns_dhcp_tftp_for_unmanaged_networks[Disabling DNS, DHCP, and TFTP for Unmanaged Networks] for more information. diff --git a/guides/common/modules/configuring_satellite_external_tftp.adoc b/guides/common/modules/configuring_satellite_external_tftp.adoc index 7fe557fed2..4199ee4bdd 100644 --- a/guides/common/modules/configuring_satellite_external_tftp.adoc +++ b/guides/common/modules/configuring_satellite_external_tftp.adoc @@ -1,16 +1,16 @@ [[configuring_satellite_external_tftp]] -= Configuring Satellite Server with External TFTP += Configuring {ProjectServer} with External TFTP -Use this procedure to configure your Satellite Server with external TFTP services. +Use this procedure to configure your {ProjectServer} with external TFTP services. You can use TFTP services through NAT, for more information see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/provisioning_guide/configuring_networking#Configuring_Networking-Using_TFTP_Services_through_NAT[Using TFTP services through NAT] in the _Provisioning_ guide. .Before You Begin -* You should have already configured NFS and the firewall for external access to NFS. See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network#configuring-satellite-deployment-with-external-dhcp_satellite[Configuring Satellite Server with External DHCP]. +* You should have already configured NFS and the firewall for external access to NFS. See link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network#configuring-satellite-deployment-with-external-dhcp_satellite[Configuring {ProjectServer} with External DHCP]. -.Configure Satellite Server with External TFTP +.Configure {ProjectServer} with External TFTP . Install and enable the TFTP server. + diff --git a/guides/common/modules/configuring_satellite_http_proxy.adoc b/guides/common/modules/configuring_satellite_http_proxy.adoc index fda5c4b935..6d6e9eb6b7 100644 --- a/guides/common/modules/configuring_satellite_http_proxy.adoc +++ b/guides/common/modules/configuring_satellite_http_proxy.adoc @@ -1,16 +1,16 @@ [[configuring_satellite_http_proxy]] -= Configuring Satellite Server with an HTTP Proxy += Configuring {ProjectServer} with an HTTP Proxy -If your network uses an HTTP Proxy, you can configure Satellite Server to use an HTTP proxy for requests to the Red{nbsp}Hat Content Delivery Network (CDN) or another content source. Use the FQDN instead of the IP address where possible to avoid losing connectivity because of network changes. +If your network uses an HTTP Proxy, you can configure {ProjectServer} to use an HTTP proxy for requests to the Red{nbsp}Hat Content Delivery Network (CDN) or another content source. Use the FQDN instead of the IP address where possible to avoid losing connectivity because of network changes. -The following procedure configures a proxy only for downloading content for Satellite. +The following procedure configures a proxy only for downloading content for {Project}. .Authentication Methods Only basic authentication is supported: add your user name and password information to the `--katello-proxy-url` option, or use the `--katello-proxy-username` and `--katello-proxy-password` options. -.To Configure Satellite with an HTTP Proxy +.To Configure {Project} with an HTTP Proxy . Verify that the `*http_proxy*`, `*https_proxy*`, and `*no_proxy*` variables are not set. + @@ -21,18 +21,18 @@ Only basic authentication is supported: add your user name and password informat # unset no_proxy ---- -. Run `satellite-installer` with the HTTP proxy options. +. Run `{foreman-installer}` with the HTTP proxy options. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite \ +# {foreman-installer} --scenario satellite \ --katello-proxy-url=http://__myproxy.example.com__ \ --katello-proxy-port=8080 \ --katello-proxy-username=__proxy_username__ \ --katello-proxy-password='__proxy_password__' ---- -. Verify that Satellite Server can connect to the Red{nbsp}Hat CDN and can synchronize its repositories. +. Verify that {ProjectServer} can connect to the Red{nbsp}Hat CDN and can synchronize its repositories. .. On the network gateway and the HTTP Proxy, enable TCP for the following host names: + @@ -46,12 +46,12 @@ Only basic authentication is supported: add your user name and password informat | api.access.redhat.com (if using Red{nbsp}Hat Insights) | 443 | HTTPS |==== + -Satellite Server communicates with the Red{nbsp}Hat CDN securely over SSL. Use of an SSL interception proxy interferes with this communication. These hosts must be whitelisted on the proxy. +{ProjectServer} communicates with the Red{nbsp}Hat CDN securely over SSL. Use of an SSL interception proxy interferes with this communication. These hosts must be whitelisted on the proxy. + For a list of IP addresses used by the Red{nbsp}Hat CDN (cdn.redhat.com), see the Knowledgebase article https://access.redhat.com/articles/1525183[Public CIDR Lists for Red{nbsp}Hat] on the Red{nbsp}Hat Customer Portal. + -.. On Satellite Server, complete the following details in the `/etc/rhsm/rhsm.conf` file: +.. On {ProjectServer}, complete the following details in the `/etc/rhsm/rhsm.conf` file: + [options="nowrap" subs="+quotes"] ---- @@ -70,7 +70,7 @@ proxy_password = .SELinux Considerations for Custom Ports -SELinux ensures access of Red{nbsp}Hat Satellite 6 and Red{nbsp}Hat Subscription Manager only to specific ports. In the case of the HTTP cache, the TCP ports are 8080, 8118, 8123, and 10001 - 10010. If you use a port that does not have SELinux type `http_cache_port_t`, complete the following steps: +SELinux ensures access of {ProjectNameX} and Red{nbsp}Hat Subscription Manager only to specific ports. In the case of the HTTP cache, the TCP ports are 8080, 8118, 8123, and 10001 - 10010. If you use a port that does not have SELinux type `http_cache_port_t`, complete the following steps: . To verify the ports that are permitted by SELinux for the HTTP cache, enter a command as follows: + @@ -90,25 +90,25 @@ _[output truncated]_ [[configuring_foreman_http_server]] -= Using an HTTP Proxy for all Satellite HTTP Requests += Using an HTTP Proxy for all {Project} HTTP Requests -If your Satellite Server must remain behind a firewall that blocks HTTP and HTTPS, you can configure a proxy for communication with external systems, including compute resources. +If your {ProjectServer} must remain behind a firewall that blocks HTTP and HTTPS, you can configure a proxy for communication with external systems, including compute resources. -Note that if you are using compute resources for provisioning, and you want to use a different HTTP proxy with the compute resources, the proxy that you set for all Satellite communication takes precedence over the proxies that you set for compute resources. +Note that if you are using compute resources for provisioning, and you want to use a different HTTP proxy with the compute resources, the proxy that you set for all {Project} communication takes precedence over the proxies that you set for compute resources. -To set an HTTP proxy for all outgoing HTTP connections from Satellite, complete the following steps: +To set an HTTP proxy for all outgoing HTTP connections from {Project}, complete the following steps: -. In the Satellite web UI, navigate to *Administer* > *Settings*. +. In the {Project} web UI, navigate to *Administer* > *Settings*. . In the *HTTP(S) proxy* row, select the adjacent *Value* column and enter the proxy URL. . Click the tick icon to save your changes. .Excluding Hosts from Receiving Proxied Requests -If you use an HTTP Proxy for all Satellite HTTP or HTTPS requests, you can prevent certain hosts from communicating through the proxy. +If you use an HTTP Proxy for all {Project} HTTP or HTTPS requests, you can prevent certain hosts from communicating through the proxy. To exclude one or more hosts from communicating through the proxy, complete the following steps: -. In the Satellite web UI, navigate to *Administer* > *Settings*. +. In the {Project} web UI, navigate to *Administer* > *Settings*. . In the *HTTP(S) proxy except hosts* row, select the adjacent *Value* column and enter the names of one or more hosts that you want to exclude from proxy requests. . Click the tick icon to save your changes. @@ -117,9 +117,9 @@ To exclude one or more hosts from communicating through the proxy, complete the If you want to reset the current HTTP proxy setting, enter the following command: -[options="nowrap"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite --reset-katello-proxy-url \ +# {foreman-installer} --scenario satellite --reset-katello-proxy-url \ --reset-katello-proxy-port --reset-katello-proxy-username \ --reset-katello-proxy-password diff --git a/guides/common/modules/configuring_satellite_outgoing_emails.adoc b/guides/common/modules/configuring_satellite_outgoing_emails.adoc index 87c7921382..dd7af22eb5 100644 --- a/guides/common/modules/configuring_satellite_outgoing_emails.adoc +++ b/guides/common/modules/configuring_satellite_outgoing_emails.adoc @@ -1,8 +1,8 @@ [[configuring_satellite_outgoing_emails]] -= Configuring Satellite Server for Outgoing Emails += Configuring {ProjectServer} for Outgoing Emails -To send email messages from Satellite Server, you can use either an SMTP server, or the `sendmail` command. +To send email messages from {ProjectServer}, you can use either an SMTP server, or the `sendmail` command. .Prerequisites @@ -15,8 +15,8 @@ If you have upgraded from a previous release, rename or remove the configuration ---- -.To Configure Satellite Server for Outgoing Emails: -. In the Satellite web UI, navigate to *Administer* -> *Settings*. +.To Configure {ProjectServer} for Outgoing Emails: +. In the {Project} web UI, navigate to *Administer* -> *Settings*. . Click the *Email* tab and set the configuration options to match your preferred delivery method. The changes have an immediate effect. + @@ -32,7 +32,7 @@ If you have upgraded from a previous release, rename or remove the configuration |SMTP HELO/EHLO domain | _example.com_ |SMTP password | _password_ |SMTP port | 25 -|SMTP username | _satellite@example.com_ +|SMTP username | _user@example.com_ |==== + The `SMTP username` and `SMTP password` specify the login credentials for the SMTP server. @@ -67,7 +67,7 @@ The `Sendmail arguments` specify the options passed to the `sendmail` command. T . If you decide to send email using an SMTP server which uses TLS authentication, also perform one of the following steps: + -* Mark the CA certificate of the SMTP server as trusted. To do so, execute the following commands on Satellite Server: +* Mark the CA certificate of the SMTP server as trusted. To do so, execute the following commands on {ProjectServer}: + [options="nowrap"] ---- @@ -82,5 +82,4 @@ Where `_mailca.crt_` is the CA certificate of the SMTP server. . Click *Test email* to send a test message to the user's email address to confirm the configuration is working. If a message fails to send, the web UI displays an error. See the log at `/var/log/foreman/production.log` for further details. -NOTE: For information on configuring email notifications for individual users or user groups, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-users_and_roles#sect-Red_Hat_Satellite-Administering_Red_Hat_Satellite-Creating_and_Managing_Users-Configuring_Email_Notifications[Configuring Email Notifications] in _Administering Red Hat Satellite_. - +NOTE: For information on configuring email notifications for individual users or user groups, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-users_and_roles#sect-{Project_Link}-Administering_{Project_Link}-Creating_and_Managing_Users-Configuring_Email_Notifications[Configuring Email Notifications] in _Administering {ProjectName}_. diff --git a/guides/common/modules/creating_and_installing_manifests.adoc b/guides/common/modules/creating_and_installing_manifests.adoc index 7ff7337766..57492b8537 100644 --- a/guides/common/modules/creating_and_installing_manifests.adoc +++ b/guides/common/modules/creating_and_installing_manifests.adoc @@ -1,7 +1,7 @@ [[Managing_Subscriptions-Creating_a_Subscription_Manifest]] == Creating a Subscription Allocation in Customer Portal -You can access your subscription information on the Red Hat Customer Portal. You can also assign subscriptions for use in on-premise management applications, such as Red Hat Satellite, using subscription allocations. +You can access your subscription information on the Red Hat Customer Portal. You can also assign subscriptions for use in on-premise management applications, such as {ProjectName}, using subscription allocations. . Open https://access.redhat.com/ in your browser and log in to the Red{nbsp}Hat account that you used to register the system to Red{nbsp}Hat Subscription Management. @@ -13,7 +13,7 @@ You can access your subscription information on the Red Hat Customer Portal. You . In the *Name* field, enter a name. -. From the *Type* list, select the type and version that corresponds to your Satellite Server. +. From the *Type* list, select the type and version that corresponds to your {ProjectServer}. . Click *Create*. @@ -48,18 +48,18 @@ While viewing a subscription allocation that has at least one subscription, you * From the *Details* tab, under the *Subscription* section, by clicking the *Export Manifest* button. * From the *Subscriptions* tab, by clicking the *Export Manifest* button. -When the manifest is exported, the Customer Portal encodes the selected subscriptions certificates and creates a .zip archive. This is the Subscription Manifest, which can be uploaded into the Satellite Server. +When the manifest is exported, the Customer Portal encodes the selected subscriptions certificates and creates a .zip archive. This is the Subscription Manifest, which can be uploaded into the {ProjectServer}. [[Managing_Subscriptions-Importing_a_Subscription_Manifest_into_the_Satellite_6_Server]] -== Importing a Subscription Manifest into the Satellite Server +== Importing a Subscription Manifest into the {ProjectServer} -Both the Red Hat Satellite 6 web UI and CLI provide methods for importing the manifest. +Both the {ProjectNameX} web UI and CLI provide methods for importing the manifest. ifeval::["{mode}" == "disconnected"] .Prerequisites -* Ensure that you enable the disconnected mode on your Satellite Server. For more information, see xref:enabling-the-disconnected-mode[]. +* Ensure that you enable the disconnected mode on your {ProjectServer}. For more information, see xref:enabling-the-disconnected-mode[]. endif::[] @@ -76,11 +76,11 @@ endif::[] .For CLI Users -The Red Hat Satellite 6 CLI requires the manifest to be on the Satellite Server. On your local client system, copy the manifest to the Satellite Server: +The {ProjectNameX} CLI requires the manifest to be on the {ProjectServer}. On your local client system, copy the manifest to the {ProjectServer}: -[subs="+quotes"] +[subs="+quotes,attributes"] ---- -[user@client ~]$ scp ~/_manifest_file_.zip root@satellite.example.com:~/. +[user@client ~]$ scp ~/_manifest_file_.zip root@{foreman-example-com}:~/. ---- Then import it using the following command: @@ -96,4 +96,4 @@ After a few minutes, the CLI reports a successful manifest import. -When you complete this section, you can enable repositories and import Red Hat content. This is a prerequisite for some of the following procedures. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/importing_red_hat_content[Importing Red Hat Content] in the _Red Hat{nbsp}Satellite Content Management Guide_. +When you complete this section, you can enable repositories and import Red Hat content. This is a prerequisite for some of the following procedures. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/importing_red_hat_content[Importing Red Hat Content] in the Content Management Guide_. diff --git a/guides/common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc b/guides/common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc index b5e018e54d..cdbcc2801f 100644 --- a/guides/common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc +++ b/guides/common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc @@ -2,27 +2,28 @@ = Disabling DNS, DHCP, and TFTP for Unmanaged Networks -If you want to manage TFTP, DHCP, and DNS services manually, you must prevent Satellite from maintaining these services on the operating system and disable orchestration to avoid DHCP and DNS validation errors. However, Satellite does not remove the back-end services on the operating system. +If you want to manage TFTP, DHCP, and DNS services manually, you must prevent {Project} from maintaining these services on the operating system and disable orchestration to avoid DHCP and DNS validation errors. However, {Project} does not remove the back-end services on the operating system. .Procedure -To prevent Satellite from maintaining DHCP, DNS, and TFTP services on the operating system, and disable orchestration, complete the following steps: +To prevent {Project} from maintaining DHCP, DNS, and TFTP services on the operating system, and disable orchestration, complete the following steps: -. On Satellite Server, enter the following command: +. On {ProjectServer}, enter the following command: + +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-dhcp false \ +# {foreman-installer} --foreman-proxy-dhcp false \ --foreman-proxy-dns false \ --foreman-proxy-tftp false ---- -. In the Satellite web UI, navigate to *Infrastructure* > *Subnets* and select a subnet. +. In the {Project} web UI, navigate to *Infrastructure* > *Subnets* and select a subnet. -. Click the *Capsules* tab and clear the *DHCP Capsule*, *TFTP Capsule*, and *Reverse DNS Capsule* fields. +. Click the *{SmartProxies}* tab and clear the *DHCP {SmartProxy}*, *TFTP {SmartProxy}*, and *Reverse DNS {SmartProxy}* fields. . Navigate to *Infrastructure* > *Domains* and select a domain. -. Clear the *DNS Capsule* field. +. Clear the *DNS {SmartProxy}* field. . Optional: If you use a DHCP service supplied by a third party, configure your DHCP server to pass the following options: + @@ -35,4 +36,4 @@ Option 67: /pxelinux.0 For more information about DHCP options, see https://tools.ietf.org/html/rfc2132[RFC 2132]. [NOTE] -Satellite 6 does not perform orchestration when a Capsule is not set for a given subnet and domain. When enabling or disabling Capsule associations, orchestration commands for existing hosts can fail if the expected records and configuration files are not present. When associating a Capsule to turn orchestration on, make sure the required DHCP and DNS records as well as the TFTP files are in place for the existing Satellite hosts in order to prevent host deletion failures in the future. +{ProjectX} does not perform orchestration when a {SmartProxy} is not set for a given subnet and domain. When enabling or disabling {SmartProxy} associations, orchestration commands for existing hosts can fail if the expected records and configuration files are not present. When associating a {SmartProxy} to turn orchestration on, make sure the required DHCP and DNS records as well as the TFTP files are in place for the existing {Project} hosts in order to prevent host deletion failures in the future. diff --git a/guides/common/modules/downloading_installing_satellite_disconnected.adoc b/guides/common/modules/downloading_installing_satellite_disconnected.adoc index a62d300685..aa84f5a93f 100644 --- a/guides/common/modules/downloading_installing_satellite_disconnected.adoc +++ b/guides/common/modules/downloading_installing_satellite_disconnected.adoc @@ -2,7 +2,7 @@ = Downloading and Installing from a Disconnected Network -When the intended host for the Red Hat Satellite Server is in a disconnected environment, it is possible to install the Satellite Server by using an ISO image. This method is not recommended for any other situation as ISO images might not contain the latest updates, bug fixes, and functionality. +When the intended host for the {ProjectName} Server is in a disconnected environment, it is possible to install the {ProjectServer} by using an ISO image. This method is not recommended for any other situation as ISO images might not contain the latest updates, bug fixes, and functionality. .Before You Begin @@ -24,17 +24,17 @@ When the intended host for the Red Hat Satellite Server is in a disconnected env . On the *Product Software* tab, download the Binary DVD image for the latest Red Hat Enterprise Linux Server version. -. Click *DOWNLOADS* and select *Red Hat Satellite*. +. Click *DOWNLOADS* and select *{ProjectName}*. . Ensure that you have the correct product and version for your environment. + -* *Product Variant* is set to *Red Hat Satellite*. +* *Product Variant* is set to *{ProjectName}*. * *Version* is set to the latest minor version of the product you plan to use as the base system. * *Architecture* is set to the 64 bit version. -. On the *Product Software* tab, download the Binary DVD image for the latest Red Hat Satellite version. +. On the *Product Software* tab, download the Binary DVD image for the latest {ProjectName} version. -. Copy the ISO files to `/var/tmp` on the Satellite base system or other accessible storage device. +. Copy the ISO files to `/var/tmp` on the {Project} base system or other accessible storage device. + [options="nowrap"] ---- @@ -79,14 +79,14 @@ baseurl=file:///media/rhel7-server/ # yum repolist ---- -. Create a directory to serve as the mount point for the ISO file of the Satellite Server. +. Create a directory to serve as the mount point for the ISO file of the {ProjectServer}. + [options="nowrap"] ---- # mkdir /media/sat6 ---- -. Mount the ISO image for Red Hat Satellite Server to the mount point. +. Mount the ISO image for {ProjectName} Server to the mount point. + [options="nowrap" subs="+quotes"] ---- @@ -96,7 +96,7 @@ baseurl=file:///media/rhel7-server/ [[installing_from_the_offline_repositories]] == Installing from the Offline Repositories -. Ensure the ISO images for Red Hat Enterprise Linux Server and Red Hat Satellite are mounted: +. Ensure the ISO images for Red Hat Enterprise Linux Server and {ProjectName} are mounted: + [options="nowrap"] ---- @@ -117,7 +117,7 @@ baseurl=file:///media/rhel7-server/ # yum update ---- -. Change to the directory where the Satellite ISO is mounted: +. Change to the directory where the {Project} ISO is mounted: + [options="nowrap"] ---- @@ -131,4 +131,4 @@ baseurl=file:///media/rhel7-server/ # ./install_packages ---- + -If you have successfully installed the Satellite packages, the following message is displayed: `Install is complete. Please run satellite-installer --scenario satellite`. +If you have successfully installed the {Project} packages, the following message is displayed: `Install is complete. Please run {foreman-installer} --scenario satellite`. diff --git a/guides/common/modules/enabling-the-disconnected-mode.adoc b/guides/common/modules/enabling-the-disconnected-mode.adoc index 1f4d8a9404..cfd1d836a4 100644 --- a/guides/common/modules/enabling-the-disconnected-mode.adoc +++ b/guides/common/modules/enabling-the-disconnected-mode.adoc @@ -1,18 +1,18 @@ [id='enabling-the-disconnected-mode'] = Enabling the Disconnected Mode -Enable the disconnected mode on Satellite Server. When the disconnected mode is enabled, Satellite Server does not access the Red Hat Content Delivery Network (CDN). +Enable the disconnected mode on {ProjectServer}. When the disconnected mode is enabled, {ProjectServer} does not access the Red Hat Content Delivery Network (CDN). .Procedure -To enable the disconnected mode on Satellite Server, complete the following steps: +To enable the disconnected mode on {ProjectServer}, complete the following steps: -. In the Satellite web UI, navigate to *Administer* > *Settings*. +. In the {Project} web UI, navigate to *Administer* > *Settings*. . Click the *Content* tab. . Set the `Disconnected mode` value to `Yes`. .For the CLI Users -Enter the following command on Satellite Server: +Enter the following command on {ProjectServer}: ---- # hammer settings set --name content_disconnected --value true diff --git a/guides/common/modules/enabling_client_connections_to_satellite.adoc b/guides/common/modules/enabling_client_connections_to_satellite.adoc index 686cf0e0b8..f0401f7844 100644 --- a/guides/common/modules/enabling_client_connections_to_satellite.adoc +++ b/guides/common/modules/enabling_client_connections_to_satellite.adoc @@ -1,14 +1,14 @@ [[enabling_client_connections_to_satellite]] -= Enabling Connections from a Client to Satellite Server += Enabling Connections from a Client to {ProjectServer} -Capsules and Content Hosts that are clients of a Satellite Server's internal Capsule require access through Satellite's host-based firewall and any network-based firewalls. +{SmartProxies} and Content Hosts that are clients of a {ProjectServer}'s internal {SmartProxy} require access through {Project}'s host-based firewall and any network-based firewalls. -Use this section to configure the host-based firewall on the Red Hat Enterprise Linux 7 system that Satellite is installed on, to enable incoming connections from Clients, and to make the configuration persistent across system reboots. For more information on the ports used, see xref:ports-and-firewalls-requirements_satellite[]. +Use this section to configure the host-based firewall on the Red Hat Enterprise Linux 7 system that {Project} is installed on, to enable incoming connections from Clients, and to make the configuration persistent across system reboots. For more information on the ports used, see xref:ports-and-firewalls-requirements_satellite[]. .Configuring the Firewall -. To open the ports for client to Satellite communication, enter the following command on the base system that you want to install Satellite on: +. To open the ports for client to {Project} communication, enter the following command on the base system that you want to install {Project} on: + [options="nowrap"] ---- diff --git a/guides/common/modules/enabling_the_satellite_tools_repository.adoc b/guides/common/modules/enabling_the_satellite_tools_repository.adoc index eaf543a17d..f65ea7632c 100644 --- a/guides/common/modules/enabling_the_satellite_tools_repository.adoc +++ b/guides/common/modules/enabling_the_satellite_tools_repository.adoc @@ -1,32 +1,32 @@ [[enabling_satellite_tools_repository]] -= Enabling the Satellite Tools Repository += Enabling the {Project} Tools Repository -The Satellite Tools repository provides the `katello-agent` and `puppet` packages for clients registered to Satellite Server. Installing the Katello agent is recommended to allow remote updates of clients. The base system of a Capsule Server is a client of Satellite Server and therefore must also have the Katello agent installed. +The {Project} Tools repository provides the `katello-agent` and `puppet` packages for clients registered to {ProjectServer}. Installing the Katello agent is recommended to allow remote updates of clients. The base system of a {SmartProxyServer} is a client of {ProjectServer} and therefore must also have the Katello agent installed. ifeval::["{mode}" == "disconnected"] .Prerequisites -* Ensure that you import all content ISO images that you require into Satellite Server. +* Ensure that you import all content ISO images that you require into {ProjectServer}. endif::[] .Procedure -To enable the Satellite Tools repository, complete the following steps: +To enable the {Project} Tools repository, complete the following steps: -. In the Satellite web UI, navigate to *Content* > *Red Hat Repositories*. +. In the {Project} web UI, navigate to *Content* > *Red Hat Repositories*. -. Use the Search field to enter the following repository name: *Red{nbsp}Hat Satellite Tools {ProductVersionRepoTitle} (for RHEL 7 Server) (RPMs)*. +. Use the Search field to enter the following repository name: *{ProjectName} Tools {ProductVersionRepoTitle} (for RHEL 7 Server) (RPMs)*. -. In the Available Repositories pane, click on *Red{nbsp}Hat Satellite Tools {ProductVersionRepoTitle} (for RHEL 7 Server) (RPMs)* to expand the repository set. +. In the Available Repositories pane, click on *{ProjectName} Tools {ProductVersionRepoTitle} (for RHEL 7 Server) (RPMs)* to expand the repository set. + -If the *Red{nbsp}Hat Satellite Tools {ProductVersionRepoTitle}* items are not visible, it may be because they are not included in the Subscription Manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the Subscription Manifest and import it into Satellite. +If the *{ProjectName} Tools {ProductVersionRepoTitle}* items are not visible, it may be because they are not included in the Subscription Manifest obtained from the Customer Portal. To correct that, log in to the Customer Portal, add these repositories, download the Subscription Manifest and import it into {Project}. . For the `x86_64` entry, click the *Enable* icon to enable the repository. -Enable the Satellite Tools repository for every supported major version of Red Hat Enterprise Linux running on your hosts. After enabling a Red Hat repository, a Product for this repository is automatically created. +Enable the {Project} Tools repository for every supported major version of Red Hat Enterprise Linux running on your hosts. After enabling a Red Hat repository, a Product for this repository is automatically created. .For CLI Users -Enable the Satellite Tools repository using the `hammer repository-set enable` command: +Enable the {Project} Tools repository using the `hammer repository-set enable` command: [options="nowrap" subs="+quotes,attributes"] ---- # hammer repository-set enable --organization _"initial_organization_name"_ \ diff --git a/guides/common/modules/hardware_storage_prerequisites.adoc b/guides/common/modules/hardware_storage_prerequisites.adoc index 7d33fd7749..e139bb3b61 100644 --- a/guides/common/modules/hardware_storage_prerequisites.adoc +++ b/guides/common/modules/hardware_storage_prerequisites.adoc @@ -1,7 +1,7 @@ [[hardware_storage_prerequisites]] = Storage Requirements and Guidelines -This section lists minimum storage requirements and provides storage guidelines for Satellite Server and Capsule Server installation. +This section lists minimum storage requirements and provides storage guidelines for {ProjectServer} and {SmartProxyServer} installation. == Storage Requirements @@ -9,7 +9,7 @@ The following table details storage requirements for specific directories. These The runtime size was measured with Red Hat Enterprise Linux 6, 7, and 8 repositories synchronized. -.Storage Requirements for a Connected Satellite Server Installation +.Storage Requirements for a Connected {ProjectServer} Installation [cols="1,1,1",options="header"] |==== |Directory |Installation Size |Runtime Size @@ -36,12 +36,12 @@ The runtime size was measured with Red Hat Enterprise Linux 6, 7, and 8 reposito == Storage Guidelines -Consider the following guidelines when installing Satellite Server to increase efficiency. +Consider the following guidelines when installing {ProjectServer} to increase efficiency. -* Because most Satellite and Capsule Server data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. +* Because most {Project} and {SmartProxyServer} data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. -* For the `/var/lib/pulp/` and `/var/lib/mongodb/` directories, use high-bandwidth, low-latency storage, and solid state drives (SSD) rather than hard disk drives (HDD). As Red{nbsp}Hat Satellite has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on Satellite 6 Operations] for more information on using the `fio` tool. +* For the `/var/lib/pulp/` and `/var/lib/mongodb/` directories, use high-bandwidth, low-latency storage, and solid state drives (SSD) rather than hard disk drives (HDD). As {ProjectName} has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on {ProjectX} Operations] for more information on using the `fio` tool. * The `/var/lib/qpidd/` directory uses slightly more than 2 MB per Content Host managed by the `goferd` service. For example, 10 000 Content Hosts require 20 GB of disk space in `/var/lib/qpidd/`. @@ -49,7 +49,7 @@ Consider the following guidelines when installing Satellite Server to increase e .File System Guidelines -* Use the XFS file system for Red{nbsp}Hat Satellite 6 because it does not have the inode limitations that `ext4` does. Because Satellite uses a lot of symbolic links it is likely that your system might run out of inodes if using `ext4` and the default number of inodes. +* Use the XFS file system for {ProjectNameX} because it does not have the inode limitations that `ext4` does. Because {Project} uses a lot of symbolic links it is likely that your system might run out of inodes if using `ext4` and the default number of inodes. * Do not use NFS with MongoDB because MongoDB does not use conventional I/O to access data files and performance problems occur when both the data files and the journal files are hosted on NFS. If required to use NFS, mount the volume with the following options in the `/etc/fstab` file: `bg`, `nolock`, and `noatime`. @@ -96,4 +96,4 @@ Write and execute permissions by the root user are required for installation to You cannot use symbolic links for `/var/lib/pulp/` and `/var/lib/mongodb/`, .Synchronized RHEL ISO -If you plan to synchronize RHEL content ISOs to Satellite, note that all minor versions of Red{nbsp}Hat Enterprise Linux also synchronize. You must plan to have adequate storage on your Satellite to manage this. +If you plan to synchronize RHEL content ISOs to {Project}, note that all minor versions of Red{nbsp}Hat Enterprise Linux also synchronize. You must plan to have adequate storage on your {Project} to manage this. diff --git a/guides/common/modules/hardware_storage_prerequisites_disconnected.adoc b/guides/common/modules/hardware_storage_prerequisites_disconnected.adoc index c2a5fe658f..39a40e3389 100644 --- a/guides/common/modules/hardware_storage_prerequisites_disconnected.adoc +++ b/guides/common/modules/hardware_storage_prerequisites_disconnected.adoc @@ -1,7 +1,7 @@ [[hardware_storage_prerequisites]] = Storage Requirements and Guidelines -This section lists minimum storage requirements and provides storage guidelines for Satellite Server and Capsule Server installation. +This section lists minimum storage requirements and provides storage guidelines for {ProjectServer} and {SmartProxyServer} installation. == Storage Requirements @@ -9,7 +9,7 @@ The following table details storage requirements for specific directories. These The runtime size was measured with Red Hat Enterprise Linux 6, 7, and 8 repositories synchronized. -.Storage Requirements for a Disconnected Satellite Server Installation +.Storage Requirements for a Disconnected {ProjectServer} Installation [cols="1,1,1",options="header"] |==== |Directory |Installation Size |Runtime Size @@ -37,14 +37,14 @@ The runtime size was measured with Red Hat Enterprise Linux 6, 7, and 8 reposito == Storage Guidelines -Consider the following guidelines when installing Satellite Server to increase efficiency. +Consider the following guidelines when installing {ProjectServer} to increase efficiency. -* Because most Satellite and Capsule Server data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. +* Because most {Project} and {SmartProxyServer} data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. * Using the same volume for the `/var/cache/pulp/` and `/var/lib/pulp/` directories can decrease the time required to move content from `/var/cache/pulp/` to `/var/lib/pulp/` after synchronizing. -* Use high-bandwidth, low-latency storage for the `/var/lib/pulp/` and `/var/lib/mongodb/` directories. As Red{nbsp}Hat Satellite has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on Satellite 6 Operations] for more information on using the `fio` tool. +* Use high-bandwidth, low-latency storage for the `/var/lib/pulp/` and `/var/lib/mongodb/` directories. As {ProjectName} has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on {ProjectX} Operations] for more information on using the `fio` tool. * For improved performance, use solid state drives (SSD) rather than hard disk drives (HDD). @@ -52,7 +52,7 @@ Consider the following guidelines when installing Satellite Server to increase e .File System Guidelines -* Use the XFS file system for Red{nbsp}Hat Satellite 6 because it does not have the inode limitations that `ext4` does. Because Satellite uses a lot of symbolic links it is likely that your system might run out of inodes if using `ext4` and the default number of inodes. +* Use the XFS file system for {ProjectNameX} because it does not have the inode limitations that `ext4` does. Because {Project} uses a lot of symbolic links it is likely that your system might run out of inodes if using `ext4` and the default number of inodes. * Do not use NFS with MongoDB because MongoDB does not use conventional I/O to access data files and performance problems occur when both the data files and the journal files are hosted on NFS. If required to use NFS, mount the volume with the following options in the `/etc/fstab` file: `bg`, `nolock`, and `noatime`. diff --git a/guides/common/modules/installing_overview.adoc b/guides/common/modules/installing_overview.adoc index 00f1f0896a..19407b7e85 100644 --- a/guides/common/modules/installing_overview.adoc +++ b/guides/common/modules/installing_overview.adoc @@ -1,13 +1,13 @@ [[installing_overview]] -You can use this chapter to find information about installing Red Hat Satellite Server, performing the initial configuration, creating and installing manifests, and performing additional configuration. +You can use this chapter to find information about installing {ProjectName} Server, performing the initial configuration, creating and installing manifests, and performing additional configuration. -There are two methods of installing Satellite Server: +There are two methods of installing {ProjectServer}: .Connected: -You can obtain the packages required to install Satellite Server directly from the Red Hat Content Delivery Network (CDN). Using the CDN ensures that your system always receives the latest updates. +You can obtain the packages required to install {ProjectServer} directly from the Red Hat Content Delivery Network (CDN). Using the CDN ensures that your system always receives the latest updates. .Disconnected: -You must use an external computer to download an ISO image of the packages and copy the packages to the system you want to install Satellite Server on. Use an ISO image only if you require a disconnected environment. The ISO image might not contain the latest updates. +You must use an external computer to download an ISO image of the packages and copy the packages to the system you want to install {ProjectServer} on. Use an ISO image only if you require a disconnected environment. The ISO image might not contain the latest updates. -NOTE: You cannot register Satellite Server to itself. +NOTE: You cannot register {ProjectServer} to itself. diff --git a/guides/common/modules/installing_satellite_connected_parent.adoc b/guides/common/modules/installing_satellite_connected_parent.adoc index cbe3bf13c4..1955ae2fb7 100644 --- a/guides/common/modules/installing_satellite_connected_parent.adoc +++ b/guides/common/modules/installing_satellite_connected_parent.adoc @@ -1,10 +1,10 @@ [[installing_satellite_connected_parent]] -= Installing Satellite Server from a Connected Network += Installing {ProjectServer} from a Connected Network -When you install Satellite Server from a connected network, you can obtain packages and receive updates directly from the Red Hat Content Delivery Network. +When you install {ProjectServer} from a connected network, you can obtain packages and receive updates directly from the Red Hat Content Delivery Network. -Note that the Satellite 6 installation script is based on Puppet, which means that if you run the installation script more than once, it might overwrite any manual configuration changes. +Note that the {ProjectX} installation script is based on Puppet, which means that if you run the installation script more than once, it might overwrite any manual configuration changes. ⁠ To avoid this and determine which future changes apply, use the `--noop` argument when you run the installation script. This argument ensures that no actual changes are made. Potential changes are written to `/var/log/foreman-installer.log`. diff --git a/guides/common/modules/installing_satellite_server_install_guide.adoc b/guides/common/modules/installing_satellite_server_install_guide.adoc index 7ed410a2f4..5ca36e29f6 100644 --- a/guides/common/modules/installing_satellite_server_install_guide.adoc +++ b/guides/common/modules/installing_satellite_server_install_guide.adoc @@ -1,8 +1,8 @@ [[installing_satellite_server_install_guide]] -= Installing the Satellite Server Packages += Installing the {ProjectServer} Packages -You must update all packages before installing the Satellite Server packages. After installation, you must perform the initial configuration of Satellite Server, including configuring server certificates, setting your user name, password, and the default organization and location. +You must update all packages before installing the {ProjectServer} packages. After installation, you must perform the initial configuration of {ProjectServer}, including configuring server certificates, setting your user name, password, and the default organization and location. . Update all packages: + @@ -11,7 +11,7 @@ You must update all packages before installing the Satellite Server packages. Af # yum update ---- -. Install the Satellite Server packages: +. Install the {ProjectServer} packages: + [options="nowrap"] ---- diff --git a/guides/common/modules/performing_initial_configuration_sat_server_answerfile.adoc b/guides/common/modules/performing_initial_configuration_sat_server_answerfile.adoc index a7ebb84776..dcf6a5f79c 100644 --- a/guides/common/modules/performing_initial_configuration_sat_server_answerfile.adoc +++ b/guides/common/modules/performing_initial_configuration_sat_server_answerfile.adoc @@ -1,11 +1,11 @@ [[performing_initial_configuration_sat_server_answerfile]] = Performing the Initial Configuration Automatically using an Answer File -You can use answer files to automate installations with customized options. The initial answer file is sparsely populated and after you run the `satellite-installer` script the first time, the answer file is populated with the standard parameter values for installation. You can change the configuration of Satellite Server at any time. +You can use answer files to automate installations with customized options. The initial answer file is sparsely populated and after you run the `{foreman-installer}` script the first time, the answer file is populated with the standard parameter values for installation. You can change the configuration of {ProjectServer} at any time. You should use the FQDN instead of the IP address where possible in case of network changes. -*Automatically configuring Satellite Server using an Answer File* +*Automatically configuring {ProjectServer} using an Answer File* . Copy the default answer file `/etc/foreman-installer/scenarios.d/satellite-answers.yaml` to a location on your local file system. + @@ -15,7 +15,7 @@ You should use the FQDN instead of the IP address where possible in case of netw /etc/foreman-installer/scenarios.d/__my-answer-file.yaml__ ---- -. To view all of the configurable options, enter the `satellite-installer --scenario satellite --help` command. +. To view all of the configurable options, enter the `{foreman-installer} --scenario satellite --help` command. . Open your copy of the answer file, edit the values to suit your environment, and save the file. @@ -26,11 +26,11 @@ You should use the FQDN instead of the IP address where possible in case of netw :answer_file: /etc/foreman-installer/scenarios.d/__my-answer-file.yaml__ ---- -. Run the `satellite-installer` script. +. Run the `{foreman-installer}` script. + -[options="nowrap", subs="+quotes"] +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite +# {foreman-installer} --scenario satellite ---- . If you have been installing in a disconnected environment, unmount the ISO images. diff --git a/guides/common/modules/performing_initial_configuration_sat_server_manual.adoc b/guides/common/modules/performing_initial_configuration_sat_server_manual.adoc index 4b0742ea5e..d193c77346 100644 --- a/guides/common/modules/performing_initial_configuration_sat_server_manual.adoc +++ b/guides/common/modules/performing_initial_configuration_sat_server_manual.adoc @@ -7,11 +7,11 @@ The installation process can take tens of minutes to complete. If you are connec .Considerations for Manual Configuration -Use the `satellite-installer --scenario satellite --help` command to display the available options and any default values. If you do not specify any values, the default values are used. +Use the `{foreman-installer} --scenario satellite --help` command to display the available options and any default values. If you do not specify any values, the default values are used. Specify a meaningful value for the option: `--foreman-initial-organization`. This can be your company name. An internal label that matches the value is also created and cannot be changed afterwards. If you do not specify a value, an organization called *Default Organization* with the label *Default_Organization* is created. You can rename the organization name but not the label. -By default, all configuration files configured by the installer are managed by Puppet. When `satellite-installer` runs, it overwrites any manual changes to the Puppet managed files with the initial values. By default, Satellite Server is installed with the Puppet agent running as a service. If required, you can disable Puppet agent on Satellite Server using the `--puppet-runmode=none` option. +By default, all configuration files configured by the installer are managed by Puppet. When `{foreman-installer}` runs, it overwrites any manual changes to the Puppet managed files with the initial values. By default, {ProjectServer} is installed with the Puppet agent running as a service. If required, you can disable Puppet agent on {ProjectServer} using the `--puppet-runmode=none` option. If you want to manage DNS files and DHCP files manually, use the `--foreman-proxy-dns-managed=false` and `--foreman-proxy-dhcp-managed=false` options so that Puppet does not manage the files related to the respective services. For more information on how to apply custom configuration on other services, see xref:applying_custom_configuration_to_red_hat_satellite[]. @@ -38,13 +38,13 @@ ExecStart=/usr/sbin/dhcpd -f -cf /etc/dhcp/dhcpd.conf -user dhcpd -group dhcpd - # systemctl restart dhcpd.service ---- -.Manually Configuring Satellite Server +.Manually Configuring {ProjectServer} To perform the initial configuration manually, enter the following command with any additional options that you want to use: -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite \ +# {foreman-installer} --scenario satellite \ --foreman-initial-organization "_initial_organization_name_" \ --foreman-initial-location "_initial_location_name_" \ --foreman-initial-admin-username _admin_user_name_ \ diff --git a/guides/common/modules/performing_initial_configuration_sat_server_manual_disconnected.adoc b/guides/common/modules/performing_initial_configuration_sat_server_manual_disconnected.adoc index c7c339a74b..4810b6ce9f 100644 --- a/guides/common/modules/performing_initial_configuration_sat_server_manual_disconnected.adoc +++ b/guides/common/modules/performing_initial_configuration_sat_server_manual_disconnected.adoc @@ -7,11 +7,11 @@ The installation process can take tens of minutes to complete. If you are connec .Considerations for Manual Configuration -Use the `satellite-installer --scenario satellite --help` command to display the available options and any default values. If you do not specify any values, the default values are used. +Use the `{foreman-installer} --scenario satellite --help` command to display the available options and any default values. If you do not specify any values, the default values are used. Specify a meaningful value for the option: `--foreman-initial-organization`. This can be your company name. An internal label that matches the value is also created and cannot be changed afterwards. If you do not specify a value, an organization called *Default Organization* with the label *Default_Organization* is created. You can rename the organization name but not the label. -By default, all configuration files configured by the installer are managed by Puppet. When `satellite-installer` runs, it overwrites any manual changes to the Puppet managed files with the initial values. By default, Satellite Server is installed with the Puppet agent running as a service. If required, you can disable Puppet agent on Satellite Server using the `--puppet-runmode=none` option. +By default, all configuration files configured by the installer are managed by Puppet. When `{foreman-installer}` runs, it overwrites any manual changes to the Puppet managed files with the initial values. By default, {ProjectServer} is installed with the Puppet agent running as a service. If required, you can disable Puppet agent on {ProjectServer} using the `--puppet-runmode=none` option. If you want to manage DNS files and DHCP files manually, use the `--foreman-proxy-dns-managed=false` and `--foreman-proxy-dhcp-managed=false` options so that Puppet does not manage the files related to the respective services. For more information on how to apply custom configuration on other services, see xref:applying_custom_configuration_to_red_hat_satellite[]. @@ -38,13 +38,13 @@ ExecStart=/usr/sbin/dhcpd -f -cf /etc/dhcp/dhcpd.conf -user dhcpd -group dhcpd - # systemctl restart dhcpd.service ---- -.Manually Configuring Satellite Server +.Manually Configuring {ProjectServer} To perform the initial configuration manually, enter the following command with any additional options that you want to use: -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite \ +# {foreman-installer} --scenario satellite \ --foreman-initial-organization "_initial_organization_name_" \ --foreman-initial-location "_initial_location_name_" \ --foreman-initial-admin-username _admin_user_name_ \ diff --git a/guides/common/modules/performing_initial_configuration_sat_server_parent.adoc b/guides/common/modules/performing_initial_configuration_sat_server_parent.adoc index 1a7590fb3e..8c6222707c 100644 --- a/guides/common/modules/performing_initial_configuration_sat_server_parent.adoc +++ b/guides/common/modules/performing_initial_configuration_sat_server_parent.adoc @@ -2,6 +2,6 @@ = Performing the Initial Configuration -This section details how to perform the initial configuration of the host operating system when installing Red Hat Satellite Server. This includes synchronizing the time, installing the *sos* package, and specifying an installation option. +This section details how to perform the initial configuration of the host operating system when installing {ProjectName} Server. This includes synchronizing the time, installing the *sos* package, and specifying an installation option. -Before you continue, consider which manifests or packages are relevant for your environment. For more information on manifests, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/managing_subscriptions/[Managing Subscriptions] in the _Red Hat Satellite Content Management Guide_. +Before you continue, consider which manifests or packages are relevant for your environment. For more information on manifests, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/managing_subscriptions/[Managing Subscriptions] in the _{ProjectName} Content Management Guide_. diff --git a/guides/common/modules/ports_prerequisites.adoc b/guides/common/modules/ports_prerequisites.adoc index 2a888f828c..7a19362ad7 100644 --- a/guides/common/modules/ports_prerequisites.adoc +++ b/guides/common/modules/ports_prerequisites.adoc @@ -2,50 +2,50 @@ The following tables indicate the destination port and the direction of network traffic: -.Ports for Satellite to Red Hat CDN Communication +.Ports for {Project} to Red Hat CDN Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For | 443 | TCP | HTTPS | Subscription Management Services (access.redhat.com) and connecting to the Red{nbsp}Hat CDN (cdn.redhat.com). |==== -Except in the case of a disconnected Satellite, Satellite Server needs access to the Red{nbsp}Hat CDN. For a list of IP addresses used by the Red{nbsp}Hat CDN (cdn.redhat.com), see the Knowledgebase article https://access.redhat.com/articles/1525183[Public CIDR Lists for Red Hat] on the Red{nbsp}Hat Customer Portal. +Except in the case of a disconnected {Project}, {ProjectServer} needs access to the Red{nbsp}Hat CDN. For a list of IP addresses used by the Red{nbsp}Hat CDN (cdn.redhat.com), see the Knowledgebase article https://access.redhat.com/articles/1525183[Public CIDR Lists for Red Hat] on the Red{nbsp}Hat Customer Portal. -.Ports for Browser-based User Interface Access to Satellite +.Ports for Browser-based User Interface Access to {Project} [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For -| 443 | TCP | HTTPS | Browser-based UI access to Satellite -| 80 | TCP | HTTP | Redirection to HTTPS for web UI access to Satellite (Optional) +| 443 | TCP | HTTPS | Browser-based UI access to {Project} +| 80 | TCP | HTTP | Redirection to HTTPS for web UI access to {Project} (Optional) |==== -.Ports for Client to Satellite Communication +.Ports for Client to {Project} Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For | 80 | TCP | HTTP | Anaconda, yum, for obtaining Katello certificates, templates, and for downloading iPXE firmware | 443 | TCP | HTTPS | Subscription Management Services, yum, Telemetry Services, and for connection to the Katello Agent -| 5647 | TCP | amqp | Katello Agent to communicate with Satellite's Qpid dispatch router +| 5647 | TCP | amqp | Katello Agent to communicate with {Project}'s Qpid dispatch router | 8000 | TCP | HTTP | Anaconda to download kickstart templates to hosts, and for downloading iPXE firmware | 8140 | TCP | HTTPS | Puppet agent to Puppet master connections | 9090 | TCP | HTTPS | Sending SCAP reports to the Smart Proxy in the -integrated Capsule, for the discovery image during provisioning, -and for communicating with Satellite Server to copy the SSH keys for Remote Execution (Rex) configuration -| 7 | TCP and UDP | ICMP | External DHCP on a Client to Satellite network, ICMP ECHO to verify IP address is free (Optional) -| 53 | TCP and UDP | DNS | Client DNS queries to a Satellite's integrated Capsule DNS service (Optional) -| 67 | UDP | DHCP | Client to Satellite's integrated Capsule broadcasts, DHCP broadcasts for Client provisioning from a Satellite's integrated Capsule (Optional) -| 69 | UDP |TFTP | Clients downloading PXE boot image files from a Satellites' integrated Capsule for provisioning (Optional) +integrated {SmartProxy}, for the discovery image during provisioning, +and for communicating with {ProjectServer} to copy the SSH keys for Remote Execution (Rex) configuration +| 7 | TCP and UDP | ICMP | External DHCP on a Client to {Project} network, ICMP ECHO to verify IP address is free (Optional) +| 53 | TCP and UDP | DNS | Client DNS queries to a {Project}'s integrated {SmartProxy} DNS service (Optional) +| 67 | UDP | DHCP | Client to {Project}'s integrated {SmartProxy} broadcasts, DHCP broadcasts for Client provisioning from a {Project}'s integrated {SmartProxy} (Optional) +| 69 | UDP |TFTP | Clients downloading PXE boot image files from a {Project}s' integrated {SmartProxy} for provisioning (Optional) | 5000 | TCP | HTTPS | Connection to Katello for the Docker registry (Optional) |==== -Any managed host that is directly connected to Satellite Server is a client in this context because it is a client of the integrated Capsule. This includes the base system on which a Capsule Server is running. +Any managed host that is directly connected to {ProjectServer} is a client in this context because it is a client of the integrated {SmartProxy}. This includes the base system on which a {SmartProxyServer} is running. -.Ports for Satellite to Capsule Communication +.Ports for {Project} to {SmartProxy} Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required for -| 443 | TCP | HTTPS | Connections to the Pulp server in the Capsule -| 9090 | TCP | HTTPS | Connections to the proxy in the Capsule +| 443 | TCP | HTTPS | Connections to the Pulp server in the {SmartProxy} +| 9090 | TCP | HTTPS | Connections to the proxy in the {SmartProxy} | 80 | TCP | HTTP | Downloading a bootdisk (Optional) |==== @@ -54,10 +54,10 @@ Any managed host that is directly connected to Satellite Server is a client in t [cols="24%,20%,18%,38%a",options="header"] |==== | Port | Protocol | Service | Required For -| 22 | TCP | SSH | Satellite and Capsule originated communications, for Remote Execution (Rex) and Ansible. -| 443 | TCP | HTTPS | Satellite originated communications, for vCenter compute resource. -| 5000 | TCP | HTTP | Satellite originated communications, for compute resources in OpenStack or for running containers. -| 22, 16514 | TCP | SSH, SSL/TLS | Satellite originated communications, for compute resources in libvirt. -| 389, 636 | TCP | LDAP, LDAPS | Satellite originated communications, for LDAP and secured LDAP authentication sources. -| 5900 to 5930 | TCP | SSL/TLS | Satellite originated communications, for NoVNC console in web UI to hypervisors. +| 22 | TCP | SSH | {Project} and {SmartProxy} originated communications, for Remote Execution (Rex) and Ansible. +| 443 | TCP | HTTPS | {Project} originated communications, for vCenter compute resource. +| 5000 | TCP | HTTP | {Project} originated communications, for compute resources in OpenStack or for running containers. +| 22, 16514 | TCP | SSH, SSL/TLS | {Project} originated communications, for compute resources in libvirt. +| 389, 636 | TCP | LDAP, LDAPS | {Project} originated communications, for LDAP and secured LDAP authentication sources. +| 5900 to 5930 | TCP | SSL/TLS | {Project} originated communications, for NoVNC console in web UI to hypervisors. |==== diff --git a/guides/common/modules/ports_prerequisites_satellite_disconnected.adoc b/guides/common/modules/ports_prerequisites_satellite_disconnected.adoc index ce233ef009..30c78c8026 100644 --- a/guides/common/modules/ports_prerequisites_satellite_disconnected.adoc +++ b/guides/common/modules/ports_prerequisites_satellite_disconnected.adoc @@ -2,40 +2,40 @@ The following tables indicate the destination port and the direction of network traffic: -.Ports for Browser-based User Interface Access to Satellite +.Ports for Browser-based User Interface Access to {Project} [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For -| 443 | TCP | HTTPS | Browser-based UI access to Satellite -| 80 | TCP | HTTP | Redirection to HTTPS for web UI access to Satellite (Optional) +| 443 | TCP | HTTPS | Browser-based UI access to {Project} +| 80 | TCP | HTTP | Redirection to HTTPS for web UI access to {Project} (Optional) |==== -.Ports for Client to Satellite Communication +.Ports for Client to {Project} Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For | 80 | TCP | HTTP | Anaconda, yum, for obtaining Katello certificates, templates, and for downloading iPXE firmware | 443 | TCP | HTTPS | Subscription Management Services, yum, Telemetry Services, and for connection to the Katello Agent -| 5647 | TCP | amqp | Katello Agent to communicate with Satellite's Qpid dispatch router +| 5647 | TCP | amqp | Katello Agent to communicate with {Project}'s Qpid dispatch router | 8000 | TCP | HTTP | Anaconda to download kickstart templates to hosts, and for downloading iPXE firmware | 8140 | TCP | HTTPS | Puppet agent to Puppet master connections | 9090 | TCP | HTTPS | Sending SCAP reports to the Smart Proxy in the -integrated Capsule, for the discovery image during provisioning, -and for communicating with Satellite Server to copy the SSH keys for Remote Execution (Rex) configuration -| 53 | TCP and UDP | DNS | Client DNS queries to a Satellite's integrated Capsule DNS service (Optional) -| 67 | UDP | DHCP | Client to Satellite's integrated Capsule broadcasts, DHCP broadcasts for Client provisioning from a Satellite's integrated Capsule (Optional) -| 69 | UDP |TFTP | Clients downloading PXE boot image files from a Satellites' integrated Capsule for provisioning (Optional) +integrated {SmartProxy}, for the discovery image during provisioning, +and for communicating with {ProjectServer} to copy the SSH keys for Remote Execution (Rex) configuration +| 53 | TCP and UDP | DNS | Client DNS queries to a {Project}'s integrated {SmartProxy} DNS service (Optional) +| 67 | UDP | DHCP | Client to {Project}'s integrated {SmartProxy} broadcasts, DHCP broadcasts for Client provisioning from a {Project}'s integrated {SmartProxy} (Optional) +| 69 | UDP |TFTP | Clients downloading PXE boot image files from a {Project}s' integrated {SmartProxy} for provisioning (Optional) | 5000 | TCP | HTTPS | Connection to Katello for the Docker registry (Optional) |==== -Any managed host that is directly connected to Satellite Server is a client in this context because it is a client of the integrated Capsule. This includes the base system on which a Capsule Server is running. +Any managed host that is directly connected to {ProjectServer} is a client in this context because it is a client of the integrated {SmartProxy}. This includes the base system on which a {SmartProxyServer} is running. -.Ports for Satellite to Capsule Communication +.Ports for {Project} to {SmartProxy} Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required for -| 443 | TCP | HTTPS | Connections to the Pulp server in the Capsule -| 9090 | TCP | HTTPS | Connections to the proxy in the Capsule +| 443 | TCP | HTTPS | Connections to the Pulp server in the {SmartProxy} +| 9090 | TCP | HTTPS | Connections to the proxy in the {SmartProxy} | 80 | TCP | HTTP | Downloading a bootdisk (Optional) |==== @@ -43,10 +43,10 @@ Any managed host that is directly connected to Satellite Server is a client in t [cols="24%,20%,18%,38%a",options="header"] |==== | Port | Protocol | Service | Required For -| 22 | TCP | SSH | Satellite and Capsule originated communications, for Remote Execution (Rex) and Ansible. -| 443 | TCP | HTTPS | Satellite originated communications, for vCenter compute resource. -| 5000 | TCP | HTTP | Satellite originated communications, for compute resources in OpenStack or for running containers. -| 22, 16514 | TCP | SSH, SSL/TLS | Satellite originated communications, for compute resources in libvirt. -| 389, 636 | TCP | LDAP, LDAPS | Satellite originated communications, for LDAP and secured LDAP authentication sources. -| 5900 to 5930 | TCP | SSL/TLS | Satellite originated communications, for NoVNC console in web UI to hypervisors. +| 22 | TCP | SSH | {Project} and {SmartProxy} originated communications, for Remote Execution (Rex) and Ansible. +| 443 | TCP | HTTPS | {Project} originated communications, for vCenter compute resource. +| 5000 | TCP | HTTP | {Project} originated communications, for compute resources in OpenStack or for running containers. +| 22, 16514 | TCP | SSH, SSL/TLS | {Project} originated communications, for compute resources in libvirt. +| 389, 636 | TCP | LDAP, LDAPS | {Project} originated communications, for LDAP and secured LDAP authentication sources. +| 5900 to 5930 | TCP | SSL/TLS | {Project} originated communications, for NoVNC console in web UI to hypervisors. |==== diff --git a/guides/common/modules/proc_adding-life-cycle-environments.adoc b/guides/common/modules/proc_adding-life-cycle-environments.adoc index 3d38bff8ab..d89292bfcc 100644 --- a/guides/common/modules/proc_adding-life-cycle-environments.adoc +++ b/guides/common/modules/proc_adding-life-cycle-environments.adoc @@ -1,35 +1,35 @@ [id="adding-life-cycle-environments_{context}"] -= Adding Life Cycle Environments to Capsule Servers += Adding Life Cycle Environments to {SmartProxyServer}s -If your Capsule Server has the content functionality enabled, you must add an environment so that Capsule can synchronize content from Satellite Server and provide content to host systems. +If your {SmartProxyServer} has the content functionality enabled, you must add an environment so that {SmartProxy} can synchronize content from {ProjectServer} and provide content to host systems. -Do not assign the _Library_ lifecycle environment to your Capsule Server because it triggers an automated Capsule sync every time the CDN updates a repository. This might consume multiple system resources on Capsules, network bandwidth between Satellite and Capsules, and available disk space on Capsules. +Do not assign the _Library_ lifecycle environment to your {SmartProxyServer} because it triggers an automated {SmartProxy} sync every time the CDN updates a repository. This might consume multiple system resources on {SmartProxies}, network bandwidth between {Project} and {SmartProxies}, and available disk space on {SmartProxies}. -You can use Hammer CLI on Satellite Server or the Satellite web UI. +You can use Hammer CLI on {ProjectServer} or the {Project} web UI. .Procedure -To add a life cycle environment to Capsule Server, complete the following steps: +To add a life cycle environment to {SmartProxyServer}, complete the following steps: -. In the Satellite web UI, navigate to *Infrastructure* > *Capsules*, and select the Capsule that you want to add a life cycle to. +. In the {Project} web UI, navigate to *Infrastructure* > *{SmartProxies}*, and select the {SmartProxy} that you want to add a life cycle to. . Click *Edit* and click the *Life Cycle Environments* tab. -. From the left menu, select the life cycle environments that you want to add to Capsule and click *Submit*. -. To synchronize the content on the Capsule, click the *Overview* tab and click *Synchronize*. +. From the left menu, select the life cycle environments that you want to add to {SmartProxy} and click *Submit*. +. To synchronize the content on the {SmartProxy}, click the *Overview* tab and click *Synchronize*. . Select either *Optimized Sync* or *Complete Sync*. .For CLI Users -. To display a list of all Capsule Servers, on Satellite Server, enter the following command: +. To display a list of all {SmartProxyServer}s, on {ProjectServer}, enter the following command: + [options="nowrap"] ---- # hammer capsule list ---- + -Note the Capsule ID of the Capsule that you want to add a life cycle to. +Note the {SmartProxy} ID of the {SmartProxy} that you want to add a life cycle to. + -. Using the ID, verify the details of your Capsule: +. Using the ID, verify the details of your {SmartProxy}: + [options="nowrap" subs="+quotes"] ---- @@ -44,14 +44,14 @@ Note the Capsule ID of the Capsule that you want to add a life cycle to. --id _capsule_id_ ---- + -. To view the life cycle environments available for your Capsule Server, enter the following command and note the ID and the organization name: +. To view the life cycle environments available for your {SmartProxyServer}, enter the following command and note the ID and the organization name: + [options="nowrap" subs="+quotes"] ---- # hammer capsule content available-lifecycle-environments --id _capsule_id_ ---- + -. Add the life cycle environment to your Capsule Server: +. Add the life cycle environment to your {SmartProxyServer}: + [options="nowrap" subs="+quotes"] ---- @@ -60,18 +60,18 @@ Note the Capsule ID of the Capsule that you want to add a life cycle to. --environment-id _environment_id_ ---- + -Repeat for each life cycle environment you want to add to Capsule Server. +Repeat for each life cycle environment you want to add to {SmartProxyServer}. + -. Synchronize the content from Satellite to Capsule. +. Synchronize the content from {Project} to {SmartProxy}. + -* To synchronize all content from your Satellite Server environment to Capsule Server, enter the following command: +* To synchronize all content from your {ProjectServer} environment to {SmartProxyServer}, enter the following command: + [options="nowrap" subs="+quotes"] ---- # hammer capsule content synchronize --id _capsule_id_ ---- + -* To synchronize a specific life cycle environment from your Satellite Server to Capsule Server, enter the following command: +* To synchronize a specific life cycle environment from your {ProjectServer} to {SmartProxyServer}, enter the following command: + [options="nowrap" subs="+quotes"] ---- diff --git a/guides/common/modules/proc_attaching-satellite-infrastructure-subscription.adoc b/guides/common/modules/proc_attaching-satellite-infrastructure-subscription.adoc index 268f480022..0f2757a034 100644 --- a/guides/common/modules/proc_attaching-satellite-infrastructure-subscription.adoc +++ b/guides/common/modules/proc_attaching-satellite-infrastructure-subscription.adoc @@ -1,17 +1,17 @@ [id="attaching-satellite-infrastructure-subscription_{context}"] -= Attaching the Satellite Infrastructure Subscription += Attaching the {Project} Infrastructure Subscription -After you have registered {ProductName}, you must identify your subscription Pool ID and attach an available subscription. The Red Hat Satellite Infrastructure subscription provides access to the Red{nbsp}Hat Satellite, Red{nbsp}Hat Enterprise Linux, and Red{nbsp}Hat Software Collections (RHSCL) content. This is the only subscription required. +After you have registered {ProductName}, you must identify your subscription Pool ID and attach an available subscription. The {ProjectName} Infrastructure subscription provides access to the {ProjectName}, Red{nbsp}Hat Enterprise Linux, and Red{nbsp}Hat Software Collections (RHSCL) content. This is the only subscription required. -Red Hat Satellite Infrastructure is included with all subscriptions that include Smart Management. For more information, see the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3382781[Satellite Infrastructure Subscriptions MCT3718 MCT3719]. +{ProjectName} Infrastructure is included with all subscriptions that include Smart Management. For more information, see the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3382781[{Project} Infrastructure Subscriptions MCT3718 MCT3719]. -Subscriptions are classified as available if they are not already attached to a system. If you are unable to find an available Satellite subscription, see the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/2058823[How do I figure out which subscriptions have been consumed by clients registered under Red Hat Subscription Manager?] to run a script to see if your subscription is being consumed by another system. +Subscriptions are classified as available if they are not already attached to a system. If you are unable to find an available {Project} subscription, see the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/2058823[How do I figure out which subscriptions have been consumed by clients registered under Red Hat Subscription Manager?] to run a script to see if your subscription is being consumed by another system. .Procedure -To attach the Satellite Infrastructure subscription, complete the following steps: +To attach the {Project} Infrastructure subscription, complete the following steps: -. Identify the Pool ID of the Satellite Infrastructure subscription: +. Identify the Pool ID of the {Project} Infrastructure subscription: + [options="nowrap"] ---- @@ -53,7 +53,7 @@ System Type: Physical . Make a note of the subscription Pool ID. Your subscription Pool ID is different from the example provided. -. Attach the Satellite Infrastructure subscription to the base system that your {ProductName} is running on: +. Attach the {Project} Infrastructure subscription to the base system that your {ProductName} is running on: + [options="nowrap" subs="+quotes"] ---- @@ -67,7 +67,7 @@ The command displays output similar to the following: Successfully attached a subscription for: Red Hat Satellite Infrastructure Subscription ---- -. Optional: Verify that the Satellite Infrastructure subscription is attached: +. Optional: Verify that the {Project} Infrastructure subscription is attached: + [options="nowrap"] ---- diff --git a/guides/common/modules/proc_configuring-an-external-dhcp-server.adoc b/guides/common/modules/proc_configuring-an-external-dhcp-server.adoc index de3d546797..3749d0ab6b 100644 --- a/guides/common/modules/proc_configuring-an-external-dhcp-server.adoc +++ b/guides/common/modules/proc_configuring-an-external-dhcp-server.adoc @@ -57,14 +57,14 @@ key omapi_key { omapi-key omapi_key; ---- + -Note that the `option routers` value is the Satellite or Capsule IP address that you want to use with an external DHCP service. +Note that the `option routers` value is the {Project} or {SmartProxy} IP address that you want to use with an external DHCP service. . Delete the two key files from the directory that they were created in. -. On Satellite Server, define each subnet. Do not set DHCP Capsule for the defined Subnet yet. +. On {ProjectServer}, define each subnet. Do not set DHCP {SmartProxy} for the defined Subnet yet. + To prevent conflicts, set up the lease and reservation ranges separately. -For example, if the lease range is 192.168.38.10 to 192.168.38.100, in the Satellite web UI define the reservation range as 192.168.38.101 to 192.168.38.250. +For example, if the lease range is 192.168.38.10 to 192.168.38.100, in the {Project} web UI define the reservation range as 192.168.38.101 to 192.168.38.250. . Configure the firewall for external access to the DHCP server: + @@ -74,7 +74,7 @@ For example, if the lease range is 192.168.38.10 to 192.168.38.100, in the Satel && firewall-cmd --runtime-to-permanent ---- -. On Satellite Server, determine the UID and GID of the `foreman` user: +. On {ProjectServer}, determine the UID and GID of the `foreman` user: + [options="nowrap" subs="+quotes"] ---- @@ -150,7 +150,7 @@ _990_ /exports/var/lib/dhcpd _192.168.38.1_(ro,async,no_root_squash,no_subtree_check,nohide) ---- + -Note that the IP address that you enter is the Satellite or Capsule IP address that you want to use with an external DHCP service. +Note that the IP address that you enter is the {Project} or {SmartProxy} IP address that you want to use with an external DHCP service. . Reload the NFS server: + diff --git a/guides/common/modules/proc_configuring-capsule-default-certificate.adoc b/guides/common/modules/proc_configuring-capsule-default-certificate.adoc index c52f92dd1f..7a3ce87319 100644 --- a/guides/common/modules/proc_configuring-capsule-default-certificate.adoc +++ b/guides/common/modules/proc_configuring-capsule-default-certificate.adoc @@ -1,28 +1,28 @@ [id="configuring-capsule-default-certificate_{context}"] -= Configuring Capsule Server with a Default SSL Certificate += Configuring {SmartProxyServer} with a Default SSL Certificate -Use this section to configure Capsule Server with an SSL certificate that is signed by the Satellite Server default Certificate Authority (CA). +Use this section to configure {SmartProxyServer} with an SSL certificate that is signed by the {ProjectServer} default Certificate Authority (CA). .Prerequisites -Before configuring Capsule Server with a default server certificate, ensure that your Capsule Server meets the following conditions: +Before configuring {SmartProxyServer} with a default server certificate, ensure that your {SmartProxyServer} meets the following conditions: -* Capsule{nbsp}Server is registered to Satellite{nbsp}Server. For more information, see xref:registering-to-satellite-server_capsule[]. -* The Capsule{nbsp}Server packages are installed. For more information, see xref:installing-capsule-server-packages_capsule[]. +* {SmartProxyServer} is registered to {ProjectServer}. For more information, see xref:registering-to-satellite-server_capsule[]. +* The {SmartProxyServer} packages are installed. For more information, see xref:installing-capsule-server-packages_capsule[]. .Procedure -To configure Capsule Server with a default server certificate, complete the following steps: +To configure {SmartProxyServer} with a default server certificate, complete the following steps: -. On Satellite{nbsp}Server, to store all the source certificate files for your Capsule Server, create a directory that is accessible only to the `root` user, for example `/root/capsule_cert`: +. On {ProjectServer}, to store all the source certificate files for your {SmartProxyServer}, create a directory that is accessible only to the `root` user, for example `/root/capsule_cert`: + [options="nowrap", subs="+quotes"] ---- # mkdir /root/capsule_cert ---- -. On Satellite Server, generate the `_/root/capsule_cert/capsule_certs.tar_` certificate archive for your Capsule{nbsp}Server: +. On {ProjectServer}, generate the `_/root/capsule_cert/capsule_certs.tar_` certificate archive for your {SmartProxyServer}: + [options="nowrap" subs="+quotes"] ---- @@ -31,9 +31,9 @@ To configure Capsule Server with a default server certificate, complete the foll --certs-tar _/root/capsule_cert/capsule_certs.tar_ ---- + -Retain a copy of the `satellite-installer` command that the `capsule-certs-generate` command returns for deploying the certificate to your Capsule{nbsp}Server. +Retain a copy of the `{foreman-installer}` command that the `capsule-certs-generate` command returns for deploying the certificate to your {SmartProxyServer}. -. On Satellite{nbsp}Server, copy the certificate archive file to your Capsule{nbsp}Server: +. On {ProjectServer}, copy the certificate archive file to your {SmartProxyServer}: + [options="nowrap", subs="+quotes"] ---- @@ -41,8 +41,8 @@ Retain a copy of the `satellite-installer` command that the `capsule-certs-gener root@_capsule.example.com_:/root/_capsule.example.com_-certs.tar ---- -. On Capsule{nbsp}Server, to deploy the certificate, enter the `satellite-installer` command that the `capsule-certs-generate` command returns. +. On {SmartProxyServer}, to deploy the certificate, enter the `{foreman-installer}` command that the `capsule-certs-generate` command returns. + -When network connections or ports to Satellite are not yet open, you can set the `--foreman-proxy-register-in-foreman` option to `false` to prevent Capsule from attempting to connect to Satellite and reporting errors. Run the installer again with this option set to `true` when the network and firewalls are correctly configured. +When network connections or ports to {Project} are not yet open, you can set the `--foreman-proxy-register-in-foreman` option to `false` to prevent {SmartProxy} from attempting to connect to {Project} and reporting errors. Run the installer again with this option set to `true` when the network and firewalls are correctly configured. + -IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading Capsule Server. +IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading {SmartProxyServer}. diff --git a/guides/common/modules/proc_configuring-capsule-server-with-external-dns.adoc b/guides/common/modules/proc_configuring-capsule-server-with-external-dns.adoc index dacb65a80c..bd93f42b5b 100644 --- a/guides/common/modules/proc_configuring-capsule-server-with-external-dns.adoc +++ b/guides/common/modules/proc_configuring-capsule-server-with-external-dns.adoc @@ -1,19 +1,19 @@ [id="configuring-capsule-server-with-external-dns_{context}"] -= Configuring Capsule Server with External DNS += Configuring {SmartProxyServer} with External DNS -You can configure Capsule Server with external DNS. Capsule uses the `nsupdate` utility to update DNS records on the remote server. +You can configure {SmartProxyServer} with external DNS. {SmartProxy} uses the `nsupdate` utility to update DNS records on the remote server. -To make any changes persistent, you must enter the `satellite-installer` command with the options appropriate for your environment. +To make any changes persistent, you must enter the `{foreman-installer}` command with the options appropriate for your environment. .Prerequisites -Before you can configure Capsule Server with external DNS, ensure that the following conditions are met: +Before you can configure {SmartProxyServer} with external DNS, ensure that the following conditions are met: * You must have a configured external DNS server. .Procedure -To configure Capsule Server with external DNS, complete the following steps: +To configure {SmartProxyServer} with external DNS, complete the following steps: . Install the `bind-utils` package: + @@ -22,7 +22,7 @@ To configure Capsule Server with external DNS, complete the following steps: # yum install bind bind-utils ---- -. Copy the `/etc/rndc.key` file from the external DNS server to Capsule Server: +. Copy the `/etc/rndc.key` file from the external DNS server to {SmartProxyServer}: + [options="nowrap" subs="+quotes"] ---- @@ -51,11 +51,11 @@ update delete aaa.virtual.lan 3600 IN A _Host_IP_Address_\n \ send\n" | nsupdate -k /etc/rndc.key ---- -. Enter the `satellite-installer` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/dns.yml` file: +. Enter the `{foreman-installer}` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/dns.yml` file: + -[options="nowrap"] +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-dns=true \ +# {foreman-installer} --foreman-proxy-dns=true \ --foreman-proxy-dns-managed=false \ --foreman-proxy-dns-provider=nsupdate \ --foreman-proxy-dns-server="_DNS_IP_Address_" \ @@ -70,8 +70,8 @@ send\n" | nsupdate -k /etc/rndc.key # systemctl restart foreman-proxy ---- -. Log in to the Satellite Server web UI and navigate to *Infrastructure* > *Capsules*. +. Log in to the {ProjectServer} web UI and navigate to *Infrastructure* > *{SmartProxies}*. -. Locate the Capsule Server that you want to configure with external DNS and from the list in the *Actions* column, select *Refresh*. +. Locate the {SmartProxyServer} that you want to configure with external DNS and from the list in the *Actions* column, select *Refresh*. . Associate the DNS service with the appropriate subnets and domain. diff --git a/guides/common/modules/proc_configuring-capsule-server-with-external-tftp.adoc b/guides/common/modules/proc_configuring-capsule-server-with-external-tftp.adoc index c1bc91d0d4..f4c34c95cf 100644 --- a/guides/common/modules/proc_configuring-capsule-server-with-external-tftp.adoc +++ b/guides/common/modules/proc_configuring-capsule-server-with-external-tftp.adoc @@ -1,11 +1,11 @@ [id="configuring-capsule-server-with-external-tftp_{context}"] -= Configuring Capsule Server with External TFTP += Configuring {SmartProxyServer} with External TFTP -You can configure Capsule Server with external TFTP services. +You can configure {SmartProxyServer} with external TFTP services. .Procedure -To configure Capsule Server with external TFTP, complete the following steps: +To configure {SmartProxyServer} with external TFTP, complete the following steps: . Create the TFTP directory for NFS: + @@ -28,23 +28,23 @@ _TFTP_Server_IP_Address_:/exports/var/lib/tftpboot /mnt/nfs/var/lib/tftpboot nfs # mount -a ---- -. Enter the `satellite-installer` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/tftp.yml` file: +. Enter the `{foreman-installer}` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/tftp.yml` file: + -[options="nowrap"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-tftp=true \ +# {foreman-installer} --foreman-proxy-tftp=true \ --foreman-proxy-tftp-root /mnt/nfs/var/lib/tftpboot ---- . If the TFTP service is running on a different server than the DHCP service, update the `tftp_servername` setting with the FQDN or IP address of the server that the TFTP service is running on: + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-tftp-servername=_TFTP_Server_FQDN_ +# {foreman-installer} --foreman-proxy-tftp-servername=_TFTP_Server_FQDN_ ---- -. Log in to the Satellite Server web UI. +. Log in to the {ProjectServer} web UI. -. Navigate to *Infrastructure* > *Capsules*. Locate the appropriate Capsule Server and from the list in the *Actions* column, select *Refresh*. +. Navigate to *Infrastructure* > *{SmartProxies}*. Locate the appropriate {SmartProxyServer} and from the list in the *Actions* column, select *Refresh*. . Associate the TFTP service with the appropriate subnets and domain. diff --git a/guides/common/modules/proc_configuring-dns-dhcp-and-tftp.adoc b/guides/common/modules/proc_configuring-dns-dhcp-and-tftp.adoc index 75a83cead2..8fab867dc7 100644 --- a/guides/common/modules/proc_configuring-dns-dhcp-and-tftp.adoc +++ b/guides/common/modules/proc_configuring-dns-dhcp-and-tftp.adoc @@ -2,11 +2,11 @@ = Configuring DNS, DHCP, and TFTP on {ProductName} -To configure the DNS, DHCP, and TFTP services on {ProductName}, use the `satellite-installer` command with the options appropriate for your environment. +To configure the DNS, DHCP, and TFTP services on {ProductName}, use the `{foreman-installer}` command with the options appropriate for your environment. -To view a complete list of configurable options, enter the `satellite-installer --scenario satellite --help` command. +To view a complete list of configurable options, enter the `{foreman-installer} --scenario satellite --help` command. -Any changes to the settings require entering the `satellite-installer` command again. You can enter the command multiple times and each time it updates all configuration files with the changed values. +Any changes to the settings require entering the `{foreman-installer}` command again. You can enter the command multiple times and each time it updates all configuration files with the changed values. .Prerequisites @@ -32,13 +32,13 @@ endif::[] .Procedure -* Enter the `satellite-installer` command with the options appropriate for your environment. The following example shows configuring full provisioning services: +* Enter the `{foreman-installer}` command with the options appropriate for your environment. The following example shows configuring full provisioning services: ifeval::["{context}" == "satellite"] + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario satellite \ +# {foreman-installer} --scenario satellite \ --foreman-proxy-dns true \ --foreman-proxy-dns-managed true \ --foreman-proxy-dns-interface __eth0__ \ @@ -56,14 +56,14 @@ ifeval::["{context}" == "satellite"] --foreman-proxy-tftp-servername $(hostname) ---- -You can monitor the progress of the `satellite-installer` command displayed in your prompt. You can view the logs in `/var/log/foreman-installer/satellite.log`. You can view the settings used, including the `admin_password` parameter, in the `/etc/foreman-installer/scenarios.d/satellite-answers.yaml` file. +You can monitor the progress of the `{foreman-installer}` command displayed in your prompt. You can view the logs in `/var/log/foreman-installer/satellite.log`. You can view the settings used, including the `admin_password` parameter, in the `/etc/foreman-installer/scenarios.d/satellite-answers.yaml` file. endif::[] ifeval::["{context}" == "capsule"] + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --scenario capsule \ +# {foreman-installer} --scenario capsule \ --foreman-proxy-dns true \ --foreman-proxy-dns-managed true \ --foreman-proxy-dns-interface _eth0_ \ @@ -86,7 +86,7 @@ endif::[] For more information about configuring DHCP, DNS, and TFTP services, see the link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/provisioning_guide/configuring_networking#Configuring_Networking-Configuring_Network_Services_for_PXE_Boot[Configuring Network Services] section in the _Provisioning Guide_. ifeval::["{context}" == "satellite"] -For more information about disabling the DNS, DHCP, and TFTP services in Satellite and managing them manually, see xref:disabling_dns_dhcp_tftp_for_unmanaged_networks[Disabling DNS, DHCP, and TFTP for Unmanaged Networks]. +For more information about disabling the DNS, DHCP, and TFTP services in {Project} and managing them manually, see xref:disabling_dns_dhcp_tftp_for_unmanaged_networks[Disabling DNS, DHCP, and TFTP for Unmanaged Networks]. For more information about configuring external services, see xref:configuring_external_services[Configuring External Services]. endif::[] diff --git a/guides/common/modules/proc_configuring-satellite-deployment-with-an-external-dhcp-server.adoc b/guides/common/modules/proc_configuring-satellite-deployment-with-an-external-dhcp-server.adoc index a94e96ff11..1d5209d870 100644 --- a/guides/common/modules/proc_configuring-satellite-deployment-with-an-external-dhcp-server.adoc +++ b/guides/common/modules/proc_configuring-satellite-deployment-with-an-external-dhcp-server.adoc @@ -5,7 +5,7 @@ You can configure {ProductName} with an external DHCP server. .Prerequisite -* Ensure that you have configured an external DHCP server and that you have shared the DHCP configuration and lease files with Capsule Server. For more information, see xref:configuring-an-external-dhcp-server_{context}[]. +* Ensure that you have configured an external DHCP server and that you have shared the DHCP configuration and lease files with {SmartProxyServer}. For more information, see xref:configuring-an-external-dhcp-server_{context}[]. .Procedure To configure {ProductName} with external DHCP, complete the following steps: @@ -67,11 +67,11 @@ bash-4.2$ cat /mnt/nfs/var/lib/dhcpd/dhcpd.leases bash-4.2$ exit ---- -. Enter the `satellite-installer` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/dhcp.yml` file: +. Enter the `{foreman-installer}` command to make the following persistent changes to the `/etc/foreman-proxy/settings.d/dhcp.yml` file: + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-dhcp=true \ +# {foreman-installer} --foreman-proxy-dhcp=true \ --foreman-proxy-dhcp-provider=remote_isc \ --foreman-proxy-plugin-dhcp-remote-isc-dhcp-config /mnt/nfs/etc/dhcp/dhcpd.conf \ --foreman-proxy-plugin-dhcp-remote-isc-dhcp-leases /mnt/nfs/var/lib/dhcpd/dhcpd.leases \ @@ -90,8 +90,8 @@ bash-4.2$ exit ---- [cols="40%,60%",options="header"] -. Log in to the Satellite Server web UI. +. Log in to the {ProjectServer} web UI. -. Navigate to *Infrastructure* > *Capsules*. Locate the Capsule Server that you want to configure with external DHCP, and from the list in the *Actions* column, select *Refresh*. +. Navigate to *Infrastructure* > *{SmartProxies}*. Locate the {SmartProxyServer} that you want to configure with external DHCP, and from the list in the *Actions* column, select *Refresh*. . Associate the DHCP service with the appropriate subnets and domain. diff --git a/guides/common/modules/proc_configuring-satellite-to-synchronize-content-with-a-local-cdn-server.adoc b/guides/common/modules/proc_configuring-satellite-to-synchronize-content-with-a-local-cdn-server.adoc index ab95ea626b..01a1fa63b4 100644 --- a/guides/common/modules/proc_configuring-satellite-to-synchronize-content-with-a-local-cdn-server.adoc +++ b/guides/common/modules/proc_configuring-satellite-to-synchronize-content-with-a-local-cdn-server.adoc @@ -1,21 +1,21 @@ [id="configuring-satellite-to-synchronize-content-with-a-local-cdn-server_{context}"] -= Configuring Satellite to Synchronize Content with a Local CDN Server += Configuring {Project} to Synchronize Content with a Local CDN Server -In a disconnected environment, you must ensure that Satellite Server contains the required content to provision systems with the latest security updates, errata, and packages. To do this, follow this procedure to download content ISO images from the Red{nbsp}Hat Customer Portal and import them into a local CDN server. You can host the local CDN server on the base operating system of Satellite Server or on a system that is accessible to Satellite over HTTP. Next, you must configure Satellite Server to synchronize content with the local CDN server. +In a disconnected environment, you must ensure that {ProjectServer} contains the required content to provision systems with the latest security updates, errata, and packages. To do this, follow this procedure to download content ISO images from the Red{nbsp}Hat Customer Portal and import them into a local CDN server. You can host the local CDN server on the base operating system of {ProjectServer} or on a system that is accessible to {Project} over HTTP. Next, you must configure {ProjectServer} to synchronize content with the local CDN server. .Procedure . Log on to the Red{nbsp}Hat Customer Portal at https://access.redhat.com. -. In the upper left of the window, click *Downloads* and select *Red Hat Satellite*. +. In the upper left of the window, click *Downloads* and select *{ProjectName}*. . Click the *Content ISOs* tab. This page lists all the products that are available in your subscription. . Click the link for the product name, such as *Red Hat Enterprise Linux 7 Server (x86_64)* to download the ISO image. -. Copy all of Satellite Content ISO images to a system that you want to use as a local CDN server. For example, the `/root/isos` directory on Satellite Server. +. Copy all of {Project} Content ISO images to a system that you want to use as a local CDN server. For example, the `/root/isos` directory on {ProjectServer}. + -Note that storing the content on the same system where Satellite is installed is not a requirement. The CDN can be hosted on a different system inside the same disconnected network as long as it is accessible to Satellite Server over HTTP. +Note that storing the content on the same system where {Project} is installed is not a requirement. The CDN can be hosted on a different system inside the same disconnected network as long as it is accessible to {ProjectServer} over HTTP. . On the system that you want to use as your local CDN server, create a local directory that is accessible over httpd. For example, `/var/www/html/pub/sat-import/`: + @@ -51,7 +51,7 @@ Note that storing the content on the same system where Satellite is installed is # restorecon -rv /var/www/html/pub/sat-import/ ---- -. In the Satellite web UI, navigate to *Content* > *Subscriptions*. +. In the {Project} web UI, navigate to *Content* > *Subscriptions*. . Click *Manage Manifest*. @@ -59,4 +59,4 @@ Note that storing the content on the same system where Satellite is installed is + `http://server.example.com/pub/sat-import/` -. Click *Update* and then upload your manifest into Satellite. +. Click *Update* and then upload your manifest into {Project}. diff --git a/guides/common/modules/proc_creating-a-custom-certificate.adoc b/guides/common/modules/proc_creating-a-custom-certificate.adoc index 23aa9f3f24..89d7cbf43f 100644 --- a/guides/common/modules/proc_creating-a-custom-certificate.adoc +++ b/guides/common/modules/proc_creating-a-custom-certificate.adoc @@ -7,9 +7,9 @@ Use this procedure to create a custom SSL certificate for {ProductName}. If you endif::[] ifeval::["{context}" == "capsule"] -On Satellite Server, create a custom certificate for your {ProductName}. If you already have a custom SSL certificate for {ProductName}, skip this procedure. +On {ProjectServer}, create a custom certificate for your {ProductName}. If you already have a custom SSL certificate for {ProductName}, skip this procedure. -Do not use the same certificate for both Satellite Server and Capsule Server. +Do not use the same certificate for both {ProjectServer} and {SmartProxyServer}. endif::[] IMPORTANT: Use the Privacy-Enhanced Mail (PEM) encoding for the SSL certificates. @@ -89,6 +89,6 @@ DNS.1 = _{context}.example.com_ <3> <2> Path to the configuration file. <3> Path to the CSR to generate. -. Send the certificate signing request to the Certificate Authority. The same Certificate Authority must sign certificates for Satellite Server and Capsule Server. +. Send the certificate signing request to the Certificate Authority. The same Certificate Authority must sign certificates for {ProjectServer} and {SmartProxyServer}. + When you submit the request, specify the lifespan of the certificate. The method for sending the certificate request varies, so consult the Certificate Authority for the preferred method. In response to the request, you can expect to receive a Certificate Authority bundle and a signed certificate, in separate files. diff --git a/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-capsule-server.adoc b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-capsule-server.adoc index ed156731e8..b9c049ac31 100644 --- a/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-capsule-server.adoc +++ b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-capsule-server.adoc @@ -1,22 +1,22 @@ [id="deploying-a-custom-ssl-certificate-to-capsule-server_{context}"] -= Deploying a Custom SSL Certificate to Capsule{nbsp}Server += Deploying a Custom SSL Certificate to {SmartProxyServer} -Use this procedure to configure your Capsule{nbsp}Server with a custom SSL certificate signed by a Certificate Authority. The `satellite-installer` command, which the `capsule-certs-generate` command returns, is unique to each Capsule{nbsp}Server. Do not use the same command on more than one Capsule{nbsp}Server. +Use this procedure to configure your {SmartProxyServer} with a custom SSL certificate signed by a Certificate Authority. The `{foreman-installer}` command, which the `capsule-certs-generate` command returns, is unique to each {SmartProxyServer}. Do not use the same command on more than one {SmartProxyServer}. .Prerequisites -Before configuring Capsule Server with a custom server certificate, ensure that your Satellite and Capsule Servers meet the following conditions: +Before configuring {SmartProxyServer} with a custom server certificate, ensure that your {Project} and {SmartProxyServer}s meet the following conditions: -* Satellite{nbsp}Server is configured with a custom certificate. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#configuring-satellite-custom-server-certificate_satellite[Configuring Satellite Server with a Custom Server Certificate] in _Installing Satellite Server from a Connected Network_. -* Capsule{nbsp}Server is registered to Satellite{nbsp}Server. For more information, see xref:registering-to-satellite-server_capsule[]. -* The Capsule{nbsp}Server packages are installed. For more information, see xref:installing-capsule-server-packages_capsule[] +* {ProjectServer} is configured with a custom certificate. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#configuring-satellite-custom-server-certificate_satellite[Configuring {ProjectServer} with a Custom Server Certificate] in _Installing {ProjectServer} from a Connected Network_. +* {SmartProxyServer} is registered to {ProjectServer}. For more information, see xref:registering-to-satellite-server_capsule[]. +* The {SmartProxyServer} packages are installed. For more information, see xref:installing-capsule-server-packages_capsule[] .Procedure -To configure your Capsule{nbsp}Server with a custom SSL certificate, complete the following steps: +To configure your {SmartProxyServer} with a custom SSL certificate, complete the following steps: -. On Satellite Server, validate the custom SSL certificate input files: +. On {ProjectServer}, validate the custom SSL certificate input files: + [options="nowrap", subs="+quotes"] ---- @@ -25,17 +25,17 @@ To configure your Capsule{nbsp}Server with a custom SSL certificate, complete th -k __/root/capsule_cert/capsule_cert_key.pem__ \ <2> -b __/root/capsule_cert/ca_cert_bundle.pem__ <3> ---- -<1> Path to the Capsule Server certificate file that is signed by a Certificate Authority. -<2> Path to the private key that was used to sign the Capsule{nbsp}Server certificate. +<1> Path to the {SmartProxyServer} certificate file that is signed by a Certificate Authority. +<2> Path to the private key that was used to sign the {SmartProxyServer} certificate. <3> Path to the Certificate Authority bundle. + -If the command is successful, it returns two `capsule-certs-generate` commands, one of which you must use to generate the certificate archive file for your Capsule Server. +If the command is successful, it returns two `capsule-certs-generate` commands, one of which you must use to generate the certificate archive file for your {SmartProxyServer}. -. On Satellite{nbsp}Server, from the output of the `katello-certs-check` command, depending on your requirements, enter the `capsule-certs-generate` command that generates a certificate for a new or existing Capsule. In this command, change `$CAPSULE` to the FQDN of your Capsule Server. +. On {ProjectServer}, from the output of the `katello-certs-check` command, depending on your requirements, enter the `capsule-certs-generate` command that generates a certificate for a new or existing {SmartProxy}. In this command, change `$CAPSULE` to the FQDN of your {SmartProxyServer}. -. Retain a copy of the `satellite-installer` command that the `capsule-certs-generate` command returns for deploying the certificate to your Capsule{nbsp}Server. +. Retain a copy of the `{foreman-installer}` command that the `capsule-certs-generate` command returns for deploying the certificate to your {SmartProxyServer}. -. On Satellite{nbsp}Server, copy the certificate archive file to your Capsule{nbsp}Server: +. On {ProjectServer}, copy the certificate archive file to your {SmartProxyServer}: + [options="nowrap", subs="+quotes"] ---- @@ -43,8 +43,8 @@ If the command is successful, it returns two `capsule-certs-generate` commands, root@_capsule.example.com_:/root/_capsule.example.com_-certs.tar ---- -. On Capsule{nbsp}Server, to deploy the certificate, enter the `satellite-installer` command that the `capsule-certs-generate` command returns. +. On {SmartProxyServer}, to deploy the certificate, enter the `{foreman-installer}` command that the `capsule-certs-generate` command returns. + -When network connections or ports to Satellite are not yet open, you can set the `--foreman-proxy-register-in-foreman` option to `false` to prevent Capsule from attempting to connect to Satellite and reporting errors. Run the installer again with this option set to `true` when the network and firewalls are correctly configured. +When network connections or ports to {Project} are not yet open, you can set the `--foreman-proxy-register-in-foreman` option to `false` to prevent {SmartProxy} from attempting to connect to {Project} and reporting errors. Run the installer again with this option set to `true` when the network and firewalls are correctly configured. + -IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading Capsule Server. +IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading {SmartProxyServer}. diff --git a/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-satellite-server.adoc b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-satellite-server.adoc index 1f43f1d335..6b337ebbdb 100644 --- a/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-satellite-server.adoc +++ b/guides/common/modules/proc_deploying-a-custom-ssl-certificate-to-satellite-server.adoc @@ -1,14 +1,14 @@ [id="deploying-a-custom-ssl-certificate-to-satellite-server_{context}"] -= Deploying a Custom SSL Certificate to Satellite Server += Deploying a Custom SSL Certificate to {ProjectServer} -Use this procedure to configure your Satellite{nbsp}Server to use a custom SSL certificate signed by a Certificate Authority. The `katello-certs-check` command validates the input certificate files and returns the commands necessary to deploy a custom SSL certificate to Satellite{nbsp}Server. +Use this procedure to configure your {ProjectServer} to use a custom SSL certificate signed by a Certificate Authority. The `katello-certs-check` command validates the input certificate files and returns the commands necessary to deploy a custom SSL certificate to {ProjectServer}. .Procedure -To deploy a custom certificate on your Satellite Server, complete the following steps: +To deploy a custom certificate on your {ProjectServer}, complete the following steps: -. Validate the custom SSL certificate input files. Note that for the `katello-certs-check` command to work correctly, Common Name (CN) in the certificate must match the FQDN of Satellite Server. +. Validate the custom SSL certificate input files. Note that for the `katello-certs-check` command to work correctly, Common Name (CN) in the certificate must match the FQDN of {ProjectServer}. + [options="nowrap", subs="+quotes"] ---- @@ -17,16 +17,16 @@ To deploy a custom certificate on your Satellite Server, complete the following -k __/root/satellite_cert/satellite_cert_key.pem__ \ <2> -b __/root/satellite_cert/ca_cert_bundle.pem__ <3> ---- -<1> Path to the Satellite Server certificate file that is signed by a Certificate Authority. -<2> Path to the private key that was used to sign the Capsule{nbsp}Server certificate. +<1> Path to the {ProjectServer} certificate file that is signed by a Certificate Authority. +<2> Path to the private key that was used to sign the {SmartProxyServer} certificate. <3> Path to the Certificate Authority bundle. + -If the command is successful, it returns two `satellite-installer` commands, one of which you must use to deploy a certificate to Satellite Server. +If the command is successful, it returns two `{foreman-installer}` commands, one of which you must use to deploy a certificate to {ProjectServer}. -. From the output of the `katello-certs-check` command, depending on your requirements, enter the `satellite-installer` command that deploys a certificate to a new Satellite or updates a certificate on a currently running Satellite. +. From the output of the `katello-certs-check` command, depending on your requirements, enter the `{foreman-installer}` command that deploys a certificate to a new {Project} or updates a certificate on a currently running {Project}. + -IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading Satellite Server. +IMPORTANT: Do not delete the certificate archive file after you deploy the certificate. It is required, for example, when upgrading {ProjectServer}. -. On a computer with network access to Satellite{nbsp}Server, navigate to the following URL: `https://_satellite.example.com_`. +. On a computer with network access to {ProjectServer}, navigate to the following URL: `https://_{foreman-example-com}_`. . In your browser, view the certificate details to verify the deployed certificate. diff --git a/guides/common/modules/proc_enabling-connections-from-capsule-to-satellite.adoc b/guides/common/modules/proc_enabling-connections-from-capsule-to-satellite.adoc index ab6fefcdd4..436ef5bd0a 100644 --- a/guides/common/modules/proc_enabling-connections-from-capsule-to-satellite.adoc +++ b/guides/common/modules/proc_enabling-connections-from-capsule-to-satellite.adoc @@ -1,15 +1,15 @@ [id="enabling-connections-from-capsule-to-satellite_{context}"] -= Enabling Connections from Capsule Server to Satellite Server += Enabling Connections from {SmartProxyServer} to {ProjectServer} -On Satellite Server, you must enable the incoming connection from Capsule Server to Satellite Server and make this rule persistent across reboots. +On {ProjectServer}, you must enable the incoming connection from {SmartProxyServer} to {ProjectServer} and make this rule persistent across reboots. .Prerequisites -* Ensure that the firewall rules on Satellite Server are configured to enable connections for client to Satellite communication, because Capsule Server is a client of Satellite Server. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/preparing_your_environment_for_installation#enabling_client_connections_to_satellite[Enabling Connections from a Client to Satellite Server] in _Installing Satellite Server from a Connected Network_. +* Ensure that the firewall rules on {ProjectServer} are configured to enable connections for client to {Project} communication, because {SmartProxyServer} is a client of {ProjectServer}. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/preparing_your_environment_for_installation#enabling_client_connections_to_satellite[Enabling Connections from a Client to {ProjectServer}] in _Installing {ProjectServer} from a Connected Network_. .Procedure -. On Satellite Server, enter the following command to open the port for Capsule to Satellite communication: +. On {ProjectServer}, enter the following command to open the port for {SmartProxy} to {Project} communication: + [options="nowrap"] ---- diff --git a/guides/common/modules/proc_enabling-connections-to-capsule.adoc b/guides/common/modules/proc_enabling-connections-to-capsule.adoc index ae18d52dbc..de6d86a272 100644 --- a/guides/common/modules/proc_enabling-connections-to-capsule.adoc +++ b/guides/common/modules/proc_enabling-connections-to-capsule.adoc @@ -1,12 +1,12 @@ [id="enabling-connections-to-capsule_{context}"] -= Enabling Connections from Satellite Server and Clients to a Capsule Server += Enabling Connections from {ProjectServer} and Clients to a {SmartProxyServer} -On the base operating system on which you want to install Capsule, you must enable incoming connections from Satellite Server and clients to Capsule Server and make these rules persistent across reboots. +On the base operating system on which you want to install {SmartProxy}, you must enable incoming connections from {ProjectServer} and clients to {SmartProxyServer} and make these rules persistent across reboots. .Procedure -. On the base operating system on which you want to install Capsule, enter the following command to open the ports for Satellite Server and clients communication to Capsule Server: +. On the base operating system on which you want to install {SmartProxy}, enter the following command to open the ports for {ProjectServer} and clients communication to {SmartProxyServer}: + [options="nowrap"] ---- diff --git a/guides/common/modules/proc_enabling-openscap.adoc b/guides/common/modules/proc_enabling-openscap.adoc index 44724f2f0c..96906c28e2 100644 --- a/guides/common/modules/proc_enabling-openscap.adoc +++ b/guides/common/modules/proc_enabling-openscap.adoc @@ -1,17 +1,17 @@ [id="enabling-openscap_{context}"] -= Enabling OpenSCAP on External Capsules += Enabling OpenSCAP on External {SmartProxies} -On Satellite Server and the integrated Capsule of your Satellite Server, OpenSCAP is enabled by default. +On {ProjectServer} and the integrated {SmartProxy} of your {ProjectServer}, OpenSCAP is enabled by default. -To use the OpenSCAP plug-in and content on an external Capsule, you must enable OpenSCAP on each Capsule. +To use the OpenSCAP plug-in and content on an external {SmartProxy}, you must enable OpenSCAP on each {SmartProxy}. .Procedure * To enable OpenSCAP, enter the following command: + -[options="nowrap"] +[options="nowrap" subs="quotes,attributes"] ---- -# satellite-installer --scenario capsule \ +# {foreman-installer} --scenario capsule \ --enable-foreman-proxy-plugin-openscap ---- diff --git a/guides/common/modules/proc_enabling-power-management-on-managed-hosts.adoc b/guides/common/modules/proc_enabling-power-management-on-managed-hosts.adoc index d872718775..805e04c0ef 100644 --- a/guides/common/modules/proc_enabling-power-management-on-managed-hosts.adoc +++ b/guides/common/modules/proc_enabling-power-management-on-managed-hosts.adoc @@ -14,18 +14,18 @@ For more information, see https://access.redhat.com/documentation/en-us/red_hat_ * To enable BMC, enter the following command: ifeval::["{context}" == "satellite"] + -[options="nowrap"] +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --foreman-proxy-bmc "true" \ +# {foreman-installer} --foreman-proxy-bmc "true" \ --foreman-proxy-bmc-default-provider "freeipmi" ---- endif::[] ifeval::["{context}" == "capsule"] + -[options="nowrap"] +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --scenario capsule \ +# {foreman-installer} --scenario capsule \ --foreman-proxy-bmc "true" \ --foreman-proxy-bmc-default-provider "freeipmi" ---- diff --git a/guides/common/modules/proc_enabling-remote-execution.adoc b/guides/common/modules/proc_enabling-remote-execution.adoc index 6dc17f4c63..be21c3e0b4 100644 --- a/guides/common/modules/proc_enabling-remote-execution.adoc +++ b/guides/common/modules/proc_enabling-remote-execution.adoc @@ -1,17 +1,17 @@ [id="enabling-remote-execution_{context}"] -= Enabling Remote Execution on Capsule Server += Enabling Remote Execution on {SmartProxyServer} -To run commands on hosts that are registered to Capsule Server, you must enable the remote execution feature on your Capsule. +To run commands on hosts that are registered to {SmartProxyServer}, you must enable the remote execution feature on your {SmartProxy}. -Remote execution on external Capsules is disabled by default. +Remote execution on external {SmartProxies} is disabled by default. .Procedure -* To enable remote execution on Capsule Server, enter the following command: +* To enable remote execution on {SmartProxyServer}, enter the following command: + -[options="nowrap"] +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer --scenario capsule \ +# {foreman-installer} --scenario capsule \ --enable-foreman-proxy-plugin-remote-execution-ssh ---- diff --git a/guides/common/modules/proc_importing-a-subscription-manifest-into-satellite-server.adoc b/guides/common/modules/proc_importing-a-subscription-manifest-into-satellite-server.adoc index fa7463f995..067612ce0b 100644 --- a/guides/common/modules/proc_importing-a-subscription-manifest-into-satellite-server.adoc +++ b/guides/common/modules/proc_importing-a-subscription-manifest-into-satellite-server.adoc @@ -1,7 +1,7 @@ [id="importing-a-subscription-manifest-into-satellite-server_{context}"] -= Importing a Subscription Manifest into Satellite Server += Importing a Subscription Manifest into {ProjectServer} -Use the following procedure to import a Subscription Manifest into Satellite Server. +Use the following procedure to import a Subscription Manifest into {ProjectServer}. .Prerequisites @@ -11,7 +11,7 @@ Use the following procedure to import a Subscription Manifest into Satellite Ser To import a Subscription Manifest, complete the following steps: -. In the Satellite web UI, ensure the context is set to the organization you want to use. +. In the {Project} web UI, ensure the context is set to the organization you want to use. . Navigate to *Content* > *Subscriptions* and click *Manage Manifest*. @@ -21,14 +21,14 @@ To import a Subscription Manifest, complete the following steps: .For CLI Users -. Copy the Subscription Manifest file from your client to Satellite Server: +. Copy the Subscription Manifest file from your client to {ProjectServer}: + -[subs="+quotes"] +[subs="+quotes,attributes"] ---- -$ scp ~/_manifest_file_.zip root@_satellite.example.com_:~/. +$ scp ~/_manifest_file_.zip root@_{foreman-example-com}_:~/. ---- + -. Log in to Satellite Server as the `root` user and import the Subscription Manifest file: +. Log in to {ProjectServer} as the `root` user and import the Subscription Manifest file: + [subs="+quotes"] ---- diff --git a/guides/common/modules/proc_importing-kickstart-repositories.adoc b/guides/common/modules/proc_importing-kickstart-repositories.adoc index 964e445b69..78ed725e99 100644 --- a/guides/common/modules/proc_importing-kickstart-repositories.adoc +++ b/guides/common/modules/proc_importing-kickstart-repositories.adoc @@ -1,7 +1,7 @@ [id="importing-kickstart-repositories_{context}"] = Importing Kickstart Repositories -Kickstart repositories are not provided by the Content ISO image. To use Kickstart repositories in your disconnected Satellite, you must download a binary DVD ISO file for the version of Red{nbsp}Hat Enterprise Linux that you want to use and copy the Kickstart files to Satellite. +Kickstart repositories are not provided by the Content ISO image. To use Kickstart repositories in your disconnected {Project}, you must download a binary DVD ISO file for the version of Red{nbsp}Hat Enterprise Linux that you want to use and copy the Kickstart files to {Project}. .Procedure @@ -9,8 +9,8 @@ Kickstart repositories are not provided by the Content ISO image. To use Kicksta . In the upper left of the window, click *Downloads*. . Locate and click the version of Red{nbsp}Hat Enterprise Linux that you want to use, for example *Red Hat Enterprise Linux 8*. . In the Download Red Hat Enterprise Linux window, locate the binary DVD version of the ISO image, for example, *Red Hat Enterprise Linux 8.1 Binary DVD*, and click *Download Now*. -. When the download completes, copy the ISO image to Satellite Server. -. On Satellite Server, create a mount point and temporarily mount the ISO image at that location: +. When the download completes, copy the ISO image to {ProjectServer}. +. On {ProjectServer}, create a mount point and temporarily mount the ISO image at that location: + [options="nowrap" subs="+quotes"] ---- @@ -166,4 +166,4 @@ uid = AppStream # rmdir /mnt/_iso_ ---- + -. In the Satellite web UI, enable the Kickstart repositories. +. In the {Project} web UI, enable the Kickstart repositories. diff --git a/guides/common/modules/proc_installing-capsule-server-packages.adoc b/guides/common/modules/proc_installing-capsule-server-packages.adoc index 05ed55f9b0..f74b4bb4f7 100644 --- a/guides/common/modules/proc_installing-capsule-server-packages.adoc +++ b/guides/common/modules/proc_installing-capsule-server-packages.adoc @@ -1,11 +1,11 @@ [id="installing-capsule-server-packages_{context}"] -= Installing Capsule Server Packages += Installing {SmartProxyServer} Packages -Before installing the Capsule Server packages, you must update all packages that are installed on the base system. +Before installing the {SmartProxyServer} packages, you must update all packages that are installed on the base system. .Procedure -To install Capsule Server, complete the following steps: +To install {SmartProxyServer}, complete the following steps: . Update all packages: + diff --git a/guides/common/modules/proc_installing-the-katello-agent.adoc b/guides/common/modules/proc_installing-the-katello-agent.adoc index faf06a9ea7..b07888a2d9 100644 --- a/guides/common/modules/proc_installing-the-katello-agent.adoc +++ b/guides/common/modules/proc_installing-the-katello-agent.adoc @@ -2,18 +2,18 @@ = Installing the Katello Agent -To remotely update Satellite clients, you must install the Katello agent. +To remotely update {Project} clients, you must install the Katello agent. -The `katello-agent` package depends on the `gofer` package that provides the `goferd` service. This service must be enabled so that Satellite Server or Capsule Server can provide information about errata that are applicable for content hosts. +The `katello-agent` package depends on the `gofer` package that provides the `goferd` service. This service must be enabled so that {ProjectServer} or {SmartProxyServer} can provide information about errata that are applicable for content hosts. .Prerequisites Before installing the Katello agent, ensure the following conditions are met: -* You have enabled the Satellite Tools repository on Satellite Server. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#enabling_satellite_tools_repository[Enabling the Satellite Tools Repository] in _Installing Satellite Server from a Connected Network_. +* You have enabled the {Project} Tools repository on {ProjectServer}. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#enabling_satellite_tools_repository[Enabling the {Project} Tools Repository] in _Installing {ProjectServer} from a Connected Network_. -* You have synchronized the Satellite Tools repository on Satellite Server. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#synchronizing_satellite_tools_repository[Synchronizing the Satellite Tools Repository] in _Installing Satellite Server from a Connected Network_. +* You have synchronized the {Project} Tools repository on {ProjectServer}. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/performing_additional_configuration_on_satellite_server#synchronizing_satellite_tools_repository[Synchronizing the {Project} Tools Repository] in _Installing {ProjectServer} from a Connected Network_. -* You have enabled the Satellite Tools repository on the client. For example, to ensure that the repository is enabled on the Red{nbsp}Hat Enterprise Linux{nbsp}7 client, enter the following command on the client: +* You have enabled the {Project} Tools repository on the client. For example, to ensure that the repository is enabled on the Red{nbsp}Hat Enterprise Linux{nbsp}7 client, enter the following command on the client: + [options="nowrap" subs="+quotes,attributes"] ---- diff --git a/guides/common/modules/proc_registering-to-satellite-server.adoc b/guides/common/modules/proc_registering-to-satellite-server.adoc index 38afe96e65..edccefc045 100644 --- a/guides/common/modules/proc_registering-to-satellite-server.adoc +++ b/guides/common/modules/proc_registering-to-satellite-server.adoc @@ -1,36 +1,36 @@ [id="registering-to-satellite-server_{context}"] -= Registering to Satellite Server += Registering to {ProjectServer} -Use this procedure to register the base system on which you want to install Capsule Server to Satellite Server. +Use this procedure to register the base system on which you want to install {SmartProxyServer} to {ProjectServer}. .Prerequisites -Before registering it to Satellite Server, ensure that the base system on which you want to install Capsule meets the following conditions: +Before registering it to {ProjectServer}, ensure that the base system on which you want to install {SmartProxy} meets the following conditions: .Subscription Manifest Prerequisites -* On Satellite Server, a manifest must be installed and it must contain the appropriate repositories for the organization you want Capsule to belong to. -* The manifest must contain repositories for the base system on which you want to install Capsule, as well as any clients that you want to connect to Capsule. +* On {ProjectServer}, a manifest must be installed and it must contain the appropriate repositories for the organization you want {SmartProxy} to belong to. +* The manifest must contain repositories for the base system on which you want to install {SmartProxy}, as well as any clients that you want to connect to {SmartProxy}. * The repositories must be synchronized. -For more information on manifests and repositories, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/managing_subscriptions/[Managing Subscriptions] in the _Red Hat Satellite Content Management Guide_. +For more information on manifests and repositories, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/content_management_guide/managing_subscriptions/[Managing Subscriptions] in the _{ProjectName} Content Management Guide_. .Proxy and Network Prerequisites -* The Satellite Server base system must be able to resolve the host name of the Capsule base system and vice versa. -* The base system on which you want to install Capsule Server must not be configured to use a proxy to connect to the Red Hat CDN. +* The {ProjectServer} base system must be able to resolve the host name of the {SmartProxy} base system and vice versa. +* The base system on which you want to install {SmartProxyServer} must not be configured to use a proxy to connect to the Red Hat CDN. * You must configure the host and network-based firewalls accordingly. For more information, see xref:ports-and-firewalls-requirements_capsule[]. -* You must have a Satellite Server user name and password. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication[Configuring External Authentication] in _Administering Red Hat Satellite_. +* You must have a {ProjectServer} user name and password. For more information, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-configuring_external_authentication[Configuring External Authentication] in _Administering {ProjectName}_. .Procedure -To register your system to Satellite Server, complete the following steps: +To register your system to {ProjectServer}, complete the following steps: -. Install the Satellite Server CA certificate on the base system on which you want to install Capsule. +. Install the {ProjectServer} CA certificate on the base system on which you want to install {SmartProxy}. + -[options="nowrap" subs="+quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -# rpm -Uvh http://_satellite.example.com_/pub/katello-ca-consumer-latest.noarch.rpm +# rpm -Uvh http://__{foreman-example-com}__/pub/katello-ca-consumer-latest.noarch.rpm ---- -. Register the Capsule base system with the environments that you want Capsule to belong to. Use an activation key to simplify specifying the environments. +. Register the {SmartProxy} base system with the environments that you want {SmartProxy} to belong to. Use an activation key to simplify specifying the environments. + [options="nowrap" subs="+quotes"] ---- diff --git a/guides/common/modules/proc_resolving-package-dependancy-errors.adoc b/guides/common/modules/proc_resolving-package-dependancy-errors.adoc index a41c557cda..e8ff6a44f9 100644 --- a/guides/common/modules/proc_resolving-package-dependancy-errors.adoc +++ b/guides/common/modules/proc_resolving-package-dependancy-errors.adoc @@ -1,9 +1,9 @@ [id="resolving-package-dependency-errors_{context}"] == Resolving Package Dependency Errors -If there are package dependency errors during installation of Satellite Server packages, you can resolve the errors by downloading and installing packages from Red Hat Customer Portal. For more information about resolving dependency errors, see the KCS solution https://access.redhat.com/solutions/262323[How can I use the yum output to solve yum dependency errors?]. +If there are package dependency errors during installation of {ProjectServer} packages, you can resolve the errors by downloading and installing packages from Red Hat Customer Portal. For more information about resolving dependency errors, see the KCS solution https://access.redhat.com/solutions/262323[How can I use the yum output to solve yum dependency errors?]. -If you have successfully installed the Satellite packages, skip this procedure. +If you have successfully installed the {Project} packages, skip this procedure. .Procedure @@ -25,9 +25,9 @@ If you have successfully installed the Satellite packages, skip this procedure. . At the bottom of the page, click *Download Now*. -. Copy the package to the Satellite base system. +. Copy the package to the {Project} base system. -. On Satellite Server, change to the directory where the package is located: +. On {ProjectServer}, change to the directory where the package is located: + [options="nowrap" subs="+quotes"] ---- @@ -41,18 +41,18 @@ If you have successfully installed the Satellite packages, skip this procedure. # yum localinstall _package_name_ ---- -. Change to the directory where the Satellite ISO is mounted: +. Change to the directory where the {Project} ISO is mounted: + [options="nowrap"] ---- # cd /media/sat6/ ---- -. Verify that you have resoled the package dependency errors by installing the Satellite Server packages. If there are further package dependency errors, repeat this procedure. +. Verify that you have resoled the package dependency errors by installing the {ProjectServer} packages. If there are further package dependency errors, repeat this procedure. + [options="nowrap"] ---- # ./install_packages ---- + -If you have successfully installed the Satellite packages, the following message is displayed: `Install is complete. Please run satellite-installer --scenario satellite`. +If you have successfully installed the {Project} packages, the following message is displayed: `Install is complete. Please run {foreman-installer} --scenario satellite`. diff --git a/guides/common/modules/proc_reverting-satellite-to-download-content-from-red-hat-cdn.adoc b/guides/common/modules/proc_reverting-satellite-to-download-content-from-red-hat-cdn.adoc index 3684820d5e..70d7ae7c8d 100644 --- a/guides/common/modules/proc_reverting-satellite-to-download-content-from-red-hat-cdn.adoc +++ b/guides/common/modules/proc_reverting-satellite-to-download-content-from-red-hat-cdn.adoc @@ -1,10 +1,10 @@ [id="reverting-satellite-to-download-content-from-red-hat-cdn_{context}"] -= Reverting Satellite to Download Content from Red Hat CDN -If your environment changes from disconnected to connected, you can reconfigure a disconnected Satellite to download content directly from the Red Hat CDN. += Reverting {Project} to Download Content from Red Hat CDN +If your environment changes from disconnected to connected, you can reconfigure a disconnected {Project} to download content directly from the Red Hat CDN. .Procedure -. In the Satellite web UI, navigate to *Content* > *Subscriptions*. +. In the {Project} web UI, navigate to *Content* > *Subscriptions*. . Click *Manage Manifest*. @@ -14,4 +14,4 @@ If your environment changes from disconnected to connected, you can reconfigure . Click *Save*. -Satellite Server is now configured to download content from the CDN the next time that it synchronizes repositories. +{ProjectServer} is now configured to download content from the CDN the next time that it synchronizes repositories. diff --git a/guides/common/modules/proc_uninstalling-capsule-server.adoc b/guides/common/modules/proc_uninstalling-capsule-server.adoc index ffe202658b..978f485a27 100644 --- a/guides/common/modules/proc_uninstalling-capsule-server.adoc +++ b/guides/common/modules/proc_uninstalling-capsule-server.adoc @@ -1,10 +1,10 @@ [id="uninstalling-capsule-server_{context}"] -= Uninstalling Capsule Server += Uninstalling {SmartProxyServer} -Uninstalling Capsule Server deletes all applications that are used on the target system. If you use any applications or application data on the target system for purposes other than running Capsule Server, you must back up the information before uninstalling Capsule. +Uninstalling {SmartProxyServer} deletes all applications that are used on the target system. If you use any applications or application data on the target system for purposes other than running {SmartProxyServer}, you must back up the information before uninstalling {SmartProxy}. -To uninstall Capsule, use the `katello-remove` command. Before deleting all packages and configuration files in the system, the `katello-remove` command displays two warnings that require your confirmation. +To uninstall {SmartProxy}, use the `katello-remove` command. Before deleting all packages and configuration files in the system, the `katello-remove` command displays two warnings that require your confirmation. The `katello-remove` command deletes the following packages and configuration files: @@ -18,15 +18,15 @@ The `katello-remove` command deletes the following packages and configuration fi .Procedure -. In the Satellite web UI, navigate to *Hosts* > *All Hosts*. +. In the {Project} web UI, navigate to *Hosts* > *All Hosts*. -. From the *Edit* list to the right of the Capsule Server that you want to uninstall, select *Delete* . +. From the *Edit* list to the right of the {SmartProxyServer} that you want to uninstall, select *Delete* . -. Navigate to *Infrastructure* > *Capsule*. +. Navigate to *Infrastructure* > *{SmartProxy}*. -. From the *Edit* list to the right of the Capsule Server that you want to uninstall, select *Delete*. +. From the *Edit* list to the right of the {SmartProxyServer} that you want to uninstall, select *Delete*. -. On Capsule Server, enter the `katello-remove` command: +. On {SmartProxyServer}, enter the `katello-remove` command: + [options="nowrap"] ---- @@ -35,27 +35,27 @@ The `katello-remove` command deletes the following packages and configuration fi .For CLI Users -. On Satellite Server, list all Capsule Servers and note the FQDN and ID of the Capsule Server that you want to uninstall: +. On {ProjectServer}, list all {SmartProxyServer}s and note the FQDN and ID of the {SmartProxyServer} that you want to uninstall: + ---- # hammer capsule list ---- -. On Satellite Server, to delete Capsule Server from the Satellite hosts list, enter the `hammer host delete` command and specify the Capsule Server FQDN with the `--name` option: +. On {ProjectServer}, to delete {SmartProxyServer} from the {Project} hosts list, enter the `hammer host delete` command and specify the {SmartProxyServer} FQDN with the `--name` option: + [options="nowrap" subs="+quotes"] ---- # hammer host delete --name _Capsule_Server_FQDN_ ---- -. On Satellite Server, to delete Capsule Server from the Satellite Capsules list, enter the `hammer capsule delete` command and specify the Capsule Server ID with the `--id` option: +. On {ProjectServer}, to delete {SmartProxyServer} from the {Project} {SmartProxies} list, enter the `hammer capsule delete` command and specify the {SmartProxyServer} ID with the `--id` option: + [options="nowrap" subs="+quotes"] ---- # hammer capsule delete --id _Capsule_Server_ID_ ---- -. On Capsule Server, enter the `katello-remove` command: +. On {SmartProxyServer}, enter the `katello-remove` command: + [options="nowrap"] ---- diff --git a/guides/common/modules/ref_capsule-ports-and-firewalls-requirements.adoc b/guides/common/modules/ref_capsule-ports-and-firewalls-requirements.adoc index b50d904a03..471b1872c3 100644 --- a/guides/common/modules/ref_capsule-ports-and-firewalls-requirements.adoc +++ b/guides/common/modules/ref_capsule-ports-and-firewalls-requirements.adoc @@ -2,53 +2,53 @@ The following tables indicate the destination port and the direction of network traffic: -.Ports for Capsule to Satellite Communication +.Ports for {SmartProxy} to {Project} Communication [cols="24%,20%,18%,38%",options="header"] |==== | Port | Protocol | Service | Required For -| 5646 | TCP | amqp | Capsule's Qpid dispatch router to Qpid dispatch router in Satellite +| 5646 | TCP | amqp | {SmartProxy}'s Qpid dispatch router to Qpid dispatch router in {Project} |==== -.Ports for Client to Capsule Communication +.Ports for Client to {SmartProxy} Communication [cols="24%,20%,18%,38%",options="header"] |==== |Port |Protocol |Service |Required for |80 |TCP |HTTP |Anaconda, yum, and for obtaining Katello certificate updates |443 |TCP |HTTPS |Anaconda, yum, Telemetry Services, and Puppet -|5647 |TCP |amqp |Katello agent to communicate with Capsule's +|5647 |TCP |amqp |Katello agent to communicate with {SmartProxy}'s Qpid dispatch router |8000 |TCP |HTTPS |Anaconda to download kickstart templates to hosts, and for downloading iPXE firmware |8140 |TCP |HTTPS |Puppet agent to Puppet master connections |8443 |TCP |HTTPS |Subscription Management Services and Telemetry Services |9090 |TCP |HTTPS |Sending SCAP reports to the Smart Proxy in the -Capsule and for the discovery image during provisioning -| 53 | TCP and UDP | DNS | Client DNS queries to a Capsule's DNS service (Optional) -| 67 | UDP | DHCP | Client to Capsule broadcasts, DHCP broadcasts for Client provisioning from a Capsule (Optional) -| 69 | UDP |TFTP | Clients downloading PXE boot image files from a Capsule for provisioning (Optional) +{SmartProxy} and for the discovery image during provisioning +| 53 | TCP and UDP | DNS | Client DNS queries to a {SmartProxy}'s DNS service (Optional) +| 67 | UDP | DHCP | Client to {SmartProxy} broadcasts, DHCP broadcasts for Client provisioning from a {SmartProxy} (Optional) +| 69 | UDP |TFTP | Clients downloading PXE boot image files from a {SmartProxy} for provisioning (Optional) | 5000 | TCP | HTTPS | Connection to Katello for the Docker registry (Optional) |==== -.Ports for Capsule to Client Communication +.Ports for {SmartProxy} to Client Communication [cols="24%,20%,18%,38%a",options="header"] |==== | Port | Protocol | Service | Required For -| 7 | TCP and UDP | ICMP | DHCP Capsule to Client network, ICMP ECHO to verify IP address is free (Optional) -| 68 | UDP | DHCP | Capsule to Client broadcasts, DHCP broadcasts for Client provisioning from a Capsule (Optional) -| 8443 | TCP |HTTP | Capsule to Client "reboot" command to a discovered host during provisioning (Optional) +| 7 | TCP and UDP | ICMP | DHCP {SmartProxy} to Client network, ICMP ECHO to verify IP address is free (Optional) +| 68 | UDP | DHCP | {SmartProxy} to Client broadcasts, DHCP broadcasts for Client provisioning from a {SmartProxy} (Optional) +| 8443 | TCP |HTTP | {SmartProxy} to Client "reboot" command to a discovered host during provisioning (Optional) |==== -Any managed host that is directly connected to Satellite Server is a client in this context because it is a client of the integrated Capsule. This includes the base system on which a Capsule Server is running. +Any managed host that is directly connected to {ProjectServer} is a client in this context because it is a client of the integrated {SmartProxy}. This includes the base system on which a {SmartProxyServer} is running. .Optional Network Ports [cols="24%,20%,18%,38%a",options="header"] |==== | Port | Protocol | Service | Required For -| 22 | TCP | SSH | Satellite and Capsule originated communications, for Remote Execution (Rex) and Ansible. -| 7911 | TCP | DHCP | * Capsule originated commands for orchestration of DHCP records (local or external). +| 22 | TCP | SSH | {Project} and {SmartProxy} originated communications, for Remote Execution (Rex) and Ansible. +| 7911 | TCP | DHCP | * {SmartProxy} originated commands for orchestration of DHCP records (local or external). * If DHCP is provided by an external service, you must open the port on the external server. |==== -NOTE: A DHCP Capsule sends an ICMP ECHO to confirm an IP address is free, *no response* of any kind is expected. ICMP can be dropped by a networked-based firewall, but *any* response prevents the allocation of IP addresses. +NOTE: A DHCP {SmartProxy} sends an ICMP ECHO to confirm an IP address is free, *no response* of any kind is expected. ICMP can be dropped by a networked-based firewall, but *any* response prevents the allocation of IP addresses. diff --git a/guides/common/modules/ref_storage-guidelines.adoc b/guides/common/modules/ref_storage-guidelines.adoc index 1fe1d7db9c..35f0ea744a 100644 --- a/guides/common/modules/ref_storage-guidelines.adoc +++ b/guides/common/modules/ref_storage-guidelines.adoc @@ -2,11 +2,11 @@ = Storage Guidelines -Consider the following guidelines when installing Capsule Server to increase efficiency. +Consider the following guidelines when installing {SmartProxyServer} to increase efficiency. -* Because most Capsule Server data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. +* Because most {SmartProxyServer} data is stored within the `/var` directory, mounting `/var` on LVM storage can help the system to scale. -* For the `/var/lib/pulp/` and `/var/lib/mongodb/` directories, use high-bandwidth, low-latency storage, and solid state drives (SSD) rather than hard disk drives (HDD). As Red{nbsp}Hat Satellite has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on Satellite 6 Operations] for more information on using the `fio` tool. +* For the `/var/lib/pulp/` and `/var/lib/mongodb/` directories, use high-bandwidth, low-latency storage, and solid state drives (SSD) rather than hard disk drives (HDD). As {ProjectName} has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation. Ensure your installation has a speed in the range 60 - 80 Megabytes per second. You can use the `fio` tool to get this data. See the Red{nbsp}Hat Knowledgebase solution https://access.redhat.com/solutions/3397771[Impact of Disk Speed on {ProjectX} Operations] for more information on using the `fio` tool. * The `/var/lib/qpidd/` directory uses slightly more than 2 MB per Content Host managed by the `goferd` service. For example, 10 000 Content Hosts require 20 GB of disk space in `/var/lib/qpidd/`. @@ -14,7 +14,7 @@ Consider the following guidelines when installing Capsule Server to increase eff .File System Guidelines -* Use the XFS file system for Red{nbsp}Hat Satellite 6 because it does not have the inode limitations that `ext4` does. As Capsule Server uses a lot of symbolic links it is likely that your system may run out of inodes if using `ext4` and the default number of inodes. +* Use the XFS file system for {ProjectNameX} because it does not have the inode limitations that `ext4` does. As {SmartProxyServer} uses a lot of symbolic links it is likely that your system may run out of inodes if using `ext4` and the default number of inodes. * Do not use NFS with MongoDB because MongoDB does not use conventional I/O to access data files and performance problems occur when both the data files and the journal files are hosted on NFS. If required to use NFS, mount the volumes with the following option in the `/etc/fstab` file: `bg`, `nolock`, and `noatime`. diff --git a/guides/common/modules/ref_storage-requirements.adoc b/guides/common/modules/ref_storage-requirements.adoc index c91e9fcff6..9001ef32b2 100644 --- a/guides/common/modules/ref_storage-requirements.adoc +++ b/guides/common/modules/ref_storage-requirements.adoc @@ -6,7 +6,7 @@ The following table details storage requirements for specific directories. These The runtime size was measured with Red{nbsp}Hat Enterprise Linux 6, 7, and 8 repositories synchronized. -.Storage Requirements for Capsule Server Installation +.Storage Requirements for {SmartProxyServer} Installation [cols="1,1,1",options="header"] |==== |Directory |Installation Size |Runtime Size diff --git a/guides/common/modules/ref_supported-operating-systems.adoc b/guides/common/modules/ref_supported-operating-systems.adoc index 0b524edac4..13ef69a311 100644 --- a/guides/common/modules/ref_supported-operating-systems.adoc +++ b/guides/common/modules/ref_supported-operating-systems.adoc @@ -8,6 +8,6 @@ Red{nbsp}Hat {ProductName} requires a Red{nbsp}Hat Enterprise Linux installation Install {ProductName} on a freshly provisioned system. ifeval::["{context}" == "capsule"] -Do not register Capsule Server to the Red{nbsp}Hat Content Delivery Network (CDN). +Do not register {SmartProxyServer} to the Red{nbsp}Hat Content Delivery Network (CDN). endif::[] Red{nbsp}Hat does not support using the system for anything other than running {ProductName}. diff --git a/guides/common/modules/ref_system-requirements.adoc b/guides/common/modules/ref_system-requirements.adoc index 7b83477bcb..c867c874a3 100644 --- a/guides/common/modules/ref_system-requirements.adoc +++ b/guides/common/modules/ref_system-requirements.adoc @@ -9,15 +9,15 @@ The following requirements apply to the networked base system: * 4-core 2.0 GHz CPU at a minimum ifeval::["{context}" == "satellite"] -* A minimum of 20 GB memory is required for Satellite Server to function. In addition, a minimum of 4 GB of swap space is also recommended. Satellite running with less memory than the minimum value might not operate correctly. +* A minimum of 20 GB memory is required for {ProjectServer} to function. In addition, a minimum of 4 GB of swap space is also recommended. {Project} running with less memory than the minimum value might not operate correctly. endif::[] ifeval::["{context}" == "capsule"] -* A minimum of 12 GB memory is required for Capsule Server to function. In addition, a minimum of 4 GB of swap space is also recommended. Capsule running with less memory than the minimum value might not operate correctly. +* A minimum of 12 GB memory is required for {SmartProxyServer} to function. In addition, a minimum of 4 GB of swap space is also recommended. {SmartProxy} running with less memory than the minimum value might not operate correctly. endif::[] * A unique host name, which can contain lower-case letters, numbers, dots (.) and hyphens (-) -* A current Red Hat Satellite subscription +* A current {ProjectName} subscription * Administrative user (root) access * A system umask of 0022 * Full forward and reverse DNS resolution using a fully-qualified domain name @@ -38,10 +38,10 @@ Before you install {ProductName}, ensure that your environment meets the require * squid * puppet -NOTE: The Red Hat Satellite Server and Capsule Server versions must match. For example, a Satellite 6.2 Server cannot run a {ProductVersion} Capsule Server and a Satellite {ProductVersion} Server cannot run a 6.2 Capsule Server. Mismatching Satellite Server and Capsule Server versions results in the Capsule Server failing silently. +NOTE: The {ProjectName} Server and {SmartProxyServer} versions must match. For example, a {ProjectXY} Server cannot run a {ProductVersion} {SmartProxyServer} and a {Project} {ProductVersion} Server cannot run a 6.2 {SmartProxyServer}. Mismatching {ProjectServer} and {SmartProxyServer} versions results in the {SmartProxyServer} failing silently. ifeval::["{context}" == "capsule"] -For more information on scaling your Capsule Servers, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/capsule_server_scalability[Capsule Server Scalability Considerations]. +For more information on scaling your {SmartProxyServer}s, see https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_capsule_server/capsule_server_scalability[{SmartProxyServer} Scalability Considerations]. endif::[] .Certified hypervisors diff --git a/guides/common/modules/registering_subscription_management_satellite.adoc b/guides/common/modules/registering_subscription_management_satellite.adoc index 1b3c7ac36c..b9dddbe64c 100644 --- a/guides/common/modules/registering_subscription_management_satellite.adoc +++ b/guides/common/modules/registering_subscription_management_satellite.adoc @@ -2,7 +2,7 @@ = Registering to Red Hat Subscription Management -Registering the host to Red Hat Subscription Management enables the host to subscribe to and consume content for any subscriptions available to the user. This includes content such as Red Hat Enterprise Linux, Red Hat Software Collections (RHSCL), and Red Hat Satellite. +Registering the host to Red Hat Subscription Management enables the host to subscribe to and consume content for any subscriptions available to the user. This includes content such as Red Hat Enterprise Linux, Red Hat Software Collections (RHSCL), and {ProjectName}. Register your system with the Red Hat Content Delivery Network, entering your Customer Portal user name and password when prompted: [options="nowrap"] diff --git a/guides/common/modules/specifying_installation_options.adoc b/guides/common/modules/specifying_installation_options.adoc index 9352838c54..039f3ba896 100644 --- a/guides/common/modules/specifying_installation_options.adoc +++ b/guides/common/modules/specifying_installation_options.adoc @@ -2,15 +2,15 @@ = Specifying Installation Options -Satellite Server is installed using the `satellite-installer` installation script and as part of the initial configuration, you either automatically or manually configure Satellite. +{ProjectServer} is installed using the `{foreman-installer}` installation script and as part of the initial configuration, you either automatically or manually configure {Project}. Choose from one of these two methods: - - Automatic Configuration - This method is performed by using an answer file to automate the configuration process when running the installation script. An answer file is a file containing a list of parameters that are read by a command or script. The default Satellite answer file is `/etc/foreman-installer/scenarios.d/satellite-answers.yaml`. The answer file in use is set by the `answer_file` directive in the `/etc/foreman-installer/scenarios.d/satellite.yaml` configuration file. + - Automatic Configuration - This method is performed by using an answer file to automate the configuration process when running the installation script. An answer file is a file containing a list of parameters that are read by a command or script. The default {Project} answer file is `/etc/foreman-installer/scenarios.d/satellite-answers.yaml`. The answer file in use is set by the `answer_file` directive in the `/etc/foreman-installer/scenarios.d/satellite.yaml` configuration file. + To perform the initial configuration using the installation script with an answer file, see xref:performing_initial_configuration_sat_server_answerfile[]. - - Manual Configuration - This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the Satellite answer file. You can run the script as often as needed to configure any necessary options. + - Manual Configuration - This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the {Project} answer file. You can run the script as often as needed to configure any necessary options. + To perform the initial configuration using the installation script with command-line options, see xref:performing_initial_configuration_sat_server_manual[]. -NOTE: Depending on the options that you use when running the Satellite installer, the configuration can take several minutes to complete. An administrator is able to view the answer file to see previously used options for both methods. +NOTE: Depending on the options that you use when running the {Project} installer, the configuration can take several minutes to complete. An administrator is able to view the answer file to see previously used options for both methods. diff --git a/guides/common/modules/specifying_installation_options_disconnected.adoc b/guides/common/modules/specifying_installation_options_disconnected.adoc index 2f7df521e2..796268b627 100644 --- a/guides/common/modules/specifying_installation_options_disconnected.adoc +++ b/guides/common/modules/specifying_installation_options_disconnected.adoc @@ -2,15 +2,15 @@ = Specifying Installation Options -Satellite Server is installed using the `satellite-installer` installation script and as part of the initial configuration, you either automatically or manually configure Satellite. +{ProjectServer} is installed using the `{foreman-installer}` installation script and as part of the initial configuration, you either automatically or manually configure {Project}. Choose from one of these two methods: - - Automatic Configuration - This method is performed by using an answer file to automate the configuration process when running the installation script. An answer file is a file containing a list of parameters that are read by a command or script. The default Satellite answer file is `/etc/foreman-installer/scenarios.d/satellite-answers.yaml`. The answer file in use is set by the `answer_file` directive in the `/etc/foreman-installer/scenarios.d/satellite.yaml` configuration file. + - Automatic Configuration - This method is performed by using an answer file to automate the configuration process when running the installation script. An answer file is a file containing a list of parameters that are read by a command or script. The default {Project} answer file is `/etc/foreman-installer/scenarios.d/satellite-answers.yaml`. The answer file in use is set by the `answer_file` directive in the `/etc/foreman-installer/scenarios.d/satellite.yaml` configuration file. + To perform the initial configuration using the installation script with an answer file, see xref:performing_initial_configuration_sat_server_answerfile[]. - - Manual Configuration - This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the Satellite answer file. You can run the script as often as needed to configure any necessary options. + - Manual Configuration - This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the {Project} answer file. You can run the script as often as needed to configure any necessary options. + To perform the initial configuration using the installation script with command-line options, see xref:performing_initial_configuration_sat_server_manual_disconnected[]. -NOTE: Depending on the options that you use when running the Satellite installer, the configuration can take several minutes to complete. An administrator is able to view the answer file to see previously used options for both methods. +NOTE: Depending on the options that you use when running the {Project} installer, the configuration can take several minutes to complete. An administrator is able to view the answer file to see previously used options for both methods. diff --git a/guides/common/modules/supported_browsers.adoc b/guides/common/modules/supported_browsers.adoc index 4970e6903a..420c324c62 100644 --- a/guides/common/modules/supported_browsers.adoc +++ b/guides/common/modules/supported_browsers.adoc @@ -7,7 +7,7 @@ The following web browsers are fully supported: * Firefox versions 39 and later * Chrome versions 28 and later -The following web browsers are partially supported. The Satellite web UI +The following web browsers are partially supported. The {Project} web UI interface functions correctly but certain design elements may not align as expected: @@ -16,6 +16,6 @@ align as expected: * Internet Explorer versions 10 and 11 [NOTE] -The web UI and command-line interface for Satellite Server supports +The web UI and command-line interface for {ProjectServer} supports English, Portuguese, Simplified Chinese, Traditional Chinese, Korean, Japanese, Italian, Spanish, Russian, French, and German. diff --git a/guides/common/modules/synchronizing_the_satellite_tools_repository.adoc b/guides/common/modules/synchronizing_the_satellite_tools_repository.adoc index a526cfde47..3f0b5fc278 100644 --- a/guides/common/modules/synchronizing_the_satellite_tools_repository.adoc +++ b/guides/common/modules/synchronizing_the_satellite_tools_repository.adoc @@ -1,25 +1,25 @@ [[synchronizing_satellite_tools_repository]] -= Synchronizing the Satellite Tools Repository += Synchronizing the {Project} Tools Repository -Use this section to synchronize the Satellite Tools repository from the Red Hat Content Delivery Network (CDN) to your Satellite. -This repository repository provides the `katello-agent` and `puppet` packages for clients registered to Satellite Server. +Use this section to synchronize the {Project} Tools repository from the Red Hat Content Delivery Network (CDN) to your {Project}. +This repository repository provides the `katello-agent` and `puppet` packages for clients registered to {ProjectServer}. .Procedure -To synchronize the Satellite Tools repository, complete the following steps: +To synchronize the {Project} Tools repository, complete the following steps: -. In the Satellite web UI, navigate to *Content* > *Sync Status*. +. In the {Project} web UI, navigate to *Content* > *Sync Status*. + A list of product repositories available for synchronization is displayed. . Click the arrow next to the *Red{nbsp}Hat Enterprise Linux Server* product to view available content. -. Select *Red{nbsp}Hat Satellite Tools {ProductVersionRepoTitle} (for RHEL 7 Server) RPMs x86_64*. +. Select *{ProjectName} Tools {ProductVersionRepoTitle} (for RHEL 7 Server) RPMs x86_64*. . Click *Synchronize Now*. .For CLI Users -Synchronize your Satellite Tools repository using the `hammer repository synchronize` command: +Synchronize your {Project} Tools repository using the `hammer repository synchronize` command: [options="nowrap" subs="+quotes,attributes"] ---- diff --git a/guides/common/modules/tuning-satellite-server-with-predefined-profiles.adoc b/guides/common/modules/tuning-satellite-server-with-predefined-profiles.adoc index 62bc043131..3b92ac4339 100644 --- a/guides/common/modules/tuning-satellite-server-with-predefined-profiles.adoc +++ b/guides/common/modules/tuning-satellite-server-with-predefined-profiles.adoc @@ -1,9 +1,9 @@ [id='tuning-satellite-server-with-predefined-profiles'] -= Tuning Satellite Server with Predefined Profiles += Tuning {ProjectServer} with Predefined Profiles -If your Satellite deployment includes more than 5000 hosts, you can use predefined tuning profiles to improve performance of Satellite Server. -Choose one of the profiles depending on the number of hosts your Satellite manages and available hardware resources. The tuning profiles are available in the https://github.com/RedHatSatellite/satellite-support/tree/master/tuning-profiles[satellite-support GitHub repository]. +If your {Project} deployment includes more than 5000 hosts, you can use predefined tuning profiles to improve performance of {ProjectServer}. +Choose one of the profiles depending on the number of hosts your {Project} manages and available hardware resources. The tuning profiles are available in the https://github.com/RedHatSatellite/satellite-support/tree/master/tuning-profiles[satellite-support GitHub repository]. MEDIUM:: Number of managed hosts: 5001-10000 @@ -35,16 +35,16 @@ Number of CPU cores: 48+ .Procedure -To configure a tuning profile for your Satellite deployment, complete the following steps: +To configure a tuning profile for your {Project} deployment, complete the following steps: -. On Satellite Server, back up the `/etc/foreman-installer/custom-hiera.yaml` file to `custom-hiera.original`: +. On {ProjectServer}, back up the `/etc/foreman-installer/custom-hiera.yaml` file to `custom-hiera.original`: + ---- # mv /etc/foreman-installer/custom-hiera.yaml \ /etc/foreman-installer/custom-hiera.original ---- -. In your browser, navigate to https://github.com/RedHatSatellite/satellite-support/tree/master/tuning-profiles[tuning profiles] in the _satellite-support GitHub repository_ and click the profile that matches your Satellite deployment. +. In your browser, navigate to https://github.com/RedHatSatellite/satellite-support/tree/master/tuning-profiles[tuning profiles] in the _satellite-support GitHub repository_ and click the profile that matches your {Project} deployment. . Click the *Raw* button and preserve the URL to download the profile in the next step. @@ -55,7 +55,7 @@ To configure a tuning profile for your Satellite deployment, complete the follow # curl -O https://raw.githubusercontent.com/RedHatSatellite/satellite-support/master/tuning-profiles/_custom-hiera-large-64G.yaml_ ---- -. Copy the tuning profile that matches your Satellite deployment to `/etc/foreman-installer/custom-hiera.yaml`: +. Copy the tuning profile that matches your {Project} deployment to `/etc/foreman-installer/custom-hiera.yaml`: + [options="nowrap" subs="+quotes"] ---- @@ -64,15 +64,16 @@ To configure a tuning profile for your Satellite deployment, complete the follow . Optional: If you added custom settings to `custom-hiera.yaml`, copy them from the backed up to the new `custom-hiera.yaml` file: -. Optional: If you upgrade your Satellite, search the backed up `/etc/foreman-installer/custom-hiera.original` file for the strings in the following format and copy them to the new `/etc/foreman-installer/custom-hiera.yaml` file: +. Optional: If you upgrade your {Project}, search the backed up `/etc/foreman-installer/custom-hiera.original` file for the strings in the following format and copy them to the new `/etc/foreman-installer/custom-hiera.yaml` file: + ---- # Added by foreman-installer during upgrade, run the installer with --upgrade-mongo-storage to upgrade to WiredTiger. mongodb::server::storage_engine: 'mmapv1' ---- -. Enter the `satellite-installer` command with no arguments to apply settings: +. Enter the `{foreman-installer}` command with no arguments to apply settings: + +[options="nowrap", subs="+quotes,attributes"] ---- -# satellite-installer +# {foreman-installer} ---- diff --git a/guides/common/modules/uninstalling_parent.adoc b/guides/common/modules/uninstalling_parent.adoc index d1992be91e..6e2bd8c4a1 100644 --- a/guides/common/modules/uninstalling_parent.adoc +++ b/guides/common/modules/uninstalling_parent.adoc @@ -1,3 +1,3 @@ [[uninstalling_parent]] -If you no longer need Satellite Server or Capsule Server, you can uninstall them. \ No newline at end of file +If you no longer need {ProjectServer} or {SmartProxyServer}, you can uninstall them. \ No newline at end of file diff --git a/guides/common/modules/uninstalling_satellite_server.adoc b/guides/common/modules/uninstalling_satellite_server.adoc index 1c528bd369..eac3996486 100644 --- a/guides/common/modules/uninstalling_satellite_server.adoc +++ b/guides/common/modules/uninstalling_satellite_server.adoc @@ -1,8 +1,8 @@ [[uninstalling_satellite_and_capsule_servers]] -//= Uninstalling Satellite Server +//= Uninstalling {ProjectServer} -Uninstalling Satellite Server erases all applications used on the target system. If you use any applications or application data for purposes other than Satellite Server, you should back up the information before the removal process. +Uninstalling {ProjectServer} erases all applications used on the target system. If you use any applications or application data for purposes other than {ProjectServer}, you should back up the information before the removal process. .Before you Begin @@ -21,9 +21,9 @@ This script erases many packages and config files, such as the following importa * All Katello and Foreman Packages ==== -.Uninstall Satellite Server +.Uninstall {ProjectServer} -. Uninstall Satellite Server. +. Uninstall {ProjectServer}. + [options="nowrap"] ---- diff --git a/guides/common/modules/using_external_databases.adoc b/guides/common/modules/using_external_databases.adoc index 3b184b2f5a..06d8fe7734 100644 --- a/guides/common/modules/using_external_databases.adoc +++ b/guides/common/modules/using_external_databases.adoc @@ -1,75 +1,75 @@ [[using-external-databases]] -= Using External Databases with Satellite += Using External Databases with {Project} -As part of the installation process for Red Hat Satellite, the *satellite-installer* command installs MongoDB and PostgreSQL databases on the same server as Satellite. In certain Satellite deployments, using external databases can help with the server load. However, there are many factors that can affect Satellite Server's performance. Moving to an external database might not help your specific problem. +As part of the installation process for {ProjectName}, the *{foreman-installer}* command installs MongoDB and PostgreSQL databases on the same server as {Project}. In certain {Project} deployments, using external databases can help with the server load. However, there are many factors that can affect {ProjectServer}'s performance. Moving to an external database might not help your specific problem. Depending on your requirements, you can use external databases for either MongoDB or PostgreSQL database, or both. Red Hat does not provide support or tools for external database maintenance. This includes backups, upgrades, and database tuning. Customers using an external database require their own database administrator to support and maintain the database. -If your Satellite deployment requires external databases, use the following information to set up and point to external databases from Satellite. +If your {Project} deployment requires external databases, use the following information to set up and point to external databases from {Project}. .FIPS-related Restrictions -Until https://bugzilla.redhat.com/show_bug.cgi?id=1743706[BZ#1743706] is resolved, you cannot use an external MongoDB with Satellite in FIPS mode. +Until https://bugzilla.redhat.com/show_bug.cgi?id=1743706[BZ#1743706] is resolved, you cannot use an external MongoDB with {Project} in FIPS mode. [[sec-using-external-databases-mongodb_considerations]] == MongoDB as an External Database Considerations -Pulp uses the MongoDB database. If you want to use MongoDB as an external database, the following information can help you discern if this option is right for your Satellite configuration. +Pulp uses the MongoDB database. If you want to use MongoDB as an external database, the following information can help you discern if this option is right for your {Project} configuration. .Advantages of External MongoDB - * Increase in free memory and free CPU on Satellite - * Flexibility to tune the MongoDB server's system without adversely affecting Satellite operations + * Increase in free memory and free CPU on {Project} + * Flexibility to tune the MongoDB server's system without adversely affecting {Project} operations .Disadvantages of External MongoDB * Increase in deployment complexity that can make troubleshooting more difficult * An external MongoDB server is an additional system to patch and maintain -* If either the Satellite or the Mongo database server suffers a hardware or storage failure, Satellite is not operational -* If there is latency between the Satellite and the external database server, performance can suffer +* If either the {Project} or the Mongo database server suffers a hardware or storage failure, {Project} is not operational +* If there is latency between the {Project} and the external database server, performance can suffer -If you suspect that your Mongo database is slow, you can work with Red Hat Support to troubleshoot. You might be encountering a configuration problem or existing performance problems with Satellite 6 that moving to an external database server might not help. Red Hat Support can examine existing known issues and also work with the Satellite Engineering team to determine the root cause. +If you suspect that your Mongo database is slow, you can work with Red Hat Support to troubleshoot. You might be encountering a configuration problem or existing performance problems with {ProjectX} that moving to an external database server might not help. Red Hat Support can examine existing known issues and also work with the {Project} Engineering team to determine the root cause. [[sec-using-external-databases-postgresql_considerations]] == PostgreSQL as an External Database Considerations -Foreman, Katello, and Candlepin use the PostgreSQL database. If you want to use PostgreSQL as an external database, the following information can help you discern if this option is right for your Satellite configuration. +Foreman, Katello, and Candlepin use the PostgreSQL database. If you want to use PostgreSQL as an external database, the following information can help you discern if this option is right for your {Project} configuration. .Advantages of External PostgreSQL: -* Increase in free memory and free CPU on Satellite -* Flexibility to set `shared_buffers` on the PostgreSQL database to a high number without the risk of interfering with other services on Satellite -* Flexibility to tune the PostgreSQL server's system without adversely affecting Satellite operations +* Increase in free memory and free CPU on {Project} +* Flexibility to set `shared_buffers` on the PostgreSQL database to a high number without the risk of interfering with other services on {Project} +* Flexibility to tune the PostgreSQL server's system without adversely affecting {Project} operations .Disadvantages of External PostgreSQL * Increase in deployment complexity that can make troubleshooting more difficult * The external PostgreSQL server is an additional system to patch and maintain -* If either Satellite or the PostgreSQL database server suffers a hardware or storage failure, Satellite is not operational -* If there is latency between the Satellite server and database server, performance can suffer +* If either {Project} or the PostgreSQL database server suffers a hardware or storage failure, {Project} is not operational +* If there is latency between the {Project} server and database server, performance can suffer -If you suspect that the PostgreSQL database on your Satellite is causing performance problems, use the information in https://access.redhat.com/solutions/2780871[Satellite 6: How to enable postgres query logging to detect slow running queries] to determine if you have slow queries. Queries that take longer than one second are typically caused by performance issues with large installations, and moving to an external database might not help. If you have slow queries, contact Red Hat Support. +If you suspect that the PostgreSQL database on your {Project} is causing performance problems, use the information in https://access.redhat.com/solutions/2780871[{ProjectX}: How to enable postgres query logging to detect slow running queries] to determine if you have slow queries. Queries that take longer than one second are typically caused by performance issues with large installations, and moving to an external database might not help. If you have slow queries, contact Red Hat Support. [[sec-using-external-databases-overview]] == Overview -To create and use a remote database for Satellite, you must complete the following procedures: +To create and use a remote database for {Project}, you must complete the following procedures: . Use xref:hardware_storage_prerequisites[] to plan the storage requirements for your external databases . Prepare PostgreSQL with databases for Foreman and Candlepin and dedicated users owning them . Prepare MongoDB with user `pulp` owning the `pulp_database` -. Follow the initial steps to install Satellite and ensure that the databases are accessible from Satellite -. Edit the parameters of `satellite-installer` to point to the new databases, and run `satellite-installer` +. Follow the initial steps to install {Project} and ensure that the databases are accessible from {Project} +. Edit the parameters of `{foreman-installer}` to point to the new databases, and run `{foreman-installer}` .Preparing Red{nbsp}Hat Enterprise Linux Server 7 for Database Installation You require a freshly provisioned system with the latest Red{nbsp}Hat Enterprise Linux Server 7 that meets the storage requirements from xref:hardware_storage_prerequisites[]. -Subscriptions for Red{nbsp}Hat Software Collections and Red{nbsp}Hat Enterprise Linux do not provide the correct service level agreement for using Satellite with external databases. You must also attach a Satellite subscription to the base system that you want to use for the external database. +Subscriptions for Red{nbsp}Hat Software Collections and Red{nbsp}Hat Enterprise Linux do not provide the correct service level agreement for using {Project} with external databases. You must also attach a {Project} subscription to the base system that you want to use for the external database. -. Use the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#attaching-satellite-infrastructure-subscription_satellite[Attaching the Satellite Infrastructure Subscription] to attach a Satellite subscription to your server. +. Use the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/installing_satellite_server_from_a_connected_network/#attaching-satellite-infrastructure-subscription_satellite[Attaching the {Project} Infrastructure Subscription] to attach a {Project} subscription to your server. . To install MongoDB and PostgreSQL servers on Red{nbsp}Hat Enterprise Linux Server 7, you must disable all repositories and enable only the following repositories: + ----- @@ -81,7 +81,7 @@ Subscriptions for Red{nbsp}Hat Software Collections and Red{nbsp}Hat Enterprise [[proc-using-external-databases-installing_mongodb]] == Installing MongoDB -You can install only the same version of MongoDB that is installed with the `satellite-installer` tool during an internal database installation. You can install MongoDB using Red Hat Software Collections (RHSCL) repositories or from an external source, as long as the version is supported. Satellite supports MongoDB version 3.4. +You can install only the same version of MongoDB that is installed with the `{foreman-installer}` tool during an internal database installation. You can install MongoDB using Red Hat Software Collections (RHSCL) repositories or from an external source, as long as the version is supported. {Project} supports MongoDB version 3.4. . To install MongoDB, enter the following command: + @@ -135,7 +135,7 @@ security: # firewall-cmd --runtime-to-permanent ---- + -. From Satellite Server, test that you can access the database. If the connection succeeds, the command returns `1`. +. From {ProjectServer}, test that you can access the database. If the connection succeeds, the command returns `1`. + [options="nowrap" subs="quotes"] ---- @@ -146,7 +146,7 @@ security: [[proc-using-external-databases-installing_postgresql]] == Installing PostgreSQL -You can install only the same version of PostgreSQL that is installed with the `satellite-installer` tool during an internal database installation. Satellite supports only a specific version of PostgreSQL that is available through Red Hat Enterprise Linux Server 7 repositories. You can install PostgreSQL using *rhel-7-server-rpms* repositories or from an external source, as long as the version is supported. For more information about the repository that contains the supported version of PostgreSQL, and what version is supported, see the https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/package_manifest/[Package Manifest]. +You can install only the same version of PostgreSQL that is installed with the `{foreman-installer}` tool during an internal database installation. {Project} supports only a specific version of PostgreSQL that is available through Red Hat Enterprise Linux Server 7 repositories. You can install PostgreSQL using *rhel-7-server-rpms* repositories or from an external source, as long as the version is supported. For more information about the repository that contains the supported version of PostgreSQL, and what version is supported, see the https://access.redhat.com/documentation/en-us/red_hat_satellite/{ProductVersion}/html/package_manifest/[Package Manifest]. . To install PostgreSQL, enter the following command: + @@ -212,7 +212,7 @@ listen_addresses = '*' $ su - postgres -c psql ---- + -. Create two databases and dedicated roles, one for Satellite and one for Candlepin: +. Create two databases and dedicated roles, one for {Project} and one for Candlepin: + [options="nowrap" subs="verbatim,quotes"] ---- @@ -229,7 +229,7 @@ CREATE DATABASE candlepin OWNER candlepin; # \q ---- + -. From Satellite Server, test that you can access the database. If the connection succeeds, the commands return `1`. +. From {ProjectServer}, test that you can access the database. If the connection succeeds, the commands return `1`. + [options="nowrap" subs="verbatim,quotes"] ---- @@ -237,11 +237,11 @@ CREATE DATABASE candlepin OWNER candlepin; # PGPASSWORD='_Candlepin_Password_' psql -h _postgres.example.com_ -p 5432 -U candlepin -d candlepin -c "SELECT 1 as ping" ---- + -. To install and configure the remote database for Satellite, enter the following command: +. To install and configure the remote database for {Project}, enter the following command: + -[options="nowrap" subs="verbatim,quotes"] +[options="nowrap" subs="+quotes,attributes"] ---- -satellite-installer --scenario satellite \ +{foreman-installer} --scenario satellite \ --foreman-db-host _postgres.example.com_ \ --foreman-db-password _Foreman_Password_ \ --foreman-db-database foreman \ @@ -259,11 +259,15 @@ satellite-installer --scenario satellite \ You can query the status of your databases. For example, enter the following command with the `--only` and add `postgresql` or `rh-mongodb34-mongod`: For PostgreSQL, enter the following command: + +[options="nowrap" subs="quotes,attributes"] ---- -# satellite-maintain service status --only postgresql +# {foreman-maintain} service status --only postgresql ---- For MongoDB, enter the following command: + +[options="nowrap" subs="quotes,attributes"] ---- -# satellite-maintain service status --only rh-mongodb34-mongod +# {foreman-maintain} service status --only rh-mongodb34-mongod ---- diff --git a/guides/common/modules/using_insights_with_satellite_server.adoc b/guides/common/modules/using_insights_with_satellite_server.adoc index 33d16ad489..40130f7375 100644 --- a/guides/common/modules/using_insights_with_satellite_server.adoc +++ b/guides/common/modules/using_insights_with_satellite_server.adoc @@ -1,26 +1,26 @@ [id='using-insights-with-satellite-server_{context}'] -= Using Red{nbsp}Hat Insights with Satellite Server += Using Red{nbsp}Hat Insights with {ProjectServer} You can use Red{nbsp}Hat Insights to diagnose systems and downtime related to security exploits, performance degradation and stability failures. You can use the dashboard to quickly identify key risks to stability, security, and performance. You can sort by category, view details of the impact and resolution, and then determine what systems are affected. -Note that you do not require a Red{nbsp}Hat Insights entitlement in your subscription manifest. For more information about Satellite and Red{nbsp}Hat Insights, see https://access.redhat.com/products/red-hat-insights/#satellite[Red Hat Insights on Satellite Red Hat Enterprise Linux (RHEL)]. +Note that you do not require a Red{nbsp}Hat Insights entitlement in your subscription manifest. For more information about {Project} and Red{nbsp}Hat Insights, see https://access.redhat.com/products/red-hat-insights/#satellite[Red Hat Insights on {Project} Red Hat Enterprise Linux (RHEL)]. -To maintain your Satellite Server, and improve your ability to monitor and diagnose problems you might have with Satellite, install Red{nbsp}Hat Insights on Satellite Server and register Satellite Server with Red{nbsp}Hat Insights. +To maintain your {ProjectServer}, and improve your ability to monitor and diagnose problems you might have with {Project}, install Red{nbsp}Hat Insights on {ProjectServer} and register {ProjectServer} with Red{nbsp}Hat Insights. .Scheduling insights-client -Note that you can change the default schedule for running `insights-client` by configuring `insights-client.timer` on Satellite. For more information, see https://access.redhat.com/documentation/en-us/red_hat_insights/1.0/html/client_configuration_guide_for_red_hat_insights/changing-the-client-schedule[ Changing the insights-client schedule] in the _Client Configuration Guide for Red Hat Insights_. +Note that you can change the default schedule for running `insights-client` by configuring `insights-client.timer` on {Project}. For more information, see https://access.redhat.com/documentation/en-us/red_hat_insights/1.0/html/client_configuration_guide_for_red_hat_insights/changing-the-client-schedule[ Changing the insights-client schedule] in the _Client Configuration Guide for Red Hat Insights_. .Procedure -. To install Red{nbsp}Hat Insights on Satellite Server, enter the following command: +. To install Red{nbsp}Hat Insights on {ProjectServer}, enter the following command: + [options="nowrap" subs="+quotes,attributes"] ---- -# satellite-maintain packages install insights-client +# {foreman-maintain} packages install insights-client ---- + -. To register Satellite Server with Red{nbsp}Hat Insights, enter the following command: +. To register {ProjectServer} with Red{nbsp}Hat Insights, enter the following command: + ---- # insights-client --register diff --git a/guides/common/modules/verifying_dns_resolution.adoc b/guides/common/modules/verifying_dns_resolution.adoc index 9270f72de0..4caf3fdbf6 100644 --- a/guides/common/modules/verifying_dns_resolution.adoc +++ b/guides/common/modules/verifying_dns_resolution.adoc @@ -2,7 +2,7 @@ = Verifying DNS resolution -Verify the full forward and reverse DNS resolution using a fully-qualified domain name to prevent issues while installing Satellite. +Verify the full forward and reverse DNS resolution using a fully-qualified domain name to prevent issues while installing {Project}. Ensure that the host name and local host resolve correctly. [options="nowrap"] @@ -40,7 +40,7 @@ For more information, see the https://access.redhat.com/documentation/en-us/red_ [WARNING] ==== -Name resolution is critical to the operation of Satellite 6. If Satellite cannot +Name resolution is critical to the operation of {ProjectX}. If {Project} cannot properly resolve its fully qualified domain name, many options fail. Among these options are content management, subscription management, and provisioning. diff --git a/guides/doc-Installing_Capsule_Server/master.adoc b/guides/doc-Installing_Capsule_Server/master.adoc index a4fa4a1f5b..3d92783d14 100644 --- a/guides/doc-Installing_Capsule_Server/master.adoc +++ b/guides/doc-Installing_Capsule_Server/master.adoc @@ -9,40 +9,40 @@ endif::[] include::common/attributes.adoc[] :context: capsule -:ProductName: Capsule Server +:ProductName: {SmartProxyServer} -= Installing Capsule Server += Installing {SmartProxyServer} // Preparing your Environment for Installation include::common/assembly_preparing-environment-for-capsule-installation.adoc[leveloffset=+1] -// Installing Capsule Server +// Installing {SmartProxyServer} include::common/assembly_installing-capsule-server.adoc[leveloffset=+1] -// Performing Additional Configuration on Capsule Server +// Performing Additional Configuration on {SmartProxyServer} include::common/assembly_performing-additional-configuration-on-capsule-server.adoc[leveloffset=+1] == Configuring External Services -Use this section to configure your Red Hat Satellite Capsule Server to work with external DNS, DHCP and TFTP services. +Use this section to configure your {Project} {SmartProxyServer} to work with external DNS, DHCP and TFTP services. -// Configuring Capsule Server with External DNS Service +// Configuring {SmartProxyServer} with External DNS Service include::common/modules/proc_configuring-capsule-server-with-external-dns.adoc[leveloffset=+2] -// Configuring Capsule Server with External DHCP Service +// Configuring {SmartProxyServer} with External DHCP Service include::common/assembly_configuring-satellite-deployment-with-external-dhcp.adoc[leveloffset=+2] -// Configuring Capsule Server with External TFTP Service +// Configuring {SmartProxyServer} with External TFTP Service include::common/modules/proc_configuring-capsule-server-with-external-tftp.adoc[leveloffset=+2] // Configuring Satellite with External IdM DNS include::common/modules/configuring_satellite_external_idm_dns.adoc[leveloffset=+2] -//== Uninstalling Capsule Server +//== Uninstalling {SmartProxyServer} include::common/modules/proc_uninstalling-capsule-server.adoc[leveloffset=+1] :numbered!: -// Capsule Server Scalability Considerations +// {SmartProxyServer} Scalability Considerations include::common/modules/capsule_server_scalability.adoc[leveloffset=+1] diff --git a/guides/doc-Installing_Satellite_Server_Connected/master.adoc b/guides/doc-Installing_Satellite_Server_Connected/master.adoc index 32900ac8ba..c8aedd2385 100644 --- a/guides/doc-Installing_Satellite_Server_Connected/master.adoc +++ b/guides/doc-Installing_Satellite_Server_Connected/master.adoc @@ -9,9 +9,9 @@ endif::[] include::common/attributes.adoc[] :context: satellite -:ProductName: Satellite Server +:ProductName: {ProjectServer} -= Installing Satellite Server from a Connected Network += Installing {ProjectServer} from a Connected Network == Preparing your Environment for Installation // System Requirements @@ -30,7 +30,7 @@ include::common/modules/supported_browsers.adoc[leveloffset=+2] include::common/modules/con_ports-and-firewalls-requirements.adoc[leveloffset=+2] include::common/modules/ports_prerequisites.adoc[leveloffset=+2] -// Configuring Client Connections to Satellite +// Configuring Client Connections to {Project} include::common/modules/enabling_client_connections_to_satellite.adoc[leveloffset=+2] // Verifying Firewall Settings @@ -39,27 +39,27 @@ include::common/modules/proc_verifying-firewall-settings.adoc[leveloffset=+2] // Verifying DNS Resolution include::common/modules/verifying_dns_resolution.adoc[leveloffset=+2] -== Installing Satellite Server +== Installing {ProjectServer} -// Installing Satellite Server +// Installing {ProjectServer} include::common/modules/installing_overview.adoc[leveloffset=+1] -// Installing Satellite Server from a Connected Network +// Installing {ProjectServer} from a Connected Network include::common/modules/installing_satellite_connected_parent.adoc[leveloffset=+2] // Registering to Red Hat Subscription Management include::common/modules/registering_subscription_management_satellite.adoc[leveloffset=+3] -// Attaching the Satellite Infrastructure Subscription +// Attaching the {Project} Infrastructure Subscription include::common/modules/proc_attaching-satellite-infrastructure-subscription.adoc[leveloffset=+3] // Configuring Repositories include::common/modules/proc_configuring-repositories.adoc[leveloffset=+3] -// Installing Satellite Server +// Installing {ProjectServer} include::common/modules/installing_satellite_server_install_guide.adoc[leveloffset=+3] -// Performing the Initial Configuration of Satellite Server +// Performing the Initial Configuration of {ProjectServer} include::common/modules/performing_initial_configuration_sat_server_parent.adoc[leveloffset=+2] // Synchronizing the System Clock With chronyd @@ -81,45 +81,45 @@ include::common/modules/performing_initial_configuration_sat_server_answerfile.a include::common/modules/creating_and_installing_manifests.adoc[leveloffset=+2] -== Performing Additional Configuration on Satellite Server +== Performing Additional Configuration on {ProjectServer} // Performing Additional Configuration include::common/modules/performing_additional_configuration_satellite.adoc[leveloffset=+2] -// Using Red Hat Insights with Satellite +// Using Red Hat Insights with {Project} include::common/modules/using_insights_with_satellite_server.adoc[leveloffset=+2] -// Enabling the Satellite Tools Repository +// Enabling the {Project} Tools Repository include::common/modules/enabling_the_satellite_tools_repository.adoc[leveloffset=+2] -// Synchronizing the Satellite Tools Repository +// Synchronizing the {Project} Tools Repository include::common/modules/synchronizing_the_satellite_tools_repository.adoc[leveloffset=+2] -// Configuring Satellite Server with HTTP Proxy +// Configuring {ProjectServer} with HTTP Proxy include::common/modules/configuring_satellite_http_proxy.adoc[leveloffset=+2] // Enabling Power Management on Managed Hosts include::common/modules/proc_enabling-power-management-on-managed-hosts.adoc[leveloffset=+2] -// Configuring DNS, DHCP, and TFTP on Satellite Server +// Configuring DNS, DHCP, and TFTP on {ProjectServer} include::common/modules/proc_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2] // Disabling DNS, DHCP, and TFTP for Unmanaged Networks include::common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc[leveloffset=+2] -// Configuring Satellite Server for Outgoing Emails +// Configuring {ProjectServer} for Outgoing Emails include::common/modules/configuring_satellite_outgoing_emails.adoc[leveloffset=+2] -// Configuring Satellite with a Custom Server Certificate +// Configuring {Project} with a Custom Server Certificate include::common/assembly_configuring-satellite-custom-server-certificate.adoc[leveloffset=+2] -// Using External Databases with Satellite +// Using External Databases with {Project} include::common/modules/using_external_databases.adoc[leveloffset=+2] // Restricting Access to mongod include::common/modules/proc_restricting-access-to-mongod.adoc[leveloffset=+2] -// Tuning Satellite Server with Predefined Profiles +// Tuning {Project} with Predefined Profiles include::common/modules/tuning-satellite-server-with-predefined-profiles.adoc[leveloffset=+2] == Configuring External Services @@ -127,7 +127,7 @@ include::common/modules/tuning-satellite-server-with-predefined-profiles.adoc[le // Configuring External Services include::common/modules/configuring_satellite_external_services.adoc[leveloffset=+1] -// Configuring Satellite with External DNS Service +// Configuring {Project} with External DNS Service include::common/modules/configuring_satellite_external_dns.adoc[leveloffset=+2] // Verifying the External DNS Service @@ -142,19 +142,19 @@ include::common/modules/configuring_satellite_external_tftp.adoc[leveloffset=+2] // Configuring the Firewall for External TFTP Service include::common/modules/configuring_satellite_external_tftp_firewall.adoc[leveloffset=+3] -// Configuring Satellite with External IdM DNS +// Configuring {Project} with External IdM DNS include::common/modules/configuring_satellite_external_idm_dns.adoc[leveloffset=+2] -== Uninstalling Satellite Server +== Uninstalling {ProjectServer} -// Uninstalling Satellite Server and Capsule Server +// Uninstalling {ProjectServer} and {SmartProxyServer} include::common/modules/uninstalling_parent.adoc[leveloffset=+1] -// Uninstalling Satellite Server +// Uninstalling {ProjectServer} include::common/modules/uninstalling_satellite_server.adoc[leveloffset=+2] -// About Running Satellite on AWS +// About Running {Project} on AWS include::common/modules/AWS_Introduction.adoc[leveloffset=+1] // AWS Deployment Scenarios @@ -163,14 +163,14 @@ include::common/modules/AWS_Deployment_Scenarios.adoc[leveloffset=+1] // AWS Prerequisites include::common/modules/AWS_Prerequisites.adoc[leveloffset=+1] -// Installing Satellite on AWS +// Installing {Project} on AWS include::common/modules/AWS_Installing_Satellite_AWS.adoc[leveloffset=+1] -// Installing Capsule on AWS +// Installing {SmartProxy} on AWS include::common/modules/AWS_Installing_Capsule_on_AWS.adoc[leveloffset=+1] :numbered!: -// Applying Custom Configuration to Red Hat Satellite +// Applying Custom Configuration to {Project} include::common/modules/applying_custom_configuration_to_red_hat_satellite.adoc[leveloffset=+1] diff --git a/guides/doc-Installing_Satellite_Server_Disconnected/master.adoc b/guides/doc-Installing_Satellite_Server_Disconnected/master.adoc index d79e040cc9..1b687a5cf1 100644 --- a/guides/doc-Installing_Satellite_Server_Disconnected/master.adoc +++ b/guides/doc-Installing_Satellite_Server_Disconnected/master.adoc @@ -10,9 +10,9 @@ include::common/attributes.adoc[] :context: satellite :mode: disconnected -:ProductName: Satellite Server +:ProductName: {ProjectServer} -= Installing Satellite Server from a Disconnected Network += Installing {ProjectServer} from a Disconnected Network == Preparing your Environment for Installation // System Requirements @@ -31,7 +31,7 @@ include::common/modules/supported_browsers.adoc[leveloffset=+2] include::common/modules/con_ports-and-firewalls-requirements.adoc[leveloffset=+2] include::common/modules/ports_prerequisites_satellite_disconnected.adoc[leveloffset=+2] -// Configuring Client Connections to Satellite +// Configuring Client Connections to {Project} include::common/modules/enabling_client_connections_to_satellite.adoc[leveloffset=+2] @@ -42,9 +42,9 @@ include::common/modules/proc_verifying-firewall-settings.adoc[leveloffset=+2] include::common/modules/verifying_dns_resolution.adoc[leveloffset=+2] -== Installing Satellite Server +== Installing {ProjectServer} -// Installing Satellite Server +// Installing {ProjectServer} include::common/modules/installing_overview.adoc[leveloffset=+1] // Downloading and Installing from a Disconnected Network @@ -53,7 +53,7 @@ include::common/modules/downloading_installing_satellite_disconnected.adoc[level // Resolving Package Dependency Errors include::common/modules/proc_resolving-package-dependancy-errors.adoc[leveloffset=+2] -// Performing the Initial Configuration of Satellite Server +// Performing the Initial Configuration of {ProjectServer} include::common/modules/performing_initial_configuration_sat_server_parent.adoc[leveloffset=+2] // Synchronizing the System Clock With chronyd @@ -77,39 +77,39 @@ include::common/modules/creating_and_installing_manifests.adoc[leveloffset=+2] // Enabling Disconnected Mode include::common/modules/enabling-the-disconnected-mode.adoc[leveloffset=+3] -== Performing Additional Configuration on Satellite Server +== Performing Additional Configuration on {ProjectServer} // Performing Additional Configuration include::common/modules/performing_additional_configuration_satellite.adoc[leveloffset=+2] -// Installing the Satellite Tools Repository +// Installing the {Project} Tools Repository include::common/modules/enabling_the_satellite_tools_repository.adoc[leveloffset=+2] -// Synchronizing the Satellite Tools Repository +// Synchronizing the {Project} Tools Repository include::common/modules/synchronizing_the_satellite_tools_repository.adoc[leveloffset=+2] // Enabling Power Management on Managed Hosts include::common/modules/proc_enabling-power-management-on-managed-hosts.adoc[leveloffset=+2] -// Configuring DNS, DHCP, and TFTP on Satellite Server +// Configuring DNS, DHCP, and TFTP on {ProjectServer} include::common/modules/proc_configuring-dns-dhcp-and-tftp.adoc[leveloffset=+2] // Disabling DNS, DHCP, and TFTP for Unmanaged Networks include::common/modules/disabling_dns_dhcp_tftp_for_unmanaged_networks.adoc[leveloffset=+2] -// Configuring Satellite Server for Outgoing Emails +// Configuring {ProjectServer} for Outgoing Emails include::common/modules/configuring_satellite_outgoing_emails.adoc[leveloffset=+2] -// Configuring Satellite with a Custom Server Certificate +// Configuring {Project} with a Custom Server Certificate include::common/assembly_configuring-satellite-custom-server-certificate.adoc[leveloffset=+2] -// Using External Databases with Satellite +// Using External Databases with {Project} include::common/modules/using_external_databases.adoc[leveloffset=+2] // Restricting Access to mongod include::common/modules/proc_restricting-access-to-mongod.adoc[leveloffset=+2] -// Tuning Satellite Server with Predefined Profiles +// Tuning {ProjectServer} with Predefined Profiles include::common/modules/tuning-satellite-server-with-predefined-profiles.adoc[leveloffset=+2] == Configuring External Services @@ -117,7 +117,7 @@ include::common/modules/tuning-satellite-server-with-predefined-profiles.adoc[le // Configuring External Services include::common/modules/configuring_satellite_external_services.adoc[leveloffset=+1] -// Configuring Satellite with External DNS Service +// Configuring {Project} with External DNS Service include::common/modules/configuring_satellite_external_dns.adoc[leveloffset=+2] // Verifying the External DNS Service @@ -132,18 +132,18 @@ include::common/modules/configuring_satellite_external_tftp.adoc[leveloffset=+2] // Configuring the Firewall for External TFTP Service include::common/modules/configuring_satellite_external_tftp_firewall.adoc[leveloffset=+3] -// Configuring Satellite with External IdM DNS +// Configuring {Project} with External IdM DNS include::common/modules/configuring_satellite_external_idm_dns.adoc[leveloffset=+2] -== Uninstalling Satellite Server +== Uninstalling {ProjectServer} -// Uninstalling Satellite Server and Capsule Server +// Uninstalling {ProjectServer} and Capsule Server include::common/modules/uninstalling_parent.adoc[leveloffset=+1] -// Uninstalling Satellite Server +// Uninstalling {ProjectServer} include::common/modules/uninstalling_satellite_server.adoc[leveloffset=+2] :numbered!: -// Applying Custom Configuration to Red Hat Satellite +// Applying Custom Configuration to {Project} include::common/modules/applying_custom_configuration_to_red_hat_satellite.adoc[leveloffset=+1]