Copyright © 2006– 2018 SUSE LLC and contributors. All rights reserved.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled “GNU Free Documentation License”.
For SUSE trademarks, see http://www.suse.com/company/legal/. All other third-party trademarks are the property of their respective owners. Trademark symbols (®, ™ etc.) denote trademarks of SUSE and its affiliates. Asterisks (*) denote third-party trademarks.
All information found in this book has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither SUSE LLC, its affiliates, the authors nor the translators shall be held liable for possible errors or the consequences thereof.
The Repository Mirroring Tool (RMT) for SUSE Linux Enterprise 15 allows enterprise customers to optimize the management of SUSE Linux Enterprise software updates and subscription entitlements. It establishes a proxy system for SUSE® Customer Center with repositories and registration targets. This helps you to centrally manage software updates within a firewall on a per-system basis, while maintaining your corporate security policies and regulatory compliance.
RMT allows you to provision updates for all of your devices running a product based on SUSE Linux Enterprise. By downloading these updates once and distributing them throughout the enterprise, you can set more restrictive firewall policies. This also reduces bandwidth usage, as there is no need to download the same updates for each device. RMT is fully supported and available as a download for customers with an active SUSE Linux Enterprise product subscription.
Repository Mirroring Tool provides functionality that can be useful in many situations, including the following:
You want to update SUSE Linux Enterprise servers.
Not all machines in your environment can be connected to SUSE Customer Center to register and retrieve updates for bandwidth or security reasons.
There are SUSE Linux Enterprise hosts that are restricted and difficult to update without putting in place a custom update management solution.
You need to integrate additional external or internal repositories.
RMT replaces SMT (Subscription Management Tool) which was used for SLE 11 and SLE 12. For a feature comparison between RMT and SMT, see Table 2.1, “Feature Comparison”.
Chapters in this manual contain links to additional documentation resources that are available either on the system or on the Internet.
For an overview of the documentation available for your product and the latest documentation updates, refer to http://www.suse.com/documentation.
Several feedback channels are available:
For services and support options available for your product, refer to http://www.suse.com/support/.
Help for openSUSE is provided by the community. Refer to https://en.opensuse.org/Portal:Support for more information.
To report bugs for a product component, go to https://scc.suse.com/support/requests, log in, and click .
We want to hear your comments about and suggestions for this manual and the other documentation included with this product. Use the User Comments feature at the bottom of each page in the online documentation or go to http://www.suse.com/documentation/feedback.html and enter your comments there.
For feedback on the documentation of this product, you can also send a
mail to doc-team@suse.com
. Make sure to include the
document title, the product version and the publication date of the
documentation. To report errors or suggest enhancements, provide a concise
description of the problem and refer to the respective section number and
page (or URL).
The following notices and typographical conventions are used in this documentation:
/etc/passwd
: directory names and file names
PLACEHOLDER: replace PLACEHOLDER with the actual value
PATH
: the environment variable PATH
ls
, --help
: commands, options, and
parameters
user
: users or groups
package name : name of a package
Alt, Alt–F1: a key to press or a key combination; keys are shown in uppercase as on a keyboard
, › : menu items, buttons
x86_64 This paragraph is only relevant for the AMD64/Intel 64 architecture. The arrows mark the beginning and the end of the text block.
System z, POWER
This paragraph is only relevant for the architectures
IBM Z
and POWER
. The arrows
mark the beginning and the end of the text block.
Dancing Penguins (Chapter Penguins, ↑Another Manual): This is a reference to a chapter in another manual.
Commands that must be run with root
privileges. Often you can also
prefix these commands with the sudo
command to run them
as non-privileged user.
root #
command
tux >
sudo
command
Commands that can be run by non-privileged users.
tux >
command
Notices
Vital information you must be aware of before proceeding. Warns you about security issues, potential loss of data, damage to hardware, or physical hazards.
Important information you should be aware of before proceeding.
Additional information, for example about differences in software versions.
Helpful information, like a guideline or a piece of practical advice.
RMT is included in SUSE Linux Enterprise Server starting with version 15. Install RMT directly during the installation of SUSE Linux Enterprise Server or install it on a running system. After the packages are installed, use YaST to do an initial configuration.
To install it during installation, select the rmt-server package. The package selection is available in the Installation Settings step of the installation when selecting Software.
We recommend to check for available RMT updates immediately
after installing SUSE Linux Enterprise Server using the zypper patch
command. SUSE continuously releases maintenance updates for RMT,
and newer packages are likely to be available.
To install RMT on a running SUSE Linux Enterprise Server installation, use
zypper
:
tux >
sudo
zypper in rmt-server
Configure RMT with YaST as described in the following procedure. It is assumed that this procedure is executed on a newly installed system.
Start YaST with the rmt
module.
tux >
sudo
yast2 rmt
Alternatively, start YaST and select
› .Enter your organization credentials. To retrieve your credentials, refer to Section 3.1, “Mirroring Credentials”.
Enter credentials for a new MariaDB user and database name. This user will then be created. Then select
.
If a password for the MariaDB root
user is
already set, you are required to enter it. If no password is set
for root
, you are asked to enter a new one.
Enter a common name for the SSL certificates. The common name should usually be the fully qualified domain name (FQDN) of the server. Enter all domain names and IP addresses with which you want to reach the RMT server as alternative common names.
When all common names are entered, select
.
To view a final summary, select systemd
services and timers.
If you have a firewall enabled, allow access to ports 80 and 443.
When using the default zone public
, execute the
following commands:
tux >
sudo
firewall-cmd --zone=public --add-port=80/tcp --permanent
tux >
sudo
firewall-cmd --zone=public --add-port=443/tcp --permanent
tux >
sudo
firewall-cmd --reload
This chapter describes the migration from SMT on SLES 11 or 12 to RMT on SLES 15.
Carefully read this section. It contains vital information about the migration process.
We recommend that you install RMT on a newly installed SLES 15 host. RMT is not a complete replacement for SMT. It has a different workflow than SMT and only supports SUSE Linux Enterprise Server 12 and newer.
The settings of staged repositories will not be exported from SMT. Repositories that have been marked to be mirrored will be exported.
It's only possible to export repositories that are marked for mirroring.
Products no longer available on the organization subscriptions will not be available on RMT.
Systems and their activated products will be exported. SMT client jobs and patch status will not be exported from SMT.
Feature |
SMT |
RMT |
---|---|---|
Available on SLES 11 |
yes |
no |
Available on SLES 12 |
yes |
no |
Available on SLES 15 |
no |
yes |
Synchronize products with SUSE Customer Center |
yes |
yes |
Mirror RPMs from repositories |
yes |
yes |
Selective mirroring (specifying products to mirror) |
yes |
yes |
Serve RPMs via HTTP |
yes |
yes |
Registration of SLE 15 systems |
yes |
yes |
Registration of SLE 12 systems |
yes |
yes |
Registration of SLE 11 systems |
yes |
no |
Migration from SLE 12 to 15 |
yes |
yes |
Staging repositories |
yes |
no1 |
Offline mirroring |
yes |
yes |
NTLM Proxy support |
yes |
yes |
Custom repositories |
yes |
yes |
YaST installation wizard |
yes |
yes |
YaST management wizard |
yes |
no |
Client management |
yes |
no |
RedHat support (Extended Support) |
yes |
no2 |
Files deduplication |
yes |
yes |
Data transfer from SMT to RMT |
- |
yes |
Transfer registration data to SUSE Customer Center |
yes |
no |
Reporting |
yes |
no |
Custom TLS certificates for web-server |
yes |
yes |
Web-server |
Apache2 |
Nginx |
Platform |
Perl |
Ruby |
1) Functionality is offered by SUSE Manager.
2) RES support is planned for SLES 15 SP1.
Update your SMT server installation by running
zypper up
.
If you want to export your SSL certificates along with the rest of
the data, run smt-data-export
. Remember to keep
your certificates in a safe place.
If you do not want to export the SSL certificates from SMT run
smt-data-export --no-ssl-export
.
The exported configuration is now saved to
smt-export.XXXXXX.tar.gz
. Copy the file to a
location which can be accessed by the new RMT server.
To make sure your RMT installation is up-to-date, run
zypper up
.
Copy the exported .tar.gz
file to an empty
directory, then unpack it:
tux >
mkdir EMPTY_DIR
tux >
cd EMPTY_DIR
tux >
cp /PATH/TO/smt-export.XXXXXX.tar.gz ./
tux >
tar xf smt-export.XXXXXX.tar.gz
If you chose to export the SSL certificates from SMT, copy the
CA private key and certificate to
/etc/rmt/ssl/
:
tux >
sudo
cp ssl/cacert.key /etc/rmt/ssl/rmt-ca.key
tux >
sudo
cp ssl/cacert.pem /etc/rmt/ssl/rmt-ca.crt
Run the YaST RMT configuration module as described in Section 1.3, “RMT Configuration with YaST”. If you imported the SMT CA certificate, add the domain of the SMT server to the common names of the new SSL certificate.
Run the RMT synchronization to get the products and repositories data from SUSE Customer Center.
tux >
sudo
rmt-cli sync
Import the data from the SMT server.
tux >
sudo
rmt-data-import -d ./
Optional: If the URL of the RMT server changed, change the URL parameter of clients in the /etc/SUSEConnect to point to the new RMT server. Alternatively, change the DNS records to the re-assign the host name to the RMT server.
Optional: Move the mirrored repository data from to RMT and adjust the ownership of the copied data.
tux >
sudo
cp -r /var/www/htdocs/repo/* /var/lib/rmt/public/repo
tux >
sudo
chown -R _rmt:nginx /var/lib/rmt/public/repo
In case your SMT server contains custom repositories, which you would also like to mirror to the RMT server, you need to activate them before mirroring, since they are disabled by default.
Check for custom repositories by running:
tux >
sudo
rmt-cli repos custom list
A table of all custom repositories will be shown. the first column
contains the ID
of each repository and the
Mirror?
column will show false
.
Enable each custom repository you would like to mirror by running:
tux >
sudo
rmt-cli repos custom enable ID
Update the packages in the repositories by starting the mirroring process:
tux >
sudo
rmt-cli mirror
You can mirror the installation and update repositories on the RMT server. This way, you do not need to download updates on each machine, which saves time and bandwidth.
In its default configuration, RMT mirrors enabled product repositories automatically once every night.
When enabled repositories are fully mirrored, you can register
your client systems against RMT by running SUSEConnect
--url https://RMT_HOSTNAME
on
the client machine. After successful registration, the repositories
from the RMT server will be used by zypper on the client machine.
RMT does not support clients with SUSE Linux Enterprise Server versions 11 and below.
Before you create a local mirror of SUSE Linux Enterprise the repositories, you need appropriate organization credentials. You can obtain the credentials from SUSE Customer Center.
To get the credentials from SUSE Customer Center, follow these steps:
Visit SUSE Customer Center at http://scc.suse.com and log in.
If you are member of multiple organizations, chose the organization you want to work with from the sidebar on the left.
Select
in the top menu.The credentials are displayed in the top right corner.
To see the password, select the eye symbol.
The obtained credentials should be set with the YaST RMT Server
Configuration module or added directly to the
/etc/rmt.conf
file. For more information about the
/etc/rmt.conf
file, see
Section 5.3.1, “/etc/rmt.conf”.
The local RMT database needs to be updated periodically with the information downloaded from SUSE Customer Center. This includes information about available products and repositories.
The synchronization is done with the systemd
timer
rmt-server-sync.timer
. To view the status, for
example the next running time, use systemctl status
:
root #
systemctl status rmt-server-sync.timer
● rmt-server-sync.timer - RMT Sync timer Loaded: loaded (/usr/lib/systemd/system/rmt-server-sync.timer; enabled; vendor preset: disabled) Active: active (waiting) since Fri 2018-06-22 04:22:34 EDT; 2h 34min ago Trigger: Sat 2018-06-23 03:53:00 EDT; 20h left Jun 22 04:22:34 d31 systemd[1]: Started RMT Sync timer.
To update the RMT database manually, use the rmt-cli sync
command. For details, see Section 5.1.2, “sync
”.
Packages for enabled repositories are mirrored on your RMT server. Packages are downloaded periodically once a day. But the download can also be triggered manually at any time.
The periodic mirroring is done by the systemd
timer
rmt-server-mirror.timer
. To show the status, for
example the next running time, use systemctl
status
:
root #
systemctl status rmt-server-mirror.timer
● rmt-server-mirror.timer - RMT Mirror timer Loaded: loaded (/usr/lib/systemd/system/rmt-server-mirror.timer; enabled; vendor preset: disabled) Active: active (waiting) since Fri 2018-06-22 04:22:34 EDT; 2h 34min ago Trigger: Sat 2018-06-23 02:17:57 EDT; 19h left Jun 22 04:22:34 d31 systemd[1]: Started RMT Mirror timer.
To update the mirrored packages manually, use the rmt-cli
mirror
command. For details, see Section 5.1.6, “mirror
”.
Mirroring of repositories can be enabled or disabled individually or by stating a product. When repositories are enabled, it's packages are downloaded and updated during the mirroring process. To enable or disable mirroring of repositories, you either need the product string or ID, or the repository name or ID. In general, enabling or disabling a product is desired, because this automatically enables or disables all repositories associated with the product.
To enable or disable all repositories of a product, use the
rmt-cli product enable
ID
and rmt-cli product
disable ID
commands. To
retrieve an ID for a disabled but available product, use the
rmt-cli product list --all
command. To retrieve an
ID for an enabled product, use the rmt-cli product
list
command.
Example:
tux >
sudo
rmt-cli products list --all
+------+------------------+---------+--------------+----------------------+---------------+---------+---------------+ | ID | Name | Version | Architecture | Product string | Release stage | Mirror? | Last mirrored | +------+------------------+---------+--------------+----------------------+---------------+---------+---------------+ [...] | 1743 | SUSE Package Hub | 15 | x86_64 | PackageHub/15/x86_64 | released | false | | [...] +------+------------------+---------+--------------+----------------------+---------------+---------+---------------+tux >
sudo
rmt-cli product enable 1743
2 repo(s) successfully enabled.tux >
sudo
rmt-cli product disable 1743
2 repo(s) successfully disabled.
To enable or disable mirroring of specific repositories, use the
rmt-cli repo enable
ID
and rmt-cli repo
disable ID
commands. To
retrieve an ID for a disabled but available repository, use the
rmt-cli repo list --all
command. To retrieve an
ID for an enabled repository, use the rmt-cli repo
list
command.
Example:
tux >
sudo
rmt-cli repo list --all
+--------+-------------------------+-------------------------------------------+------------+---------+---------------+ | SCC ID | Name | Description | Mandatory? | Mirror? | Last mirrored | +--------+-------------------------+-------------------------------------------+------------+---------+---------------+ [...] | 3061 | SUSE-PackageHub-15-Pool | SUSE-PackageHub-15-Pool for sle-15-x86_64 | true | false | | [...] +--------+-------------------------+-------------------------------------------+------------+---------+---------------+tux >
sudo
rmt-cli repo enable 3061
Repository successfully enabled.tux >
sudo
rmt-cli repo disable 3061
Repository successfully disabled.
After you disable mirroring of a repository or product as described in Section 3.4, “Enabling and Disabling Mirroring of Repositories”, the mirrored data still remains on your local hard disk. This includes the mirrored RPM packages. To remove the data, manually remove the corresponding directory:
tux >
sudo
rm -r /usr/share/rmt/public/repo/SUSE/Products/PRODUCT/VERSION/ARCHITECTURE/
You can mirror custom repositories with the RMT server. These
repositories are not provided by the SUSE Customer Center. Repositories can be
provided by, for example, the Open Build Service, third party vendors, or created
with createrepo
.
Custom repositories can be attached to products. This allows you to connect multiple repositories with one command on a client registered to the RMT server.
The following example procedure illustrates the mirroring of a third-party repository.
Add the remote repository to the RMT server. Replace URL with the URL to the repository. Replace NAME with a name of your choice for the repository.
root #
rmt-cli repos custom add URL NAME
List all custom repositories to get the ID of the new repository.
root #
rmt-cli repos custom list
Optionally attach the new custom repository to a product. For
example, if the new custom repository is required by all desktop
clients, it can be attached to the SUSE Linux Enterprise Desktop
product.
root #
rmt-cli repos custom attach REPOSITORY_ID PRODUCT_ID
Replace REPOSITORY_ID with the ID of
the new custom repository. Replace
PRODUCT_ID with the ID of a product you
want the repository attached to. If you need to retrieve the
PRODUCT_ID, use the command
rmt-cli products list --all
.
Enable mirroring of the new custom repository.
root #
rmt-cli repos custom enable REPOSITORY_ID
To get a list of all available custom repositories commands, see
Section 5.1.4, “repos
”.
RMT has built-in functions to import and export data about available repositories and the mirrored packages. For example, this can be used to speed up the setup of a new RMT server by locally copying already mirrored RPM packages.
Another use case is the offline mode. It allows transferring data to a disconnected RMT server, for example to provide updates to computers in an air-gapped network.
The following procedure describes the transfer of data and mirrored
RPMs between two RMT servers with a USB drive. The server
sun
is connected to the SUSE Customer Center, while
sirius
is a server in an air-gapped network.
Log in on the server sun
.
root@sun #
rmt-cli sync
root@sun #
rmt-cli mirror
Connect a USB drive, assumed to be /dev/sdb
and mount it, for example in
/mnt/external
.
root@sun #
mount /dev/sdb1 /mnt/external
Export the data about available repositories and products.
root@sun #
rmt-cli export data /mnt/external/
Export the list of enabled repositories. The exported file is required for exporting the repositories in the next step.
root@sun #
rmt-cli export settings /mnt/external/
Export mirrored RPM packages. Depending on the size of mirrored repositories, this can take a long time.
root@sun #
rmt-cli export repos /mnt/external/
Unmount and unplug the disk from sun
and go to
sirius
.
root@sun #
umount /mnt/external
Connect the USB drive to sirius
and
mount it in /mnt/external
.
root@sirius #
mount /dev/sdb1 /mnt/external
Import the meta data about available repositories and products.
root@sirius #
rmt-cli import data /mnt/external/
Import mirrored RPM packages. Depending on the size of mirrored repositories, this can take a long time.
root@sirius #
rmt-cli import repos /mnt/external/
Enable repositories as required on the sirius
.
For details, see Section 3.4, “Enabling and Disabling Mirroring of Repositories”.
If your air-gapped server (sirius
) has many
enabled repositories, or if the enabled repositories change
frequently, we recommend to export the repository settings from
this server.
The exported settings can then by imported by the server connected
to the SUSE Customer Center (sun
). This ensures that
sun
downloads all data required by
sirius
.
Any machine running SUSE Linux Enterprise 12 or newer can be configured to register against RMT and download software updates from there, instead of communicating directly with the SUSE Customer Center.
To configure clients to use the RMT server, use one of the following methods:
Provide the required information with boot parameters. See Section 4.1, “Configuring Clients with Boot Parameters”.
Configure the clients using an AutoYaST profile. See Section 4.2, “Configuring Clients with AutoYaST Profile”.
Use the rmt-client-setup
command. See Section 4.3, “Configuring Clients with rmt-client-setup
”).
Use the YaST registration module during installation or later. See Section 4.4, “Configuring Clients with YaST”.
If you need the CA certificate of the RMT server find it at
/etc/rmt/ssl/rmt-ca.crt
and
https://RMT_SERVER/rmt.crt
.
Any client can be configured to use RMT by providing the
regurl
parameter during machine boot.
The parameter needs to be entered as
regurl=RMT_SERVER_URL
. The URL
needs to be in the following format:
https://FQDN
with
FQDN being the fully qualified host name of the
RMT server. It must be identical to the FQDN of the server certificate
used on the RMT server. Example:
regurl=https://rmt.example.com
Make sure the values you enter are correct. If regurl
has not been specified correctly, the registration of the update source
will fail.
If the RMT server gets a new certificate from an untrusted CA, the clients need to retrieve the new CA certificate file. YaST displays a dialog for importing a new certificate. If you confirm importing the new certificate, the old one is replaced with the new one.
Clients can be configured to register with RMT server via AutoYaST profile. For general information about creating AutoYaST profiles and preparing automatic installation, refer to the AutoYaST Guide. In this section, only RMT specific configuration is described.
To configure RMT specific data using AutoYaST, follow the steps for the relevant version of RMT client.
As root
, start YaST and select › to start the graphical AutoYaST front-end.
From a command line, you can start the graphical AutoYaST front-end with the
yast2 autoyast
command.
Open an existing profile using
› , create a profile based on the current system's configuration using › , or work with an empty profile.Select
› . An overview of the current configuration is shown.Click
.
Check regurl
. For the SSL
certificate location, you can use either HTTP or HTTPS based URLs.
Perform all other configuration needed for the systems to be deployed, then click
to return to the main screen.
Select autoinst.xml
.
rmt-client-setup
#
The /usr/share/rmt/public/tools/rmt-client-setup
script is provided in the package rmt-server.
This script allows you to configure a client machine to use an RMT
server. It can also be used to reconfigure an existing client to use
a different RMT server.
To configure a client machine to use RMT with
rmt-client-setup
, follow these steps:
Download rmt-client-setup
from the RMT server:
root #
curl http://RMT_SERVER/tools/rmt-client-setup --output rmt-client-setup
Run the script with the URL of the RMT server as parameter.
root #
sh rmt-client-setup https://RMT_SERVER/
Executing this script will import the RMT CA's certificate into the trusted store.
Alternatively, you can specify the correct fingerprint or path to
the server certificate. For details, see sh
rmt-client-setup --help
.
The script downloads the server's CA certificate. Accept it by pressing Y. The tool now performs all necessary modifications on the client.
Use SUSEConnect
to add more products. For
details, run SUSEConnect --help
.
To configure a client to perform the registration against an RMT server
use the YaST yast2 registration
.
On the client, the credentials are not necessary and you may leave the relevant fields empty. Click
and enter its URL. Then click until the exit from the module.
To list available modules and repositories, use SUSEConnect
--list-extensions
. Alternatively, you can also browse the
directory listing of the RMT server by visiting
https://RMT_SERVER/repo/
and its subdirectories.
SUSE Linux Enterprise clients registered against RMT can be migrated online to the latest service pack of the same major release the same way as clients registered against SUSE Customer Center. Before starting the migration, make sure that RMT has the required products available and mirrored.
For detailed information on the online migration, see Book “Upgrade Guide”, Chapter 1 “Upgrade Paths and Methods”.
This chapter describes the most important scripts, configuration files and certificates shipped with RMT.
The rmt-cli
command and its sub-commands are used
to manage the mirroring of repositories, registration of clients, and
reporting. systemd
is used for starting, stopping, restarting the
RMT service and for checking its status.
The basic configuration for RMT is stored in the
/etc/rmt.conf
.
The key command to manage the RMT is rmt-cli
(/usr/bin/rmt-cli
). The rmt-cli
command
should be used together with the sub-commands described in this
section. If the rmt-cli
command is used alone, it prints
a list of all available sub-commands. To get help for individual
sub-commands, use man rmt-cli
or rmt-cli help [subcommand]
.
The following sub-commands are available:
rmt-cli sync
Synchronize database with SUSE Customer Center.
rmt-cli products
List and modify products.
rmt-cli repos
List and modify repositories.
rmt-cli mirror
Mirror repositories.
rmt-cli import
Import commands for the offline mode.
rmt-cli export
Export commands for the offline mode.
rmt-cli version
Show RMT version.
The following sections explain each sub-command in detail.
sync
#
This command triggers the synchronization with the SUSE Customer Center instantly.
The command has no further options. The synchronization is also
triggered each night by the systemd
timer
rmt-server-sync.timer
.
During the synchronization, no data is uploaded to the SUSE Customer Center. This command for example updates local product definitions and repository data.
products
#List and modify products.
rmt-cli products list [--all] [--csv]
Lists the products that are enabled for mirroring. Use the
--all
flag to list all available products. Use
the --csv
flag to output the list in CSV
format. ls
can be used as a shortcut for
list
.
rmt-cli products enable [id | string]
Enables mandatory repositories of a product by its id or product string.
rmt-cli products disable [id | string]
Disables all repositories of a product by its id or product string.
repos
#rmt-cli repos list [--all] [--csv]
Lists the repositories that are enabled for mirroring. Use the
--all
flag to list all available repositories.
Use the --csv
flag to output the list in CSV
format. ls
can be used as a shortcut for
list
.
rmt-cli repos enable [id]
Enables mirroring of a single repository by its id.
rmt-cli repos disable [id]
Disables mirroring of a single repository by its id.
repos custom
#rmt-cli repos custom list [--csv]
Lists all your custom repositories. Use the
--csv
flag to output the list in CSV format.
ls
can be used as a shortcut for
list
.
rmt-cli repos custom add [url] [name]
Adds a new custom repository, for example:
rmt-cli repos custom add https://download.opensuse.org/repositories/Virtualization:/containers/SLE_12_SP3/ Virtualization:Containers
rmt-cli repos custom enable [id]
Enables mirroring of a custom repository.
rmt-cli repos custom disable [id]
Disables mirroring of a custom repository.
rmt-cli repos custom remove [id]
Removes a custom repository.
rmt-cli repos custom products [id]
Lists the products attached to the custom repository with given id.
rmt-cli repos custom attach [id] [product id]
Attaches an existing custom repository to a product.
rmt-cli repos custom detach [id] [product id]
Detaches an existing custom repository from a product.
mirror
#rmt-cli mirror
This command starts the mirroring process manually.
import
#This command is required for the offline mode. For details, see Section 3.7, “Exporting and Importing Repositories”.
rmt-cli import data [path]
Run this on the offline RMT to read the JSON files from given path and fill the local database with data.
rmt-cli import repos [path]
Run this on the offline RMT to import RPM packages.
export
#This command is required for the offline mode. For details, see Section 3.7, “Exporting and Importing Repositories”.
rmt-cli export data [path]
Run this on an online RMT to get the latest data from SUSE Customer Center and save it as JSON files at the specified path.
rmt-cli export settings [path]
Run this on the offline RMT to save the settings for enabled
repositories at given path as repos.json
.
rmt-cli export repos [path]
Run this on the offline RMT to export RPM packages.
version
#
Display the version of rmt-cli
.
systemd
Commands #
You can manage RMT-related services with the standard systemd
commands. The RMT server has the following services and timers:
rmt-server.target
A systemd
target that starts all required RMT components.
rmt-server.service
The RMT server.
rmt-server-migration.service
This server migrates the database to the newest schema, if required. There is no need to manually interact with this service.
rmt-server-sync.timer
This timer is responsible for periodically synchronizing all repository product data from the SUSE Customer Center.
rmt-server-mirror.timer
This timer is responsible for periodically synchronizing all RPMs from the SUSE Customer Center.
Use systemctl
to control the RMT services and timers.
The main RMT configuration file is /etc/rmt.conf
.
You can set most of the options with the YaST RMT Server module.
The only supported way of doing the initial configuration is with
yast2 rmt
as described in Section 1.3, “RMT Configuration with YaST”. Only the proxy
configuration has to be entered manually. The other configuration
parameters are documented for reference.
All available configuration options can be found in the
/etc/rmt.conf
file.
The mirroring
section lets you adjust mirroring
behavior.
mirror_src
Decides whether to mirror source RPM packages (architecture is
src
).
dedup_method
Creates hardlinks during mirroring when set to hardlink
.
If the file system does not support hardlinks, can be set to copy
instead.
Possible values: hardlink
,
copy
.
The http_client
section defines the global HTTP
connection settings of RMT.
verbose
Enables additional debug output to the systemd
journal.
proxy
The proxy server URL.
proxy_auth
This setting determines the
proxy authentication mechanism. Possible values are:
none
, basic
,
digest
, gssnegotiate
,
ntlm
, digest_ie
,
ntlm_wb
.
proxy_user
The proxy server user name.
proxy_password
The proxy server password.
The scc
section contains your mirroring
credentials for contacting the SUSE Customer Center. To obtain your mirroring
credentials, see Section 3.1, “Mirroring Credentials”.
Valid configuration keys for the section are:
username
Mirroring credentials user name.
password
Mirroring credentials password.
By default access to API endpoints consumed by
SUSEConnect
is limited to HTTPS only. nginx is
configured to use SSL certificate and private key from the following
locations:
Certificate: /etc/rmt/ssl/rmt-server.crt
Private key: /etc/rmt/ssl/rmt-server.key
YaST RMT module generates a custom certificate authority which is used to sign HTTPS certificates, which means that to register, this certificate authority must be trusted by the client machines:
For registrations during installation from the media or with YaST Registration module, a message will appear, prompting to trust the server certificate.
For registering a client system on the command line, use the
rmt-client-setup
script. For details, see
Section 4.3, “Configuring Clients with rmt-client-setup
”.
This chapter explains how to create a backup of your RMT server and to restore it.
This procedure details how to create a full backup of your RMT
server. It is assumed that you have an external disk or network share
mounted in /mnt/backup
which serves as a target
for the backup.
Change to the backup directory.
root #
cd /mnt/backup
Create a file containing a dump of your SQL database. You need to
provide the password you set for the rmt
database user during the installation.
root #
mysqldump -u rmt -p rmt > rmt_backup.sql
Optionally, create a copy of your mirrored data.
root #
mkdir repos
root #
rmt-cli export repos ./repos/
This procedure details how to restore your RMT server from a backup
created in Section 6.1, “Creating a Backup”. It is assumed that
the backup is mounted in /mnt/backup
. It is also
assumed that you are restoring the server on a newly installed
SLES.
Install and configure the RMT server as described in Chapter 1, RMT Installation and Configuration.
Go to the backup directory.
root #
cd /mnt/backup/
Use mysql
to remove the newly created database
and import the data.
root #
mysql -u rmt -p
Enter password: Welcome to the MariaDB monitor. Commands end with ; or \g. [...]MariaDB [(none)]>
DROP DATABASE rmt;
Query OK, 14 rows affected (0.84 sec)MariaDB [(none)]>
CREATE DATABASE rmt;
Query OK, 1 row affected (0.00 sec)MariaDB [(none)]>
use rmt;
Database changedMariaDB [rmt]>
source rmt_backup.sql;
[...]MariaDB [rmt]>
quit
Optionally, import the exported repositories.
root #
rmt-cli repos import ./repos/
Synchronize your data and update your repositories.
root #
rmt-cli sync
root #
rmt-cli mirror
HTTPS certificates should be regenerated before they expire or to include additional common alternative names. No additional actions are required on the client machines registered to RMT server if only HTTPS certificates are regenerated.
Stop nginx and rmt-server services:
root #
systemctl stop nginx
root #
systemctl stop rmt-server
Remove previously generated certificates.
root #
rm /etc/rmt/ssl/rmt-server.*
Run the yast rmt
module as described in Section 1.3, “RMT Configuration with YaST”.
CA certificates can be regenerated once they have expired or in case of security issues.
The newly generated CA certificate must be imported on all clients
registered to the RMT server. This can be done by running
rmt-client-setup
script on the client machines
as described in Section 4.3, “Configuring Clients with rmt-client-setup
”.
Stop nginx and rmt-server services.
root #
systemctl stop nginx
root #
systemctl stop rmt-server
Remove previously generated CA and HTTPS certificates.
root #
rm /etc/rmt/ssl/rmt-ca.*
root #
rm /etc/rmt/ssl/rmt-server.*
Run the yast rmt
module as described in Section 1.3, “RMT Configuration with YaST”.
This chapter lists content changes and updates for this document.
Migration from SMT to RMT: Custom repos are imported as disabled for mirror ((https://bugzilla.suse.com/show_bug.cgi?id=1116915).
In Section 4.3, “Configuring Clients with rmt-client-setup
”, fixed a typo
in a command (http
instead of
https
).
This appendix contains the GNU Free Documentation License version 1.2.
Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
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 non-commercially. 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 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.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
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 then there are none.
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.
You may copy and distribute the Document in any medium, either commercially or non-commercially, 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.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
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.
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:
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.
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.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.
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.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
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".
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.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the 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.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
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.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
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.
Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
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 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
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.