Skip to content

Commit

Permalink
Merge pull request #306 from SUSE/jhalackova_podman-compose
Browse files Browse the repository at this point in the history
Jhalackova podman compose
  • Loading branch information
lvicoun authored Mar 15, 2024
2 parents 6707907 + 040c7e0 commit 639e8ce
Show file tree
Hide file tree
Showing 15 changed files with 1,111 additions and 16 deletions.
15 changes: 15 additions & 0 deletions DC-Micro-compose
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## ----------------------------
## Doc Config File for the DB Assembly
## ----------------------------
##
## Basics
MAIN="docker-compose.asm.xml"
SRC_DIR="articles"

## Profiling
PROFOS="slemicro"
#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"
273 changes: 273 additions & 0 deletions articles/docker-compose.asm.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
<?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="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 -->
<!-- Concept files -->docker-compose-tools
<resources>
<resource xml:id="_docker-compose-tools" href="../concepts/docker-compose-tools.xml">
<description>Intro to tools</description>
</resource>
<resource xml:id="_docker-compose-podman-docker" href="../concepts/docker-compose-podman-docker.xml">
<description>About <literal>podman-docker</literal>
</description>
</resource>
<resource xml:id="_docker-compose-about" href="../concepts/docker-compose-about.xml">
<description>About &compose;</description>
</resource>
<resource xml:id="_podman-about" href="../concepts/podman-about.xml">
<description>About &podman;</description>
</resource>
</resources>
<!-- Tasks -->
<resources>
<resource xml:id="_docker-compose-podman-docker-installation" href="../tasks/docker-compose-podman-docker-installation.xml">
<description>Installing podman-docker</description>
</resource>
<resource xml:id="_docker-compose-deploying-application" href="../tasks/docker-compose-deploying-application.xml">
<description>Deploying a container-based application</description>
</resource>
<resource xml:id="_podman-installation" href="../tasks/podman-installation.xml">
<description>Installing podman-docker</description>
</resource>
<resource xml:id="_docker-compose-creating-application" href="../tasks/docker-compose-creating-application.xml">
<description>Creating containerized applications</description>
</resource>
<resource xml:id="_docker-compose-installing-compose" href="../tasks/docker-compose-installing-compose.xml">
<description>Installing &compose;</description>
</resource>
</resources>
<!-- References -->
<resources>
<resource xml:id="_docker-compose-yaml-reference" href="../references/docker-compose-yaml-reference.xml">
<description>compose.yml</description>
</resource>
<resource xml:id="_docker-compose-management" href="../references/docker-compose-management.xml">
<description>Stack management</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="docker-compose" xml:lang="en">
<merge>
<title>Managing Multi-Container Applications Using <literal>&compose;</literal></title>
<!-- 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-03-14</date>
<revdescription>
<itemizedlist>
<!-- Group by type of change (added/removed/changed)-->
<listitem>
<para>
Initial version
</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" content="x86;power" its:translate="no"/>
<meta name="productname" its:translate="no">
<!-- enter product name and version --><productname version="X.Y">&productname;</productname>
</meta>
<meta name="title" its:translate="yes">Docker-compose application stack</meta>
<meta name="description" its:translate="yes">Overview of docker-compose and its role in
creating container-based application stacks</meta>
<meta name="social-descr" its:translate="yes">Creating a container-based application stack</meta>
<!-- suitable category, comma-separated list of categories -->
<meta name="category" content="Systems Management" its:translate="no"/>
<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>
&compose; enables you to define and manage a multi-container
application. The tool simplifies the deployment of such an
application stack by using an easy-to-use definition file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
The article describes how to create a multi-container
application by using &compose;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
It takes approx. 20 minutes to read the article.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
You will be able to create your own container-based application
stack.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<para>
Application container images or the associated source files
that are used to build the application.
</para>
</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="_docker-compose-tools" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module resourceref="_podman-about" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module resourceref="_podman-installation" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<!-- pull in a topic and switch the title -->
<module resourceref="_docker-compose-podman-docker" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module resourceref="_docker-compose-podman-docker-installation" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_docker-compose-about" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module resourceref="_docker-compose-installing-compose" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
</module>
<module resourceref="_docker-compose-creating-application" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
<module resourceref="_docker-compose-yaml-reference" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module resourceref="_docker-compose-deploying-application" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_docker-compose-management" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
24 changes: 9 additions & 15 deletions common/generic-entities.ent
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<!ENTITY sleha "&sle; &ha;">
<!ENTITY hageo "Geo Clustering for &sleha;">


<!-- SUSE Manager -->
<!ENTITY susemgr "&suse; Manager">
<!ENTITY suma "&susemgr;">
Expand Down Expand Up @@ -209,25 +210,12 @@ use &deng;! -->


<!-- URLS -->
<!-- use stand-alone only, not as part of URLs, see Style Guide-->

<!ENTITY dsc "https://documentation.suse.com">
<!ENTITY dsc-sles "&dsc;/sles">
<!ENTITY dsc-sled "&dsc;/sled">
<!ENTITY dsc-ha "&dsc;/sle-ha">
<!ENTITY dsc-sap "&dsc;/sles-sap">
<!ENTITY dsc-ses "&dsc;/ses">
<!ENTITY dsc-suma "&dsc;/suma">
<!ENTITY dsc-caasp "&dsc;/suse-caasp">
<!ENTITY dsc-cap "&dsc;/suse-cap">
<!ENTITY dsc-soc "&dsc;/soc">


<!ENTITY beta-www "https://susedoc.github.io">

<!ENTITY doo "https://doc.opensuse.org">

<!ENTITY sc-rn "https://www.suse.com/releasenotes">

<!ENTITY sccurl "https://scc.suse.com/">

<!-- HARDWARE ARCHITECTURES AND PLATFORMS -->
Expand Down Expand Up @@ -352,6 +340,10 @@ use &deng;! -->
<!ENTITY ingress "Ingress">
<!ENTITY keepalived "Keepalived">

<!-- HPC -->

<!ENTITY hpc "High Performance Computing">
<!ENTITY hpcm "HPC module">


<!-- SLES FOR SAP -->
Expand All @@ -373,6 +365,7 @@ use &deng;! -->
<!ENTITY bci "&slea; Base Container Image">
<!ENTITY bcia "&slea; BCI">
<!ENTITY netavark "Netavark">
<!ENTITY compose "docker-compose">



Expand Down Expand Up @@ -531,6 +524,7 @@ use &deng;! -->
<!ENTITY sle_container_guide "Container Guide">
<!ENTITY sle_pcidss_guide "&pcidss; (&pcidssa;) Guide">
<!ENTITY sle_pcidss_guide_a "&pcidssa; Guide">
<!ENTITY hpc_guide "HPC Guide">


<!-- SLE Micro-specific -->
Expand Down Expand Up @@ -624,4 +618,4 @@ use &deng;! -->
<!ENTITY smtguide "Subscription Management Tool Guide">

<!-- SLE HA, old productname entity -->
<!ENTITY hasi "&ha;">
<!ENTITY hasi "&ha;">
Loading

0 comments on commit 639e8ce

Please sign in to comment.