Uyuni proxy #10177 ke

modules/client-configuration/pages/clients-opensuse.adoc

@@ -0,0 +1,133 @@
+[[clients-opensuse]]
+= Registering openSUSE Clients
+
+This section contains information about registering Salt clients running {ubuntu} operating systems.
+
+{productname} supports opensuse Leap 15 and 15.1 Clients using Salt.
+// Traditional clients are not supported.
+
+// [IMPORTANT]
+// ====
+// {suse} does not endorse or support {productname}.
+// ====
+
+Bootstrapping is supported for starting openSUSE clients and performing initial state runs such as setting repositories and performing profile updates.
+
+
+
+== Prepare to Register
+
+Some preparation is required before you can register {ubuntu} clients to the {productname} Server.
+
+////
+ifeval::[{suma-content} == true]
+
+// If we need this for openSUSE, cf. clients-ubuntu.adoc
+.Procedure: Adding client tools channels
+
+etc.
+
+////
+
+ifeval::[{uyuni-content} == true]
+.Procedure: Adding the openSUSE Channels
+
+. At the command prompt on the {productname} Server, as root, install the [systemitem]``spacewalk-utils`` package:
++
+----
+zypper in spacewalk-utils
+----
+. Add the openSUSE channels.
+For openSUSE Leap 15:
++
+----
+spacewalk-common-channels \
+opensuse_leap15_0 \
+opensuse_leap15_0-non-oss \
+opensuse_leap15_0-non-oss-updates \
+opensuse_leap15_0-updates \
+opensuse_leap15_0-uyuni-client
+----
++
+For openSUSE Leap 15.1:
++
+----
+spacewalk-common-channels \
+opensuse_leap15_1 \
+opensuse_leap15_1-non-oss \
+opensuse_leap15_1-non-oss-updates \
+opensuse_leap15_1-updates \
+opensuse_leap15_1-uyuni-client
+----
+
+. Synchronize the new custom channels.
+
+[IMPORTANT]
+====
+You need all the new channels fully synchronized before bootstrapping any openSUSE client.
+openSUSE channels can be very large.
+Synchronization can sometimes take several hours.
+====
+
+To synchronize, navigate to menu:Software[Manage > Channels], and for each channel you created, click it and:
+
+. Navigate to the [guimenu]``Repositories``.
+. Navigate to the [guimenu]``Sync``and click btn:[Sync Now] to begin synchronization immediately.
+
+You can also setup a scheduled syncronization from this screen.
+
+endif::[]
+
+== Monitor Synchronization Progress
+
+There are two ways to check if a channel has finished synchronizing:
+
+// ifeval::[{suma-content} == true]
+// * In the {productname} {webui}, navigate to menu:Admin[Setup Wizard] and select the [guimenu]``SUSE Products`` tab.
+// +
+// This dialog displays a completion bar for each product when they are being synchronized.
+// endif::[]
+ifeval::[{uyuni-content} == true]
+* In the {productname} {webui}, navigate to menu:Software[Manage > Channels], then click the channel associated to the repository.
+Navigate to the [guimenu]``Repositories``, then [guimenu]``Sync`` and check [systemitem]``Sync Status``
+endif::[]
+* Check the synchronization log file at the command prompt with [command]``tail -f /var/log/rhn/reposync/<channel-label>.log``.
++
+Each child channel will generate its own log during the synchronization progress.
+
+You will need to check all the base and child channel log files to be sure that the synchronization is complete.
+
+
+
+ifeval::[{uyuni-content} == true]
+== Trust GPG Keys on Clients
+
+By default, openSUSE does not trust the GPG key for {productname} openSUSE client tools.
+The clients can be successfully bootstrapped without the GPG key being trusted.
+However, they will not be able to install new client tool packages or update them.
+
+To fix this, add this key to the [systemitem]``ORG_GPG_KEY=`` parameter in all openSUSE bootstrap scripts:
+// CHECKIT
+----
+uyuni-gpg-pubkey-0d20833e.key
+----
+
+You do not need to delete any previously stored keys.
+
+If you are boostrapping clients from the {productname} {webui}, you will need to use a Salt state to trust the key.
+Create the salt state and assign it to the organization.
+You can then use an activation key and configuration channels to deploy the key to the clients.
+endif::[]
+
+
+
+== Register Clients
+
+. To register your openSUSE clients, you will need a bootstrap repository.
+Create the bootstrap repository at the command prompt, with this command:
++
+----
+mgr-create-bootstrap-repo --with-custom-channels
+----
+
+For more information on registering your clients, see xref:client-configuration:registration-overview.adoc[].

