Add modular RMT documentation with Ansible-based configuration by ngetahun · Pull Request #737 · SUSE/doc-modular

ngetahun · 2026-07-20T13:05:59Z

Summary

Ports the Repository Mirroring Tool (RMT) documentation into the modular topic-based format as three Smart Doc articles. The modular repo previously had no RMT documentation.

Content is migrated from the SLE RMT Guide (doc-sle) and updated for the new ansible-rmt-server playbook workflow, replacing the YaST-based setup — this is a modular port of SUSE/doc-sle#1945.

Articles added

Article	Assembly / DC
Installing and configuring an RMT server	`articles/rmt-installing-configuring.asm.xml`
Mirroring repositories on an RMT server	`articles/rmt-mirroring-repositories.asm.xml`
Migrating from SMT to RMT	`articles/rmt-migrating-from-smt.asm.xml`

25 topics (tasks/concepts/references/glues) + 3 assemblies + 3 DC files + 2 images.

Key changes carried over from the source PR

Installation: ansible-rmt-server package instead of yast2-rmt
Configuration: new &ansible; playbook section (ansible-playbook site.yml, group_vars/all.yml)
Certificate management: regeneration via the Ansible playbook (--tags certificates)
Credentials & SMT import: configured through Ansible variables
Removed the entire YaST configuration workflow

Notes

Cross-references to chapters not ported (RMT client setup, rmt-cli reference) link to the online RMT Guide.
Missing entities substituted (&prompt.root.sun;/&prompt.root.sirius; → &prompt.root;); the two required images were fetched from doc-sle.
maintainer/assignee metadata are left as placeholders and should be filled in before publishing.

Test plan

All three articles pass daps validate (DAPS 4 + geekodoc): Document is valid.
All three render to HTML with images and Ansible content intact

🤖 Generated with Claude Code

