Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatting of the new CW (installation using RAW image) #3423

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
- Added new workflow with the instructions about RAW image usage
to Common Workflows book
- Added reminder note to unregister before registration to Client
- Added documentation on deploying SUSE Manager Proxy in Public
Cloud in Large Deployment Guide
- Added admonition about disabling data synchronization with SCC in
Expand Down
2 changes: 1 addition & 1 deletion modules/common-workflows/nav-common-workflows-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ endif::[]

ifeval::[{suma-content} == true]
** xref:workflow-inplace-sles-upgrade.adoc[In-place Upgrade]
** xref:workflow-install-from-raw-image[Installation using RAW image]
** xref:workflow-install-from-raw-image.adoc[Installation Using RAW Image]
endif::[]

** xref:workflow-product-upgrade-webui.adoc[Product Upgrade via {webui}]
Expand Down
59 changes: 24 additions & 35 deletions modules/common-workflows/pages/workflow-install-from-raw-image.adoc
Original file line number Diff line number Diff line change
@@ -1,62 +1,61 @@
[[workflow-inplace-sles-upgrade]]
[[workflow-install-from-raw-image]]
= Installing {productname} Using RAW Image

= Installing {productname} using raw image

{productname} offers various image formats, including a RAW format.
This guide demonstrates how to set up {productname} Server using the raw image.

{productname} offers various image formats, including a raw format. This guide demonstrates how to set up {productname} Server using the raw image.


== Use Case

RAW images are pre-built, ready-to-use representations of a running operating system. Instead of being installed through a traditional installer, they are directly copied to the hard disk of the target host.
Raw image format is flexible and compatible with a wide range of virtualization and deployment tools. This guide provides essential information about these pre-configured images.
RAW images are pre-built, ready-to-use representations of a running operating system.
Instead of being installed through a traditional installer, they are directly copied to the hard disk of the target host.
RAW image format is flexible and compatible with a wide range of virtualization and deployment tools.

This guide provides essential information about these pre-configured images.



== Outcome

Successful completion of this workflow results in successful installation of {productname} Server.


== Step-by-step Preparation Instructions

== Step-by-step Instructions

[WARNING]
[NOTE]
====
This workflow is complex and time-consuming.
Make sure that adequate testing is done before deploying the procedure in live environment.
====

.Procedure: Prerequisites
.Procedure: Prepare the Prerequisites
[role=procedure]
. *Download the Image:* Download the architecture-specific [literal]``.raw.xz`` image of SUSE Manager 5.0 Server for your target block size.


. *Make Image Accessible:* Copy the image to a web server (preferred), NFS server, or expand the .raw file to add directly as a disk in a virtual environment (if supported).


. *Boot Media:* Provide a bootable ISO ({sles} 15 SPX or {sle-micro} 5.5) to access the "Rescue System." Add netsetup=1 on the kernel command line for networking, or configure IP via ifcfg.

. *Download the Image:* Download the architecture-specific [literal]``.raw.xz`` image of {productname} Server for your target block size.
. *Make Image Accessible:* Copy the image to a web server (preferred), NFS server, or expand the [literal]``.raw`` file to add directly as a disk in a virtual environment (if supported).
. *Boot Media:* Provide a bootable ISO ({sles} 15 SPX or {sle-micro} 5.5) to access the "Rescue System."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove the NFS server from this list - as the instructions are more complicated, and copying it to a webserver is not an onerous requirement.
We should include the 'dd' instructions if we give the option to direct mount the '.raw' disk - as this doc does not yet contain those steps.

Add [literal]``netsetup=1`` on the kernel command line for networking, or configure IP via [command]``ifcfg``.
. *Target Disk Setup:* In VMware, create:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Add [literal]``netsetup=1`` on the kernel command line for networking, or configure IP via [command]``ifcfg``.

This step is happening during boot, i.e. next step, not during preparation.

.. A 40GB root disk
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is generic workflow, so no specific hypervisor should be here.

Suggested change
. *Target Disk Setup:* In VMware, create:
. *Target Disk Setup:* If applicable, in virtual machine hypervisor, create:

.. Additional storage for persistent SUSE Manager data


.Procedure: Installation Steps

[role=procedure]
. *Prepare Network and Boot Environment*

.. Create a new instance, attach the root and persistent storage, then attach the {sles} or {sle-micro} ISO as a virtual CD.
.. Boot the instance to the ISO, selecting the Rescue System.”
.. Boot the instance to the ISO, selecting the [literal]``Rescue System``.
.. Add the following on the command line to enable network configuration.

+
----
netsetup=1
----
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may work now, but AFAIK SLE16 (and I wonder if SL-Micro 6.1) does not ship linuxrc.

How about using ip= from dracut ( https://manpages.opensuse.org/Tumbleweed/dracut/dracut.cmdline.7.en.html#Network )

e.g. ip=dhcp for automatic assignment.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are talking about SUSE Manager 5.0 here, and are recommending people boot from SLE15/SLE Micro 5.X generation rescue media. The dracut command does not work from the linuxrc offered there.
We are not supporting SL Micro 6.1 nor SLE 16 media for these purposes until a later release of SUSE Manager.

Quite often customers may not have DHCP available. By choosing 'netsetup=1' they are prompted to either choose DHCP or configure manual settings. Alternatively they can follow the linuxrc 'ifcfg' configuration referenced here:
https://en.opensuse.org/SDB:Linuxrc#Using_ifcfg

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well of course, I was hoping to have something which will work later as well. Still we can recommend SLE15 boot media till 2037, so I guess we are good.

+
. *Configure Network & Identify Devices*

. *Configure Network and Identify Devices*
.. Complete network setup as prompted and log in as root.
.. Use fdisk to confirm the root device name
.. Use [command]``fdisk`` to confirm the root device name.
+
----
fdisk -l
Expand All @@ -67,44 +66,34 @@ fdisk -l
----
blockdev --getpbsz /dev/sda
----
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use $device to be consistent with the curl command later.

Suggested change
blockdev --getpbsz /dev/sda
blockdev --getpbsz $device

+

+
----
lsblk -o NAME,PHY-SEC /dev/sda
----
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we skip device name, lsblk will show all and we can choose the right one. This command should be moved up to replace fdisk -l command.

Suggested change
lsblk -o NAME,PHY-SEC /dev/sda
lsblk -o NAME,PHY-SEC

+
. *Transfer the Image*

.. Use [literal]``curl`` to copy the [literal]``.raw.xz`` image onto the root disk:
+
----
curl -Sks $url | xz -d > $device -v
----
+

.. Replace [literal]``$url`` with the image URL and $device with the root partition device.

.. Replace [literal]``$url`` with the image URL and [literal]``$device`` with the root partition device.
. *Finalize Boot and Configuration*

.. Power off the instance, remove the virtual CD from the boot sequence, and start it again to boot from the newly created instance.
.. Follow on-screen installation directions and, if needed, register with {scc}, adding the SUSE Manager Server Extension.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. Follow on-screen installation directions and, if needed, register with {scc}, adding the SUSE Manager Server Extension.
.. Follow on-screen installation directions and, if needed, register with {scc}, adding the {productname} Server Extension.

. *Install VMware Tools (if applicable)*

.. Install the [literal]``open-vm-tools``
+
----
transactional-update pkg install open-vm-tools
----
+
.. Reboot after installation.

. *Provision Persistent Storage*

+
----
mgr-storage-server $device
----
+
Ensure $device points to the fast, persistent storage added in VMware.
Ensure [literal]``$device`` points to the fast, persistent storage added in VMware.
Loading