modules/installation/nav-installation-guide.adoc

@@ -38,6 +38,7 @@ ifeval::[{suma-content} == true]
 endif::[]
 ifeval::[{uyuni-content} == true]
 *** xref:install-uyuni.adoc[Install Uyuni Server with openSUSE]
+*** xref:install-proxy-uyuni.adoc[Install Uyuni Proxy with openSUSE]
 endif::[]
 // better disabling for now; needs a complete overhaul
 // 2019-06-04, ke :
@@ -51,9 +52,16 @@ ifeval::[{suma-content} == true]
 *** xref:server-setup.adoc[Server Setup]
 endif::[]
 ifeval::[{uyuni-content} == true]
-*** xref:uyuni-server-setup.adoc[Server Setup]
+*** xref:uyuni-server-setup.adoc[Uyuni Server Setup]
 endif::[]
+ifeval::[{suma-content} == true]
 *** xref:proxy-registration.adoc[Proxy Registration]
 *** xref:proxy-setup.adoc[Proxy Setup]
+endif::[]
+ifeval::[{uyuni-content} == true]
+*** xref:uyuni-proxy-registration.adoc[Uyuni Proxy Registration]
+*** xref:uyuni-proxy-setup.adoc[Uyuni Proxy Setup]
+endif::[]
+
 *** xref:pubcloud-setup.adoc[Public Cloud Setup]
 *** xref:setup-wizard.adoc[Setup Wizard]

modules/installation/pages/install-proxy-uyuni.adoc

@@ -0,0 +1,51 @@
+[[install-proxy-uyuni]]
+= Install {productname} Proxy with {opensuse}
+
+{productname} Proxy can be installed on {opensuse}.
+
+
+
+== Install {productname} Proxy on {opensuse} Leap 15.1
+
+.Procedure: Installing {opensuse} Leap 15.1 with Uyuni
+
+. Install {opensuse} Leap 15.1 and apply all package updates available.
+
+. Configure a resolvable fully qualified domain name (FQDN) with menu:yast[System > Network Settings > Hostname/DNS].
+
+. Add the repository with the {productname} Proxy software.
+As [systemitem]``root`` enter:
++
+
+// variable assignment to avoid overlong lines
+// https://download.opensuse.org/repositories/systemsmanagement:/Uyuni:/Stable/images/repo/Uyuni-Proxy-POOL-x86_64-Media1/
++
+----
+repo=repositories/systemsmanagement:/
+repo=${repo}Uyuni:/Stable/images/repo/Uyuni-Proxy-POOL-x86_64-Media1/
+zypper ar https://download.opensuse.org/$repo uyuni-proxy-stable
+----
+
+. Refresh metadata from the repositories.
+As [systemitem]``root`` enter:
++
+
+----
+zypper ref
+----
+
+. Install the pattern for the {productname} Proxy:
+As [systemitem]``root`` enter:
++
+
+----
+zypper in patterns-uyuni_proxy
+----
+
+. Reboot the {productname} Proxy.
+
+* For more information about the stable version of {productname}, see https://www.uyuni-project.org/pages/stable-version.html.
+* For more information about the development version of {productname}, see https://www.uyuni-project.org/pages/devel-version.html.
+
+When the installation is complete, you can continue with {productname} setup.
+For more information, see xref:installation:uyuni-proxy-registration.adoc[].

modules/installation/pages/proxy-setup.adoc

@@ -208,6 +208,7 @@ filename: "pxelinux.0"
 
 
 // REMARK: 2019-08-23, ke: this needs closer checking