Port the Repository Mirroring Tool (RMT) documentation into the modular topic-based format as three Smart Doc articles: - Installing and configuring an RMT server - Mirroring repositories on an RMT server - Migrating from SMT to RMT Content is migrated from the SLE RMT Guide (doc-sle) and updated for the new ansible-rmt-server playbook workflow, replacing the YaST-based setup (port of SUSE/doc-sle#1945). Cross-references to un-ported chapters point to the online RMT Guide. All three articles pass DAPS 4 + geekodoc validation and render to HTML. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Amrita42 · 2026-07-24T09:00:03Z

Update: So I have cloned your forked repo and I am adding changes where needed. Once this is done , a team member will review for grammar/style.

SMT customers run SLES 12 SP5, which has no migration path to 16, so the article is out of scope for this doc set. The SLES 15 version remains in doc-sle (xml/rmt_migrate_from_smt.xml).

The ansible playbook has no certificates tag, and the server certificate it generates is self-signed, carries no common name or subject alternative names, and is overwritten on every run.

These articles document the ansible-based configuration, which is the 16 workflow. Say so explicitly and mark the links to the 15 guide as the yast-configured version.

Amrita42 · 2026-08-18T10:04:24Z

@lvicoun @dariavladykina please review and provide your feedback. thanks

dariavladykina

Hi Amrita, please see my editorial review. Thanks!

lvicoun

Hi Amrita,
please see my suggestions. What I haven't pointed is that I think most of the topics do not contain the maintainer.

lvicoun · 2026-08-24T10:59:10Z

+            <term>REQUIREMENTS</term>
+            <listitem>
+              <itemizedlist>
+                <listitem><para>A newly installed &productname;&nbsp;&productnumber; system or &minvm; image to host the &rmt; server. </para></listitem>


This is actually not true as you just need a machine as you can install the RMT during the system installation.

lvicoun · 2026-08-24T10:59:51Z

+              <itemizedlist>
+                <listitem><para>A newly installed &productname;&nbsp;&productnumber; system or &minvm; image to host the &rmt; server. </para></listitem>
+                <listitem><para>Valid &scc; organization credentials. </para></listitem>
+                <listitem><para>Sufficient local storage space (approximately 1.5 times the size of all enabled repositories). </para></listitem>


You cover that later, so decide if the proper value should be mentioned here or in the corresponding section.

lvicoun · 2026-08-24T11:03:33Z

+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Introduction</title>


I suggest to rework this section to cover only supported clients as the installation info is needed in the installation sections - here it may be easily skipped.

lvicoun · 2026-08-24T11:04:14Z

+    <title>Introduction</title>
+    <meta name="maintainer" content="" its:translate="no"/>
+  </info>
+  <para>


I think this para is not necessary and can be completely omitted.

lvicoun · 2026-08-24T11:06:11Z

+  </para>
+  <para>
+    The &rmt; server registers client systems running &slea;&nbsp;12 and newer,
+    including &productname;&nbsp;&productnumber; itself. To run the &rmt;


I don't think it is really needed to point the user to another release. The release number is there from whatever source you come to the article.

lvicoun · 2026-08-24T14:15:56Z

+  <tip>
+    <title>Manually remove repository data</title>
+    <para>
+      To delete disabled repository data, manually remove its corresponding


Suggested change

To delete disabled repository data, manually remove its corresponding

To manually delete disabled repository data, remove its corresponding

lvicoun · 2026-08-24T14:16:24Z

+      </para>
+    </abstract>
+  </info>
+  <para>


I suggest to moving this para into the abstract.

lvicoun · 2026-08-24T14:17:34Z

+    </abstract>
+  </info>
+  <para>
+    You can mirror custom repositories with the &rmt; server. These


I suggest moving this to the abstract.

lvicoun · 2026-08-24T14:18:42Z

+
+  <para>
+    To get a list of all available custom repositories commands, see
+    <link xlink:href="https://documentation.suse.com/sles/15-SP7/single-html/SLES-rmt/#sec-rmt-tools-rmt-cli">the <command>rmt-cli</command> command reference</link>.


Please remove this reference. We need to migrate the info.

lvicoun · 2026-08-24T14:27:10Z

+  <itemizedlist>
+    <listitem>
+      <para>
+        <link xlink:href="https://documentation.suse.com/sles/15-SP7/single-html/SLES-rmt/#sec-rmt-tools-rmt-cli">The <command>rmt-cli</command> command reference</link>


Please do not point to SLES 15 documentation.

Amrita42 self-assigned this Jul 22, 2026

Amrita42 added 2 commits July 24, 2026 14:27

maintainer updated

14fe540

updated maintainer for all 3 articles

27fd311

Amrita42 and others added 8 commits July 24, 2026 14:48

adds three dc-sap files

3a48ebb

updates to asm file

76c5b1f

self-review for article 1

34de9f2

apply geo gem for article 1

f4f3a1b

article 2-review and geo gem

feb29ee

remove smt to rmt migration article

95c7797

SMT customers run SLES 12 SP5, which has no migration path to 16, so the article is out of scope for this doc set. The SLES 15 version remains in doc-sle (xml/rmt_migrate_from_smt.xml).

correct certificate handling in regenerating certificates task

3e9f09a

The ansible playbook has no certificates tag, and the server certificate it generates is self-signed, carries no common name or subject alternative names, and is overwritten on every run.

state that the rmt server runs on sles 16.1

129c93a

These articles document the ansible-based configuration, which is the 16 workflow. Say so explicitly and mark the links to the 15 guide as the yast-configured version.

Amrita42 requested review from dariavladykina and lvicoun August 18, 2026 10:04

dariavladykina reviewed Aug 20, 2026

View reviewed changes

Amrita42 added 2 commits August 21, 2026 13:19

daria-feedback-1

027e5df

daria-feedback-2

589b8d3

lvicoun requested changes Aug 24, 2026

View reviewed changes

	To delete disabled repository data, manually remove its corresponding
	To manually delete disabled repository data, remove its corresponding

Uh oh!

Conversation

ngetahun commented Jul 20, 2026

Summary

Articles added

Key changes carried over from the source PR

Notes

Test plan

Uh oh!

Amrita42 commented Jul 24, 2026

Uh oh!

Amrita42 commented Aug 18, 2026

Uh oh!

dariavladykina left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lvicoun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants