Skip to content

Commit

Permalink
Removed bug-tracking info from files, reformatted all files
Browse files Browse the repository at this point in the history
  • Loading branch information
tbazant committed Nov 1, 2022
1 parent 1873ea6 commit 07c42b3
Show file tree
Hide file tree
Showing 19 changed files with 2,818 additions and 2,930 deletions.
2 changes: 2 additions & 0 deletions list_alp_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/usr/bin/bash
cat xml/ALP.asm.xml | grep 'resource xml' | awk -F\" '{print "xml/"$4}'
202 changes: 97 additions & 105 deletions xml/concept-alp-deployment.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,76 +15,67 @@
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">
<info>
<title>Deployment</title>
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Documentation</dm:component>
<dm:product>ALP</dm:product>
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>no</dm:translation>
</dm:docmanager>
</info>
<section xml:id="what-is-alp-deployment">
<title>Introduction</title>
<para>
The &alp; (&alpshort;) is distributed as a pre-built raw disk image. You can
download the latest published image from <link
xlink:href="https://download.opensuse.org/repositories/SUSE:/ALP:/PUBLISH/images/"/>
and deploy it either with a minimal initial configuration (&jeos;
Firstboot), or use additional tools&mdash;&combustion; and
&ignition;&mdash;to specify a detailed system setup.
</para>
</section>
<section xml:id="alp-deployment-firstboot-detection">
<title>First boot detection</title>
<para>
The deployment configuration runs on the first boot only. To distinguish
between the first and subsequent boots, the flag file
<filename>/boot/writable/firstboot_happened</filename> is created after the
first boot finishes. If the file is not present in the file system, the
attribute <literal>ignition.firstboot</literal> is passed to the kernel
command line, which triggers the creation of <filename>initramfs</filename>
(&ignition;) or running a specific dracut module (&combustion;). After
completing the first boot, the
<filename>/boot/writable/firstboot_happened</filename> flag file is created.
</para>
<note>
<title>The flag file is always created</title>
<para>
Even though the configuration may not be successful, due to improper or
missing configuration files, the
<filename>/boot/writable/firstboot_happened</filename> flag file is
created.
</para>
</note>
<tip>
<para>
You may force the first boot configuration on subsequent boot by passing
the <literal>ignition.firstboot</literal> attribute to the kernel command
line or by deleting the
<filename>/boot/writable/firstboot_happened</filename> flag file.
</para>
</tip>
</section>
<section xml:id="alp-deployment-default-partitioning">
<title>Default partitioning</title>
<para>
The pre-built images are delivered with a default partitioning scheme. You
can change it during the first boot by using &ignition; or &combustion;.
</para>
<important>
<title>BTRFS is mandatory for the root file system</title>
<para>
If you intend to perform any changes to the default partitioning scheme,
the root file system must be BTRFS.
</para>
</important>
<para>
Each image has the following subvolumes:
</para>
<section xml:id="what-is-alp-deployment">
<title>Introduction</title>
<para>
The &alp; (&alpshort;) is distributed as a pre-built raw disk image. You
can download the latest published image from
<link xlink:href="&alp-dld-site;"/>
and deploy it either with a minimal initial configuration (&jeos;
Firstboot), or use additional tools&mdash;&combustion; and
&ignition;&mdash;to specify a detailed system setup.
</para>
</section>
<section xml:id="alp-deployment-firstboot-detection">
<title>First boot detection</title>
<para>
The deployment configuration runs on the first boot only. To distinguish
between the first and subsequent boots, the flag file
<filename>/boot/writable/firstboot_happened</filename> is created after
the first boot finishes. If the file is not present in the file system,
the attribute <literal>ignition.firstboot</literal> is passed to the
kernel command line, which triggers the creation of
<filename>initramfs</filename> (&ignition;) or running a specific dracut
module (&combustion;). After completing the first boot, the
<filename>/boot/writable/firstboot_happened</filename> flag file is
created.
</para>
<note>
<title>The flag file is always created</title>
<para>
Even though the configuration may not be successful, due to improper or
missing configuration files, the
<filename>/boot/writable/firstboot_happened</filename> flag file is
created.
</para>
</note>
<tip>
<para>
You may force the first boot configuration on subsequent boot by
passing the <literal>ignition.firstboot</literal> attribute to the
kernel command line or by deleting the
<filename>/boot/writable/firstboot_happened</filename> flag file.
</para>
</tip>
</section>
<section xml:id="alp-deployment-default-partitioning">
<title>Default partitioning</title>
<para>
The pre-built images are delivered with a default partitioning scheme.
You can change it during the first boot by using &ignition; or
&combustion;.
</para>
<important>
<title>BTRFS is mandatory for the root file system</title>
<para>
If you intend to perform any changes to the default partitioning
scheme, the root file system must be BTRFS.
</para>
</important>
<para>
Each image has the following subvolumes:
</para>
<screen>
/home
/root
Expand All @@ -93,45 +84,46 @@
/usr/local
/var
</screen>
<para>
The <literal>/etc</literal> directory is mounted as overlayfs, where the
upper directory is mounted to <filename>/var/lib/overlay/1/etc/</filename>.
</para>
<para>
You can recognize the subvolumes mounted by default by the option
<literal>x-initrd.mount</literal> in <filename>/etc/fstab</filename>. Other
subvolumes or partitions must be configured either by &ignition; or
&combustion;.
</para>
</section>
<section xml:id="related-alp-deployment">
<title>Related topics</title>
<itemizedlist>
<listitem>
<para>
For deploying with minimal configuration, refer to
<xref linkend="task-deploy-alp"/>.
The <literal>/etc</literal> directory is mounted as overlayfs, where the
upper directory is mounted to
<filename>/var/lib/overlay/1/etc/</filename>.
</para>
</listitem>
<listitem>
<para>
For adjusting the deployment with &ignition;, refer to
<xref
linkend="concept-configure-ignition"/>.
You can recognize the subvolumes mounted by default by the option
<literal>x-initrd.mount</literal> in <filename>/etc/fstab</filename>.
Other subvolumes or partitions must be configured either by &ignition; or
&combustion;.
</para>
</listitem>
<listitem>
<para>
For adjusting the deployment with &combustion;, refer to
<xref
</section>
<section xml:id="related-alp-deployment">
<title>Related topics</title>
<itemizedlist>
<listitem>
<para>
For deploying with minimal configuration, refer to
<xref linkend="task-deploy-alp"/>.
</para>
</listitem>
<listitem>
<para>
For adjusting the deployment with &ignition;, refer to
<xref
linkend="concept-configure-ignition"/>.
</para>
</listitem>
<listitem>
<para>
For adjusting the deployment with &combustion;, refer to
<xref
linkend="concept-configure-combustion"/>.
</para>
</listitem>
<listitem>
<para>
List
</para>
</listitem>
</itemizedlist>
</section>
</para>
</listitem>
<listitem>
<para>
List
</para>
</listitem>
</itemizedlist>
</section>
</article>
Loading

0 comments on commit 07c42b3

Please sign in to comment.