Added usage and DC file.

SUSE · Apr 11, 2024 · 65a3e8f · 65a3e8f
1 parent 6eda1df
commit 65a3e8f
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 42 deletions.
diff --git a/DC-Micro-toolbox b/DC-Micro-toolbox
@@ -0,0 +1,15 @@
+## ---------------------------- 
+## Doc Config File for the DB Assembly 
+## ----------------------------
+##
+## Basics
+MAIN="toolbox-container.asm.xml"
+SRC_DIR="articles"
+
+## Profiling
+PROFOS="slmicro"
+#PROFARCH="x86_64;zseries;power;aarch64"
+
+## stylesheet location
+STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
+FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2021-ns"
diff --git a/articles/SLE_Micro_admin.asm.xml b/articles/SLE_Micro_admin.asm.xml
@@ -89,7 +89,7 @@
       <description>Adding health checker plugins</description>
     </resource>
 
-    <resource xml:id="_toolbox-starting" href="../tasks/toolbox-starting.xml">
+    <resource xml:id="_toolbox-starting-container" href="../tasks/toolbox-starting-container.xml">
       <description>Configuration of &nm;</description>
     </resource>
 
@@ -379,7 +379,7 @@
             <para/>
           </abstract>
   </merge>
-  <module resourceref="_toolbox-starting" renderas="section">
+  <module resourceref="_toolbox-starting-container" renderas="section">
     <merge>
     <abstract>
             <para/>

diff --git a/articles/toolbox-container.asm.xml b/articles/toolbox-container.asm.xml
@@ -18,36 +18,24 @@
   <!-- resources section references all topic chunks used in the final article
     -->
   <!-- R E S O U R C E S -->
-  <!-- Glue files -->
-  <resources>
-    <resource xml:id="_glue-example" href="../glues/glue.xml">
-      <description>Glue example</description>
-    </resource>
-    <resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
-      <description>Glue for more information</description>
-    </resource>
-    <resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
-      <description>Glue what's next</description>
-    </resource>
-  </resources>
+
   <!-- Concept files -->
   <resources>
-    <resource xml:id="_concept-example" href="../concepts/concept.xml">
-      <description>Concept example</description>
+    <resource xml:id="_toolbox" href="../concepts/toolbox.xml">
+      <description>About toolbox</description>
     </resource>
   </resources>
   <!-- Tasks -->
-  <resources>
-    <resource xml:id="_task-example" href="../tasks/task.xml">
-      <description>Task example</description>
+  <resources>toolbox-usage
+    <resource xml:id="_toolbox-starting-container" href="../tasks/toolbox-starting-container.xml">
+      <description>Creating the container</description>
     </resource>
-  </resources>
-  <!-- References -->
-  <resources>
-    <resource xml:id="_reference-example" href="../references/reference.xml">
-      <description>Reference example</description>
+    <resource xml:id="_toolbox-usage" href="../tasks/toolbox-usage.xml">
+      <description>Usage</description>
     </resource>
   </resources>
+
+
   <!-- Legal -->
   <resources>
     <resource href="../common/legal.xml" xml:id="_legal">
@@ -188,17 +176,27 @@
     <!-- pull in all the topic files you need -->
     <!-- pick the appropriate type of include to match your needs -->
     <!-- pull in a topic as is -->
-    <module resourceref="_glue-example" renderas="section"/>
-    <!-- pull in a topic and switch the title -->
-    <module resourceref="_concept-example" renderas="section">
+    <module resourceref="_toolbox" renderas="section">
       <merge>
-        <title>You are a very special concept now!</title>
+        <abstract>
+                <para/>
+              </abstract>
       </merge>
