Skip to content

Commit

Permalink
Update xml/concept-micro-cloud.xml
Browse files Browse the repository at this point in the history
Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-slemicro-useradd.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/SLE_Micro.asm.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/SLE_Micro.asm.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/concept-micro-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-modifying-ignition-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-modifying-ignition-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-modifying-ignition-cloud.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-slemicro-useradd.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-slemicro-useradd.xml

Co-authored-by: Daria Vladykina <[email protected]>

Update xml/task-slemicro-useradd.xml

Co-authored-by: Daria Vladykina <[email protected]>
  • Loading branch information
lvicoun and dariavladykina committed Mar 28, 2023
1 parent c4780c8 commit 5384bcb
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 46 deletions.
4 changes: 2 additions & 2 deletions xml/SLE_Micro.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<structure>
<output renderas="article" xml:id="slema-public-cloud"/>
<merge>
<title>&productnameshort; in public clouds</title>
<title>&productnameshort; in Public Clouds</title>
<revhistory>
<title>Changelog</title>
<revision>
Expand All @@ -64,7 +64,7 @@
<productname version="SLEMICRO">&slem;</productname>
</meta>
<!-- SEO and social media -->
<meta name="title">SLE Micro in public clouds</meta>
<meta name="title">SLE Micro in Public Clouds</meta>
<meta name="description">
Learn how to deploy &productnameshort; in public clouds. Learn how to add users to suit your needs.
</meta>
Expand Down
59 changes: 30 additions & 29 deletions xml/concept-micro-cloud.xml
Original file line number Diff line number Diff line change
Expand Up @@ -46,28 +46,29 @@
The service is started automatically by &systemd;.
</para>
<para>
&ignition; runs on the first boot only. To distinquish the first boot
from succeding boots, the flag file
&ignition; runs on the first boot only. To distinguish the first boot
from succeeding boots, the flag file
<filename>/boot/writable/firstboot_happened</filename> is created.
Whenever you want to trigger &ignition; again, you need to remove this
file.
</para>
<para>
The default &ignition; configuration is stored in the configuration file:
<filename>/usr/lib/ignition/base.d/base.ign</filename>. You can modify
this file to perform configuration changes, for details, refer to
this file to perform configuration changes. For details, refer to
<xref linkend="task-modifying-ignition-cloud"/>.
</para>
<note>
<title>&combustion; not included in the &productnameshort; Public Cloud images</title>
<title>&combustion; not included in the &productnameshort; public
cloud images</title>
<para>
In order to configure your instance with &combustion;, you need to
create a separate disk in the cloud framework. The disk needs to meet
the necessary directory structure. Then you need to create an instance
To configure your instance with &combustion;, you need to
create a separate disk in the cloud framework. The disk must have
the required directory structure. Then you need to create an instance
with this configuration disk attached. If the use of &combustion; is
needed for integration into your environment you can build your own
needed for integration into your environment, you can build your own
images using keg and keg-recipes. The keg-recipes project contains the
image description SUSE uses to build the images we publish. For
image description used by SUSE to build the images we publish. For
details, refer to
<link xlink:href="https://github.com/SUSE-Enceladus/keg-recipes/">keg-recipes</link>.
</para>
Expand All @@ -76,32 +77,33 @@
<section xml:id="micro-cloud-disk-size-clouds">
<title>Required and available disk size</title>
<para>
The root volume is set to the size specified byt the cloud vendors, for
example 10&nbsp;GB in AWS and GCE, and 30&nbsp;GB in Azure.
The root volume is set to the size specified by the cloud vendors, for
example, 10&nbsp;GB in AWS and GCE and 30&nbsp;GB in Azure.
</para>
<para>
The recommended size for &productnameshort; is 12&nbsp;GB. However, the
size depends on the number and size of workloads you intend to run.
</para>
<para>
As with each run of the &tr-up; command a new snapshot is created, keep
in mind that these snapshots also take some size, even though, btrfs
snapshots are space efficient.
in mind that these snapshots also take some size, even though Btrfs
snapshots are space-efficient.
</para>
<para>
The root volume automatically grows as you change the size of the
underlying disk. When you are running low on disk space, you can always
stop your instance and make the system disk bigger, up to the limitation
of individual disk sizes in each Cloud framework.
of individual disk sizes in each cloud framework.
</para>
</section>
<section xml:id="micro-cloud-snapshots-cloud-vs-slema">
<title>Snapshotting</title>
<para>
&productnameshort; creates its own internal snapshot that are not related
nor can interfere with the external snapshots of the disk that can be
created using the Cloud framework tools for backup purposes or to create
new images. For details about &productnameshort; snapshots, refer to
&productnameshort; creates its own internal snapshots that are not related
nor can interfere with the external snapshots of the disk. External
snapshots can be created using the cloud framework tools for backup
purposes or for making new images. For details about &productnameshort;
snapshots, refer to
<link xlink:href="https://documentation.suse.com/sle-micro/html/SLE-Micro-all/cha-snapshots.html"></link>.
</para>
</section>
Expand All @@ -111,34 +113,33 @@
After you deploy the image, you need to register the system. In newer
images, you can use the <command>registercloudguest</command> command to
register the system. For details, refer to the
<link xlink:href="https://documentation.suse.com/sle-public-cloud/all/html/public-cloud/cha-admin.html#sec-admin-register">public
cloud guide</link>.
<link xlink:href="https://documentation.suse.com/sle-public-cloud/all/html/public-cloud/cha-admin.html#sec-admin-register">Public Cloud Guide</link>.
</para>
<para>
Alternatively, you can register your system as described in
the<link xlink:href="https://documentation.suse.com/sle-micro/5.3/html/SLE-Micro-all/cha-postintall-registration.html#sec-images-registration">&productnameshort;
the <link xlink:href="https://documentation.suse.com/sle-micro/5.3/html/SLE-Micro-all/cha-postintall-registration.html#sec-images-registration">&productnameshort;
registration</link>.
</para>
</section>
<section xml:id="micro-cloud-default-users">
<title>Default users of &productnameshort;</title>
<para>
&productnameshort; images comes with a predefined user
&productnameshort; images come with a predefined user
<literal>suse</literal> that has <command>sudo</command> privileges
assigned. Therefore, you can swith to the &rootuser; using the
assigned. Therefore, you can switch to the &rootuser; using the
<command>sudo -i</command> command.
</para>
<para>
As the default user probably won't suit your needs, you have several
options how to add users. Either you can define users in the &ignition;
configuration file or you can use the <command>useradd</command> command
As the default user possibly does not suit your needs, you have several
options for adding users. You can either define users in the &ignition;
configuration file, or use the <command>useradd</command> command
to add users to the running system.
</para>
<para>
For details regarding adding users via &ignition;, refer to
For more details about adding users via &ignition;, refer to
<link xlink:href="https://documentation.suse.com/sle-micro/html/SLE-Micro-all/cha-images-ignition.html#sec-ignition-examples"></link>
and <xref linkend="modifying-ignition-cnfiguration-cloud"/>. For details
regarding using the <command>useradd</command> command, see
and <xref linkend="modifying-ignition-cnfiguration-cloud"/>. For more
details about using the <command>useradd</command> command, see
<xref linkend="task-slemicro-useradd"/>.
</para>
</section>
Expand Down
10 changes: 5 additions & 5 deletions xml/task-modifying-ignition-cloud.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
<title>Introduction</title>
<para>
&slema; cloud images come with a default first-boot configuration that
might not suit your needs. This article gives you instructions how to
proceed to reconfigure your system.
might not suit your needs. This article gives you instructions on
how to proceed to reconfigure your system.
</para>
</section>
<section xml:id="modifying-ignition-cnfiguration-cloud">
Expand Down Expand Up @@ -64,14 +64,14 @@
<step>
<para>
As &ignition; runs in the <filename>initramfs</filename>, you need to
rebuild them by running the command:
rebuild it by running the command:
</para>
<screen>&prompt.root;<command>transactional-update initrd</command></screen>
</step>
<step>
<para>
To provide the newly created user with access using the cloud
framework provided SSH key, ensure that the following &systemd;
To grant the newly created user access rights using the SSH key
provided by the cloud framework, ensure that the following &systemd;
service is started:
</para>
<screen>&prompt.root;<command>systemctl start afterburn-sshkeys@<replaceable>USER_NAME</replaceable></command></screen>
Expand Down
20 changes: 10 additions & 10 deletions xml/task-slemicro-useradd.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
<title>Introduction</title>
<para>
You can use the <command>useradd</command> command to add users to an
already running system. However, as &slema; is btrfs based, the
<filename>/home</filename> directory is mounted as a subvolume,
therefore, you have to use the <command>useradd</command> command
already running system. However, as &slema; is Btrfs-based, the
<filename>/home</filename> directory is mounted as a subvolume.
Therefore, you must use the <command>useradd</command> command
accordingly.
</para>
</section>
Expand All @@ -35,7 +35,7 @@
the type of user you want to add.
</para>
<para>
To add a regular users without <command>sudo</command> privileges,
To add a regular user without <command>sudo</command> privileges,
proceed as described further:
</para>
<procedure>
Expand All @@ -45,12 +45,12 @@
</para>
<screen>&prompt.root;<command>useradd --btrfs-subvolume-home --create-home <replaceable>USER_NAME</replaceable></command></screen>
<para>
The <option>--btrfs-subvolume-home</option> denotes that the
The <option>--btrfs-subvolume-home</option> option denotes that the
<filename>/home</filename> directory is mounted as a subvolume. The
<option>--create-home</option> creates the <filename>/home</filename>
under the particular subvolume. If you omit these options, the
<filename>/home</filename> directory for the particular user will not
be created.
<option>--create-home</option> option creates the
<filename>/home</filename> under the particular subvolume. If you
omit these options, the <filename>/home</filename> directory for
the particular user will not be created.
</para>
</step>
<step>
Expand All @@ -61,7 +61,7 @@
</step>
</procedure>
<para>
To give the new user <command>sudo</command> privileges, you need to add
To give the new user <command>sudo</command> privileges, add
the user to the <literal>wheel</literal> group:
</para>
<screen>&prompt.root;usermod -aG wheel <replaceable>USER_NAME</replaceable></screen>
Expand Down

0 comments on commit 5384bcb

Please sign in to comment.