Uyuni Quickstart Guide
Uyuni Quickstart Guide
04
Quick Start Guide
April 19 2023
Table of Contents
Quick Start 1
1. Install Uyuni Server with openSUSE Leap 2
1.1. Software and Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2. Install Uyuni Server on openSUSE Leap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3. Set up Uyuni Server with YaST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4. Create the Main Administration Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5. Optional: Synchronizing Products from SUSE Customer Center . . . . . . . . . . . . . . . . . . . . . . . 4
2. Install Uyuni Proxy with openSUSE Leap 6
2.1. Mirror Uyuni Proxy software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2. Register the openSUSE Leap system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3. Install Uyuni Proxy on openSUSE Leap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4. Prepare the Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.5. Set Up the Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.6. Configure DHCP for PXE through Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.7. Reinstalling a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.8. More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3. GNU Free Documentation License 13
Quick Start
Updated: 2023-04-19
This guide shows you how to use install and configure a single Uyuni Server or Proxy.
It contains instructions for a selection of simple setup ups, workflows and some common use cases.
1 / 19 | Uyuni 2023.04
1.1. Software and Hardware Requirements
Swap space: 3 GB
The Uyuni Server software is available from [Link], and you can use zypper to retrieve
the software and install it.
1. Install openSUSE Leap as the base system, and ensure all available service packs and package
updates have been applied.
2. Configure a resolvable fully qualified domain name (FQDN) with YaST by navigating to System ›
Network Settings › Hostname/DNS.
3. At the command prompt, as root, add the repository for installing the Uyuni Server software:
repo=repositories/systemsmanagement:/
repo=${repo}Uyuni:/Stable/images/repo/Uyuni-Server-POOL-x86_64-Media1/
zypper ar [Link] uyuni-server-stable
zypper ref
zypper in patterns-uyuni_server
When the installation is complete, you can continue with Uyuni setup. For more information, see
Installation-and-upgrade › Uyuni-server-setup.
3. From the introduction screen select Uyuni Setup › Set up Uyuni from scratch and click Next to
continue.
4. Enter an email address to receive status notifications and click Next to continue. Uyuni can
sometimes send a large volume of notification emails. You can disable email notifications in the
Web UI after setup, if you need to.
5. Enter your certificate information and a password. Passwords must be at at least seven characters in
length, and must not contain spaces, single or double quotation marks (' or "), exclamation marks (
!), or dollar signs ($). Always store your passwords in a secure location.
If you need to also set up a Uyuni Proxy Server, ensure you have taken a
note of the certificate password.
When you have completed the Uyuni Web UI setup, you are taken to the Home › Overview page.
This section covers synchronizing with SCC from the Web UI and adding your first client channel.
Before you can synchronize software repositories with SCC, you will need to enter organization
credentials in Uyuni. The organization credentials give you access to the SUSE product downloads. You
will find your organization credentials in [Link]
A check mark icon is shown when the credentials are confirmed. When you have successfully entered the
new credentials, you can synchronize with SUSE Customer Center.
2. From the Setup Wizard page select the SUSE Products tab. Wait a moment for the products list to
populate. If you previously registered with SUSE Customer Center a list of products will populate the
table. This table lists architecture, channels, and status information.
3. If your SUSE Linux Enterprise client is based on x86_64 architecture scroll down the page and
select the check box for this channel now.
4. Add channels to Uyuni by selecting the check box to the left of each channel. Click the arrow symbol
to the left of the description to unfold a product and list available modules.
5. Click Add Products to start product synchronization.
When a channel is added, Uyuni will schedule the channel for synchronization. Depending on the number
and size of this channels, this can take a long time. You can monitor synchronization progress in the
Web UI.
For more information about using the setup wizard, see Reference › Admin.
When the channel synchronization process is complete, you can register and configure clients. For more
instructions, see Client-configuration › Registration-overview.
5 / 19 1.5. Optional: Synchronizing Products from SUSE Customer Center | Uyuni 2023.04
2.1. Mirror Uyuni Proxy software
• For more information about the stable version of Uyuni, see [Link]
[Link].
• For more information about the development version of Uyuni, see [Link]
pages/[Link].
spacewalk-common-channels \
opensuse_leap15_4 \
opensuse_leap15_4-non-oss \
opensuse_leap15_4-non-oss-updates \
opensuse_leap15_4-updates \
opensuse_leap15_4-backports-updates \
opensuse_leap15_4-sle-updates \
opensuse_leap15_4-uyuni-client \
uyuni-proxy-stable-leap-154
Instead of the uyuni-proxy-stable-leap-154 version you can also try the latest development
version, called uyuni-proxy-devel-leap. For more information, see Client-configuration ›
Clients-opensuseleap.
When you have installed openSUSE Leap on the proxy and configured the FQDN, you can prepare the
Uyuni Server, and register the openSUSE Leap system as a client.
and the other channels as child channels. For more information about activation keys, see Client-
configuration › Activation-keys.
2. Modify a bootstrap script for the proxy. Ensure you add the GPG key for Uyuni to the
ORG_GPG_KEY= parameter. For example:
ORG_GPG_KEY=[Link]
3. Bootstrap the client using the script. For more information, see Client-configuration ›
Registration-bootstrap.
4. Navigate to Salt › Keys and accept the key. When the key is accepted, the new proxy will show in
Systems › Overview in the Recently Registered Systems section.
5. Navigate to System Details › Software › Software Channels, and check that the proxy channel is
selected.
zypper in patterns-uyuni_proxy
• Alternatively, on the Uyuni Server, use the Web UI. Navigate to the details tab of the client, click
Software › Packages › Install, and schedule patterns-uyuni_proxy for installation.
1. Reboot the client.
The salt-broker service is automatically started after installation is complete. This service forwards the
Salt interactions to the Uyuni Server.
It is possible to arrange Salt proxies in a chain. In this case, the upstream proxy is
named parent.
Make sure the TCP ports 4505 and 4506 are open on the proxy. The proxy must be able to reach the
Uyuni Server or a parent proxy on these ports.
The proxy shares some SSL information with the Uyuni Server. You need to copy the certificate and its
key from the Uyuni Server or the parent proxy to the proxy you are setting up.
2. Copy the certificate and the key from the source to the new directory. In this example, the source
location is called PARENT. Replace this with the correct path:
scp root@<PARENT>:/root/ssl-build/RHN-ORG-PRIVATE-SSL-KEY .
scp root@<PARENT>:/root/ssl-build/RHN-ORG-TRUSTED-SSL-CERT .
scp root@<PARENT>:/root/ssl-build/[Link] .
To keep the security chain intact, the Uyuni Proxy functionality requires the SSL
certificate to be signed by the same CA as the Uyuni Server certificate. Using
certificates signed by different CAs for proxies and server is not supported. For
more information on how Uyuni handles certificates, see Administration › Ssl-
certs.
[Link]
2. Follow the prompts to set up the proxy. Leave a field blank and type Enter to use the default values
shown between square brackets.
Uyuni Parent
the Uyuni parent can be either another proxy or a server.
HTTP Proxy
A HTTP proxy enables your Uyuni Proxy to access the Web. This is needed if direct access to the
Web is prohibited by a firewall.
Traceback Email
An email address where to report problems.
Organization
The next questions are about the characteristics to use for the SSL certificate of the proxy. The
organization might be the same organization that was used on the server, unless of course your proxy
is not in the same organization as your main server.
Organization Unit
The default value here is the proxy’s hostname.
City
Further information attached to the proxy’s certificate.
State
Further information attached to the proxy’s certificate.
Country Code
In the country code field, enter the country code set during the Uyuni installation. For example, if
your proxy is in the US and your Uyuni is in DE, enter DE for the proxy.
The country code must be two upper case letters. For a complete list of
country codes, see [Link]
CA Password
Enter the password that was used for the certificate of your Uyuni Server.
Do You Want to Use an Existing SSH Key for Proxying SSH-Push Salt Minion?
Use this option if you want to reuse a SSH key that was used for SSH-Push Salt clients on the server.
If parts are missing, such as CA key and public certificate, the script prints commands that you must
execute to integrate the needed files. When the mandatory files are copied, run [Link]
again. If you receive an HTTP error during script execution, run the script again.
[Link] activates services required by Uyuni Proxy, such as squid, apache2, salt-
broker, and jabberd.
To check the status of the proxy system and its clients, click the proxy system’s details page on the
Web UI (Systems › System List › Proxy, then the system name). Connection and Proxy subtabs
display various status information.
If you want to PXE boot your clients from your Uyuni Proxy, you also need to synchronize the TFTP
data from the Uyuni Server. For more information about this synchronization, see Client-configuration ›
Autoinst-pxeboot.
zypper in susemanager-tftpsync-recv
2. On the proxy, run the [Link] setup script and enter the requested information:
[Link]
You need to provide the hostname and IP address of the Uyuni Server and the proxy. You also need
to enter the path to the tftpboot directory on the proxy.
zypper in susemanager-tftpsync
4. On the server, run [Link] setup script and enter the requested information:
[Link]
5. Run the script again with the fully qualified domain name of the proxy you are setting up. This
creates the configuration, and uploads it to the Uyuni Proxy:
[Link] FQDN_of_Proxy
cobbler sync
You can also synchronize after a change within Cobbler that needs to be synchronized immediately.
Otherwise Cobbler synchronization will run automatically when needed. For more information about
PXE booting, see Client-configuration › Autoinst-pxeboot.
next-server: <IP_Address_of_Proxy>
filename: "pxelinux.0"
This procedure describes software channel setup and registering the installed proxy with an activation key
as the Uyuni client.
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 Uyuni Proxy channel.
To raise an issue or propose a change to the documentation, use the links under the Resources menu on
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document
"free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with
or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for
the author and publisher a way to get credit for their work, while not being considered responsible for
modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves
be free in the same sense. It complements the GNU General Public License, which is a copyleft license
designed for free software.
We have designed this License in order to use it for manuals for free software, because free software
needs free documentation: a free program should come with manuals providing the same freedoms that
the software does. But this License is not limited to software manuals; it can be used for any textual work,
regardless of subject matter or whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
A "Modified Version" of the Document means any work containing the Document or a portion of it,
either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals
exclusively with the relationship of the publishers or authors of the Document to the Document’s overall
subject (or to related matters) and contains nothing that could fall directly within that overall subject.
(Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical connection with the subject or with related
matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of
Invariant Sections, in the notice that says that the Document is released under this License. If a section
does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The
Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover
Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose
specification is available to the general public, that is suitable for revising the document straightforwardly
with generic text editors or (for images composed of pixels) generic paint programs or (for drawings)
some widely available drawing editor, and that is suitable for input to text formatters or for automatic
translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise
Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage
subsequent modification by readers is not Transparent. An image format is not Transparent if used for any
substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input
format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming
simple HTML, PostScript or PDF designed for human modification. Examples of transparent image
formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and
edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools
are not generally available, and the machine-generated HTML, PostScript or PDF produced by some
word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed
to hold, legibly, the material this License requires to appear in the title page. For works in formats which
do not have any title page as such, "Title Page" means the text near the most prominent appearance of the
work’s title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or
contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands
for a specific section name mentioned below, such as "Acknowledgements", "Dedications",
"Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document
means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies
to the Document. These Warranty Disclaimers are considered to be included by reference in this License,
but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may
have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially,
provided that this License, the copyright notices, and the license notice saying this License applies to the
Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this
License. You may not use technical measures to obstruct or control the reading or further copying of the
copies you make or distribute. However, you may accept compensation in exchange for copies. If you
distribute a large enough number of copies you must also follow the conditions in section 3.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document,
numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover,
and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the
publisher of these copies. The front cover must present the full title with all words of the title equally
prominent and visible. You may add other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can
be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed
(as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either
include a machine-readable Transparent copy along with each Opaque copy, or state in or with each
Opaque copy a computer-network location from which the general network-using public has access to
download using public-standard network protocols a complete Transparent copy of the Document, free of
added material. If you use the latter option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible
at the stated location until at least one year after the last time you distribute an Opaque copy (directly or
through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing
any large number of copies, to give them a chance to provide you with an updated version of the
Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and
3 above, provided that you release the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution and modification of the Modified
Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from
those of previous versions (which should, if there were any, be listed in the History section of the
Document). You may use the same title as a previous version if the original publisher of that version
gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the
modifications in the Modified Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five), unless they release you from this
requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary
Sections and contain no material copied from the Document, you may at your option designate some or
all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the
Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your
Modified Version by various parties—for example, statements of peer review or that the text has been
approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a
Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any
one entity. If the Document already includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of, you may not add another; but you
may replace the old one, on explicit permission from the previous publisher that added the old one.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms
defined in section 4 above for modified versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of
your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections
may be replaced with a single copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by adding at the end of it, in parentheses, the
name of the original author or publisher of that section if known, or else a unique number. Make the same
adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents,
forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and
any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License,
and replace the individual copies of this License in the various documents with a single copy that is
included in the collection, provided that you follow the rules of this License for verbatim copying of each
of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this
License, provided you insert a copy of this License into the extracted document, and follow this License
in all other respects regarding verbatim copying of that document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the
Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the
Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole
aggregate.
8. TRANSLATION
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under
this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However, parties who have received copies, or
rights, from you under this License will not have their licenses terminated so long as such parties remain
in full compliance.
Each version of the License is given a distinguishing version number. If the Document specifies that a
particular numbered version of this License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or of any later version that has been
published (not as a draft) by the Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not as a draft) by the Free Software
Foundation.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “ with…Texts.” line
with this:
with the Invariant Sections being LIST THEIR TITLES, with the
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those
two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples
in parallel under your choice of free software license, such as the GNU General Public License, to permit
their use in free software.