-    </module>
-    <module resourceref="_task-example" renderas="section"/>
-    <module resourceref="_reference-example" renderas="section"/>
-    <module resourceref="_glue-more-info" renderas="section"/>
-    <module resourceref="_glue-whats-next" renderas="section"/>
+      <module resourceref="_toolbox-starting-container" renderas="section">
+        <merge>
+        <abstract>
+                <para/>
+              </abstract>
+      </merge>
+      </module>
+      <module resourceref="_toolbox-usage" renderas="section">
+        <merge>
+        <abstract>
+                <para/>
+              </abstract>
+      </merge>
+      </module>
+      </module>
     <module resourceref="_legal"/>
     <module resourceref="_gfdl">
       <output renderas="appendix"/>

diff --git a/concepts/toolbox.xml b/concepts/toolbox.xml
@@ -36,8 +36,10 @@
  </para>
  <para>
   <literal>toolbox</literal> is a small script that pulls a container image and
-  runs a privileged container based on that image. In the toolbox container, you
-  can install any tool you want with <command>zypper</command> and then use the
-  tool without rebooting your system.
+  runs a privileged container based on that image. <literal>toolbox</literal> is stateful so if you
+  exit the container and start it later, the environment is exactly the same.
+ </para>
+ <para>
+  The root file system of the container is mounted on <filename>/media/root</filename>.
  </para>
 </topic>
diff --git a/tasks/toolbox-starting-container.xml b/tasks/toolbox-starting-container.xml
@@ -8,23 +8,23 @@
 <!-- point back to this document with a similar comment added to your legacy doc piece -->
 <!-- refer to README.md for file and id naming conventions -->
 <!-- metadata is dealt with on the assembly level -->
-<topic xml:id="toolbox-usage"
+<topic xml:id="toolbox-starting-container"
  role="task" xml:lang="en"
  xmlns="http://docbook.org/ns/docbook" version="5.2"
  xmlns:its="http://www.w3.org/2005/11/its"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:trans="http://docbook.org/ns/transclusion">
   <info>
-    <title>Using <literal>toolbox</literal></title>
+    <title>Starting <literal>toolbox</literal></title>
     <!-- can be changed via merge
       in the assembly -->
     <!-- add author's e-mail -->
     <meta name="maintainer" content="[email protected]" its:translate="no"/>
     <abstract>
       <!-- can be changed via merge in the assembly -->
       <para>
-        The topic describes how to use the <literal>toolbox</literal> utility.
+        The topic describes how to start the <literal>toolbox</literal> utility.
       </para>
     </abstract>
   </info>
@@ -47,7 +47,5 @@
       image and start a container based on that image.
     </para>
   </note>
-  <para>
-    When 
-  </para>
+
 </topic>
diff --git a/tasks/toolbox-usage.xml b/tasks/toolbox-usage.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
+<!-- This file can be edited downstream. -->
+<!DOCTYPE topic
+[
+  <!ENTITY % entities SYSTEM "../common/generic-entities.ent">
+    %entities;
+]>
+<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
+<!-- point back to this document with a similar comment added to your legacy doc piece -->
+<!-- refer to README.md for file and id naming conventions -->
+<!-- metadata is dealt with on the assembly level -->
+<topic xml:id="toolbox-usage"
+ role="task" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook" version="5.2"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:trans="http://docbook.org/ns/transclusion">
+  <info>
+    <title>Using <literal>toolbox</literal></title><!-- can be changed via merge
+in the assembly -->
+    <!-- add author's e-mail -->
+    <meta name="maintainer" content="jsindelarova@suse/com" its:translate="no"/>
+    <abstract><!-- can be changed via merge in the assembly -->
+      <para>
+       The topic covers installation of packages and where <literal>toolbox</literal> is mounted.
+      </para>
+    </abstract>
+  </info>
+  <para>
+    In the toolbox container, you
+  can install any tool you want with <command>zypper</command> and then use the
+  tool without rebooting your system.
+  </para>
+  <para>
+    As <literal>toolbox</literal> is statelful, you need to remove the container to start a clean
+    one. To do so, run:
+  </para>
+  <screen>&prompt.sudo;podman rm toolbox-<replaceable>USER</replaceable></screen>
+  <para>
+    For example, for the &rootuser; user:
+  </para>
+  <screen>&prompt.sudo;podman rm toolbox-root</screen>
+</topic>