Skip to content

Commit

Permalink
Moved the default partitioning section.
Browse files Browse the repository at this point in the history
  • Loading branch information
lvicoun committed May 29, 2024
1 parent 67c8724 commit da1ac8a
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 81 deletions.
12 changes: 2 additions & 10 deletions articles/deployment-raw-images-bare-metal.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@
<resource xml:id="_deployment-first-boot-detection" href="../concepts/deployment-first-boot-detection.xml">
<description>First boot detection</description>
</resource>
<resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
<description>Default partitioning</description>
</resource>

<resource xml:id="_deployment-efiboot-record" href="../concepts/deployment-efiboot-record.xml">
<description>Adjusting UEFI boot</description>
</resource>
Expand Down Expand Up @@ -216,13 +214,7 @@
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_deployment-about-pre-built-images" renderas="section">
<module resourceref="_deployment-raw-partitioning" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>

<module resourceref="_deployment-first-boot-detection" renderas="section">
<merge>
<abstract>
Expand Down
12 changes: 2 additions & 10 deletions articles/deployment-raw-images-ibm-dasd.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
<resource xml:id="_deployment-first-boot-detection" href="../concepts/deployment-first-boot-detection.xml">
<description>First boot detection</description>
</resource>
<resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
<description>Default partitioning</description>
</resource>

<resource xml:id="_deployment-ibm-procedure-overview" href="../concepts/deployment-ibm-procedure-overview.xml">
<description>Overview of the deployment procedure</description>
</resource>
Expand Down Expand Up @@ -215,13 +213,7 @@
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_deployment-about-pre-built-images" renderas="section">
<module resourceref="_deployment-raw-partitioning" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>

<module resourceref="_deployment-first-boot-detection" renderas="section">
<merge>
<abstract>
Expand Down
14 changes: 2 additions & 12 deletions articles/deployment-raw-images-virtual-machines.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,7 @@
</resource>
<resource xml:id="_deployment-first-boot-detection" href="../concepts/deployment-first-boot-detection.xml">
<description>First boot detection</description>
</resource>
<resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
<description>Default partitioning</description>
</resource>
</resource>
</resources>
<!-- Tasks -->
<resources>
Expand Down Expand Up @@ -226,14 +223,7 @@
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_deployment-about-pre-built-images" renderas="section">
<module resourceref="_deployment-raw-partitioning" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module resourceref="_deployment-first-boot-detection" renderas="section">
<module resourceref="_deployment-first-boot-detection" renderas="section">
<merge>
<abstract>
<para/>
Expand Down
12 changes: 2 additions & 10 deletions articles/deployment-selfinstall-images-bare-metal.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@
<resource xml:id="_deployment-first-boot-detection" href="../concepts/deployment-first-boot-detection.xml">
<description>First boot detection</description>
</resource>
<resource xml:id="_deployment-raw-partitioning" href="../concepts/deployment-raw-partitioning.xml">
<description>Default partitioning</description>
</resource>

<resource xml:id="_deployment-efiboot-record" href="../concepts/deployment-efiboot-record.xml">
<description>Adjusting UEFI boot</description>
</resource>
Expand Down Expand Up @@ -210,13 +208,7 @@
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_deployment-about-pre-built-images" renderas="section">
<module resourceref="_deployment-raw-partitioning" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>

<module resourceref="_deployment-first-boot-detection" renderas="section">
<merge>
<abstract>
Expand Down
1 change: 1 addition & 0 deletions references/combustion-configuration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
characters. If you create your password manually, use even more than 10
characters and combine uppercase and lowercase letters and numbers.
</para>
<xi:include href="../snippets/deployment-raw-partitioning.xml"/>
<section xml:id="deployment-combustion-network">
<title>Network configuration</title>
<para>
Expand Down
20 changes: 6 additions & 14 deletions references/ignition-configuration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,11 @@
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<title>&ignition; configuration examples</title>
</info>
<section xml:id="sec-ignition-examples">
<title>Configuration examples</title>

<para>
This section provides several examples of the &ignition; configuration in
the built-in JSON format.
</para>
<important>
<para>
<xref linkend="deployment-default-partitioning"/> lists subvolumes that
are mounted by default when running the pre-built image. If you want to
add a new user or modify any of the files on a subvolume that is not
mounted by default, you need to declare such subvolume first so that it
is mounted as well. Find more details about mounting file systems in
<xref linkend="sec-storage-filesystem"/>.
</para>
</important>
</para>
<note>
<title>The <literal>version</literal> attribute is mandatory</title>
<para>
Expand All @@ -43,6 +32,9 @@
specification.
</para>
</note>

<xi:include href="../snippets/deployment-raw-partitioning.xml"/>

<section xml:id="sec-ignition-storage">
<title>Storage configuration</title>
<para>
Expand Down Expand Up @@ -405,5 +397,5 @@
}
</screen>
</section>
</section>
</xi:include>
</topic>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
<!DOCTYPE section
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
Expand All @@ -8,8 +8,8 @@
<!-- 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="deployment-default-partitioning"
role="concept" xml:lang="en"
<section xml:id="deployment-default-partitioning"
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"
Expand All @@ -20,27 +20,8 @@
<!-- 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>
<para>
The pre-built images are delivered with a default partitioning scheme. You
can change it during the first boot by using
<xref linkend="deployment-configuring-with-ignition" xrefstyle="template:&ignition;"/>
or
<xref linkend="deployment-configuring-with-combustion" xrefstyle="template:&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>

</info>
<para>
Each image has the following subvolumes:
</para>
Expand All @@ -62,4 +43,10 @@
subvolumes or partitions must be configured either by &ignition; or
&combustion;.
</para>
</topic>
<para>
If you want to
add a new user or modify any of the files on a subvolume that is not
mounted by default, you need to declare such subvolume first so that it
is mounted as well.
</para>
</section>

0 comments on commit da1ac8a

Please sign in to comment.