Skip to content

Commit

Permalink
Added podman gide parts.
Browse files Browse the repository at this point in the history
  • Loading branch information
@lvicoun
lvicoun committed May 3, 2024
1 parent 884de63 commit 4a27e5a
Show file tree
Hide file tree
Showing 9 changed files with 845 additions and 2 deletions.
214 changes: 214 additions & 0 deletions articles/podman.asm.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE assembly
[
<!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 -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">
<!-- 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="_podman-about" href="../concepts/podman-about.xml">
<description>About &podman;</description>
</resource>
<resource xml:id="_podman-about-containers" href="../concepts/podman-about-containers.xml">
<description>About &podman;</description>
</resource>
</resources>
<!-- Tasks -->
<resources>
<resource xml:id="_podman-installation" href="../tasks/podman-installation.xml">
<description>&podman; installation</description>
</resource>
<resource xml:id="_podman-running-containers" href="../tasks/podman-running-containers.xml">
<description>Running containers</description>
</resource>
<resource xml:id="_podman-getting-images" href="../tasks/podman-getting-images.xml">
<description>Getting images</description>
</resource>
</resources>
<!-- References -->
<resources>
<resource xml:id="_reference-example" href="../references/reference.xml">
<description>Reference example</description>
</resource>
</resources>
<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="article-example" xml:lang="en">
<merge>
<title>Basic container management using &podman;</title>
<subtitle>Subtitle if necessary</subtitle>
<!-- Create revision history to enable versioning; add most recent entries at the top. -->
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
<revhistory xml:id="rh-USE-ROOT-ID">
<revision><date>2024-05-14</date>
<revdescription>
<itemizedlist>
<!-- Group by type of change (added/removed/changed)-->
<listitem><para>Initial versio</para>

</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
<!-- add author's e-mail -->
<meta name="maintainer" content="" its:translate="no"/>
<!-- ISO date of last update as YYYY-MM-DD -->
<meta name="updated" content="2037-11-16" its:translate="no"/>
<!-- this does not work yet. Use the dm tags listed below for now
<meta name="bugtracker" its:translate="no">
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
<phrase role="component">Non-product-specific documentation</phrase>
<phrase role="product">Smart Docs</phrase>
<phrase role="assignee">[email protected]</phrase>
</meta>
-->
<!-- not supported, yet. Use dm: tag for now
<meta name="translation" its:translate="no">
<phrase role="trans">yes</phrase>
<phrase role="language">de-de,cs-cz</phrase>
</meta>
-->
<!-- enter the platform identifier or a list of
identifiers, separated by ; -->
<!-- For a full list of meta tags and their values,
see https://confluence.suse.com/x/aQDWNg
-->
<meta name="architecture">
<phrase>&x86-64;</phrase>
<phrase>&power;</phrase>
</meta>
<!-- enter one or more product names and version -->
<meta name="productname" its:translate="no">
<productname version="X.Y">&productname;</productname>
</meta>
<meta name="title" its:translate="yes">short title for SEO and social media, max. 55 chars</meta>
<meta name="description" its:translate="yes">short description, max. 150 chars</meta>
<meta name="social-descr" its:translate="yes">ultrashort description for social media, max 55 chars</meta>
<!-- suitable categories -->
<meta name="category">
<phrase>Systems Management</phrase>
</meta>
<!-- Determines "filter by task" filter value -->
<meta name="task">
<phrase>Configuration</phrase>
<phrase>Installation</phrase>
</meta>
<meta name="series">Products &amp; Solutions</meta>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Smart Docs</dm:component>
<dm:product>Documentation</dm:product>
<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
Containers offer a lightweight virtualization method to run multiple virtual
environments (containers) simultaneously on a single host. &podman; is the default
tool on &productname; to manage the containers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
The article provides basic information about &podman; and how can be used to manage containers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
You will know what &podman; is, what is a container image and what is a container.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
Installed &podman;.
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<!-- 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">
<merge>
<title>You are a very special concept now!</title>
</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="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
61 changes: 61 additions & 0 deletions concepts/podman-about-containers.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<?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="podman-about-containers"
role="concept" 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>Concept</title><!-- can be changed via merge in the assembly -->
<!--add author's email address-->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract><!-- can be changed via merge in the assembly -->
<para>
Introductory text
</para>
</abstract>
</info>
<section xml:id="concept-example-what-is">
<title>What is foo bar?</title>
<para>
A paragraph of text, answering the question above and explaining the
aim/function of foo bar.
</para>
</section>
<section xml:id="concept-example-how-it-works">
<title>How does foo bar work?</title>
<para>
A paragraph of text, answering the question above and explaining the
mechanism behind foo bar.
</para>
<figure xml:id="fig-one">
<title>A figure</title>
<mediaobject>
<imageobject role="html">
<imagedata fileref="example.png"/>
</imageobject>
<imageobject role="fo">
<imagedata fileref="example.png" width="85%"/>
</imageobject>
</mediaobject>
</figure>
</section>
<section xml:id="concept-example-benefits">
<title>Benefits of foo bar</title>
<para>
A paragraph of text, pointing out the benefits of foo bar.
</para>
</section>
</topic>
4 changes: 2 additions & 2 deletions snippets/Micro-default-registries.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<important xmlns="http://docbook.org/ns/docbook" version="5.2"
<note xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>&opensuse; registry and &docker; Hub not enabled by default</title>
Expand All @@ -12,4 +12,4 @@ xmlns:xlink="http://www.w3.org/1999/xlink">
<filename>/etc/containers/registries.conf</filename> file as follows:
</para>
<screen>unqualified-search-registries = ["registry.suse.com", "registry.opensuse.org", "docker.io"]</screen>
</important>
</note>
62 changes: 62 additions & 0 deletions tasks/podman-deleting-containers.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?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="podman-removing-containers"
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>Removing containers</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>
Introductory text
</para>
</abstract>
</info>
<para>
To remove one or more unused container from the host, use the
<command>podman rm</command> command as follows:
</para>
<screen>&prompt.root;podman rm <replaceable>[OPTIONS]</replaceable> <replaceable>CONTAINER</replaceable></screen>
<para>
<replaceable>CONTAINER</replaceable> can be a container name or a
container ID.
</para>
<para>
The command does not remove the specified container if the container is
running. To remove a running container, use the <literal>-f</literal>
option.
</para>
<para>
For a complete list of <command>podman rm</command> options, run:
</para>
<screen>&prompt.root;podman rm --help</screen>
<note>
<title>Deleting all stopped containers</title>
<para>
You can delete all stopped containers from your host with a single
command:
</para>
<screen>&prompt.root;podman container prune</screen>
<para>
Make sure that each stopped container is intended to be removed
before you run the command, otherwise you might remove containers
that are still in use and were stopped only temporarily.
</para>
</note>
</topic>
Loading

0 comments on commit 4a27e5a

Please sign in to comment.