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

SLE installation on x86_64 with Agama installer #417

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sounix000
Copy link
Contributor

Description

Modular documentation for SLE installation on x86_64 with Agama installer

Are there any relevant issues/feature requests?

Is this (based on) existing content?

No, it's new content written from scratch.

@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1675-SLE-Agama-installation-x86_64 branch from e0ed4a1 to a44dad7 Compare January 23, 2025 11:55
@sounix000 sounix000 marked this pull request as ready for review January 23, 2025 22:11
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1675-SLE-Agama-installation-x86_64 branch from 42dff01 to 0d827d5 Compare January 23, 2025 22:12
Copy link
Contributor

@lvicoun lvicoun left a comment

Choose a reason for hiding this comment

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

Hi Souvik, thank you very much for handling this on such a short-term! I added some information.

<link xlink:href="https://agama-project.github.io"></link>.
</para>
</listitem>
<listitem>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure that a reference to SLE15 SP6 is relevant to the user. I think e.g. cockpit guide should be here, we will have it soon online.

</para>
</abstract>
</info>
<section xml:id="sle-agama-manual-installation-x86-64-introduction">
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd move the info regarding Agama to a separate topic, as I'm sure that it will be used also for the automatic installation.

</para>
<note>
<para>
In this example procedure, we select &sles; 16.0 Beta. The manual installation
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
In this example procedure, we select &sles; 16.0 Beta. The manual installation
In this example procedure, we select &sles; &productnumber; Beta. The manual installation

<para>
In this example procedure, we select &sles; 16.0 Beta. The manual installation
procedure for &sles; and &sles4sapa; is same. However, the storage requirement for
&sles4sapa; is slightly more than vanilla &sles;.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure everyone will know what is vanilla SLES. Anyways, please state the HW REQ for SAP in the beginning as here it does not convey information if they are higher or lower.

In the <guilabel>Registration</guilabel> page, enter the <guilabel>Registration
code</guilabel> and select <guilabel>Register</guilabel>.
</para>
<note>
Copy link
Contributor

@lvicoun lvicoun Jan 24, 2025

Choose a reason for hiding this comment

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

I think we can skip the note. The step is not marked as optional and Agama itself states it is mandatory to register. (At least for this type of installation, offline installation that does not require registration should follow soon).

<step>
<para>
After successful registration, the <guilabel>Overview</guilabel> page reappears. Ensure
that the configurations for <guilabel>Localization</guilabel>,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add here to create a non-root user as it is mandatory to access Cockpit for example. Sure you can add a user later, but here we have the option so let's use it :) keep in mind that later here the full partitioning power will appear and you will have to elaborate the settings anyways.

</mediaobject>
</informalfigure>
</step>
<step>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd move the step to the Summary as there you mention the verification.

Copy link
Contributor

@taroth21 taroth21 left a comment

Choose a reason for hiding this comment

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

@sounix000 : Thanks a lot, looks good - just a few nitpicks from my side (and some things that @lvicoun already has covered). There is one issue we need to clarify with the portal squad I think (mentioned in one of my comments).


## Profiling
PROFOS="sles;sles4sapa"
PROFCONDITION="sles;sles4sapa"
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
PROFCONDITION="sles;sles4sapa"
PROFCONDITION="16.0"

Comment on lines +101 to +108
<dm:product>
<!--Bugzilla product string-->
</dm:product>
<!--
if the assembly applies to multiple products/productversions, use profiling:
<dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
-->
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
<dm:product>
<!--Bugzilla product string-->
</dm:product>
<!--
if the assembly applies to multiple products/productversions, use profiling:
<dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sles" condition="16.1">SUSE Linux Enterprise Server 16.1</dm:product>
-->
<dm:product>
<dm:product os="sles" condition="16.0">SUSE Linux Enterprise Server 16.0</dm:product>
<dm:product os="sles4sapa" condition="16.0">SUSE Linux Enterprise Server for SAP Applications 16.0</dm:product>
</dm:product>

Copy link
Contributor

Choose a reason for hiding this comment

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

The above profiling for Bugzilla would only work if we indeed use profiling within the source code (and create two different DC file with one PROFOS each) - we need to doublecheck with @lvicoun and the portal squad (my understanding is that we need a profiled version of the article for each product, because otherwise we might not be able to file the same article for two different products in the portal.)

<term>WHAT?</term>
<listitem>
<para>
This article describes how to install &sles; or &sles4sapa; using &agama; on
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe you could mention here that the article applies both to bare metal and VM installation?

<term>GOAL</term>
<listitem>
<para>
Understand how to install &sles; or &sles4sapa; using &agama; on &x86-64; machines.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please use the full productname entity (see suggestion) for SLES for SAP (everywhere), this one is for the abbreviated product name

<term>GOAL</term>
<listitem>
<para>
Understand how to install &sles; or &sles4sapa; using &agama; on &x86-64; machines.
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
Understand how to install &sles; or &sles4sapa; using &agama; on &x86-64; machines.
Understand how to install &sles; or &sles4sap; using &agama; on &x86-64; machines.

ensure its integrity.
</para>
<note>
<title>Supported &sle; version</title>
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
<title>Supported &sle; version</title>
<title>Available images for products</title>

Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't mention 'supported' here, it's rather: which products are available for installation with Agama right now

xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Installing &sle; using &agama; on &x86-64; machines</title>
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need using &agama; here? if that is going to be the only way to install, I would remove it

</para>
</section-->
<section xml:id="sle-agama-manual-installation-x86-64-procedure">
<title>Manually installing &sle; using &agama; on &x86-64; machines</title>
Copy link
Contributor

Choose a reason for hiding this comment

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

same here: do we need using &agama;? if not, please remove

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants