Skip to content

Commit

Permalink
Bz#1796445 (theforeman#86)
Browse files Browse the repository at this point in the history 
* upstreamized guides

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* Upstreamize master.adoc files ProductName attribute

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* Add satellite-maintain attribute

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* s/satellite-installer/foreman-installer

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* s/satellite.example.com/{foreman.example.com}

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* correct the foreman.example.com attribute

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445

* Add @trichard10's feedback

As part of

Bug 1796445 - Run the upstreamize.rb script on the installation guides

https://bugzilla.redhat.com/show_bug.cgi?id=1796445
  • Loading branch information
@melcorr
melcorr committed Feb 4, 2020
1 parent 7998a28 commit 722d0b6
Show file tree
Hide file tree
Showing 81 changed files with 680 additions and 673 deletions.
10 changes: 5 additions & 5 deletions guides/common/assembly_configuring-capsule-custom-server-certificate.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions guides/common/assembly_configuring-satellite-custom-server-certificate.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 11 additions & 11 deletions guides/common/assembly_installing-capsule-server.adoc
View file
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]


Expand Down
8 changes: 4 additions & 4 deletions guides/common/assembly_performing-additional-configuration-on-capsule-server.adoc
View file
Original file line number Diff line number Diff line change
@@ -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]
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions guides/common/assembly_preparing-environment-for-capsule-installation.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions guides/common/attributes.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions guides/common/modules/AWS_Deployment_Scenarios.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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*

Expand All @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions guides/common/modules/AWS_Installing_Capsule_on_AWS.adoc
View file
Original file line number Diff line number Diff line change
@@ -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].
4 changes: 2 additions & 2 deletions guides/common/modules/AWS_Installing_Satellite_AWS.adoc
View file
Original file line number Diff line number Diff line change
@@ -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}.

0 comments on commit 722d0b6

Please sign in to comment.