+// see https://github.com/SUSE/spacewalk/issues/10521
 [[replacing.a.susemgrproxy]]
 == Replace a {susemgrproxy}
 

modules/installation/pages/uyuni-proxy-registration.adoc

@@ -0,0 +1,89 @@
+[[proxy-register]]
+= Proxy Registration
+
+Proxy systems are registered as Salt clients using a bootstrap script.
+
+This procedure describes software channel setup and registering the installed proxy with an activation key as a {productname} client.
+
+[IMPORTANT]
+====
+Before you can select the correct child channels while creating the activation key, ensure you have properly synchronized the openSUSE Leap channel with all the needed child channels and the {productname} Proxy channel.
+====
+
+// ==>>>> uyuni-proxy-stable-leap-151 channel
+
+
+[[proxy-register-procedure]]
+.Procedure: Registering the Proxy
+
+. First create openSUSE Leap and the {productname} Proxy channels with the [command]``spacewalk-common-channels`` command.
+[command]``spacewalk-common-channels`` is part of the [package]``spacewalk-utils`` package:
++
+----
+spacewalk-common-channels \
+opensuse_leap15_1 \
+opensuse_leap15_1-non-oss \
+opensuse_leap15_1-non-oss-updates \
+opensuse_leap15_1-updates \
+opensuse_leap15_1-uyuni-client \
+uyuni-proxy-stable-leap-151
+----
++
+For more information, see xref:client-configuration:clients-opensuse.adoc[].
+
+. Create the openSUSE Leap 15 Uyuni Client Tools Repository for bootstrapping, see xref:client-configuration:creating-a-tools-repository.adoc[].
+. Create an activation key with openSUSE Leap as a base channel and the other channels as child channels.
+For more information about activation keys, see xref:client-configuration:clients-and-activation-keys.adoc[].
++
+
+// // .Proxy Activation Key
+// // image::proxy-key.png[]
+// +
+// ////
+// . From the [guimenu]``Child Channels`` listing select the recommended
+// channels by clicking the ``include recommended`` icon:
+// +
+// * SLE-Module-Basesystem15-SP1-Pool
+// * SLE-Module-Basesystem15-SP1-Updates
+// * SLE-Module-Server-Applications15-SP1-Pool
+// * SLE-Module-Server-Applications15-SP1-Updates
+// * SLE-Module-SUSE-Manager-Proxy-4.0-Pool
+// * SLE-Module-SUSE-Manager-Proxy-4.0-Updates
+// +
+// The [systemitem]``SLE-Product-SUSE-Manager-Proxy-4.0-Updates`` channel is mandatory.
+// +
+// .Base and Child Proxy Channel
+// image::proxy-child.png[]
+
+
+. Modify a bootstrap script for the proxy.
+* Add the GPG key to the [systemitem]``ORG_GPG_KEY=`` parameter.
+For more information, see xref:client-configuration:clients-opensuse.adoc[].
+* OPTIONAL: If you want to run the proxy on a traditional client (system type ``Management``) uncheck [guimenu]``Bootstrap using Salt``.
+Using Salt is the default.
++
+// FIXME: I do not know whether changing to traditional is actually possible
++
+// What's up with:
+// Enable Remote Configuration
+// Enable Remote Commands
++
+For more information about bootstrap scripts, see
+xref:client-configuration:registration-bootstrap.adoc[].
++
+
+// .Modifying Bootstrap Script
+// image::proxy-bootstrap.png[]
+
+. Bootstrap the client using the script.
+For more information, see xref:client-configuration:registration-bootstrap.adoc[].
+. For Salt clients, navigate to menu:Salt[Keys] and accept the key.
+When the key is accepted, it will show in menu:Systems[Overview].
+. Navigate to menu:System Details[Software > Software Channels], and check that your proxy channel is selected.
++
+
+// .Proxy Channels
+// image::sles15-proxy-channels.png[]
+
+For setting up a registered {productname} Proxy, see
+xref:uyuni-proxy-setup.adoc[].