Skip to content

Commit

Permalink
Implemented doc review enhancements
Browse files Browse the repository at this point in the history
Fixed wording, style, punctuation, typos, format according to
documentation style guide rules.
  • Loading branch information
chabowski committed Jul 10, 2024
1 parent 825de4c commit 194b516
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 41 deletions.
5 changes: 1 addition & 4 deletions adoc/SAP-EIC-Main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ https://help.sap.com/docs/integration-suite?locale=en-US and search for the "Edg
<?pdfpagebreak?>
++++

== Preparations
== Prerequisites

* Get subscriptions for:
** {slem} {slem_version}
Expand Down Expand Up @@ -164,9 +164,6 @@ A window will appear asking you to select the Secret type. Select *Registry* as

image::EIC-Secrets-Types.png[title=Secrets Type Selection,scaledwidth=99%]

++++
<?pdfpagebreak?>
++++

Enter a name such as _application-collection_ for the Secret. In the text box *Registry Domain Name*, enter _dp.apps.rancher.io_.
Enter your user name and password and click the *Create* button at the bottom right.
Expand Down
30 changes: 15 additions & 15 deletions adoc/SAP-EIC-Metallb.adoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
==== Installation and Configuration of {metallb}
==== Installing and configuring {metallb}

There are multiple ways to install the {metallb} software. In this guide we'll cover how to install {metallb} using kubectl or Helm.
A complete overview and more details about {metallb} can be found on their
link:https://metallb.universe.tf/[official website]
There are multiple ways to install the {metallb} software. In this guide, we will cover how to install {metallb} using `kubectl` or Helm.
A complete overview and more details about {metallb} can be found on the
link:https://metallb.universe.tf/[official website for {metallb}]

===== Pre-requisites
===== Prerequisites

Before starting the installation, make sure you meet all the requirements. In particular, you should pay attention to network addon compatibility.
If you are trying to run {metallb} on a cloud platform, you should also look at the cloud compatibility page and make sure your cloud platform can work with {metallb} (most cannot).
Before starting the installation, ensure that all requirements are met. In particular, you should pay attention to network addon compatibility.
If you are trying to run {metallb} on a cloud platform, you should also look at the cloud compatibility page and make sure your cloud platform works with {metallb} (note that most cloud platforms do *not*).

There are several ways to deploy {metallb}. In this guide we'll describe how to use the {rac} to deploy {metallb}.
There are several ways to deploy {metallb}. In this guide, we will describe how to use the {rac} to deploy {metallb}.

Please make sure to have a range of IP addresses available for configuring {metallb}.
Make sure to have a range of IP addresses available for configuring {metallb}.

===== Preparations
===== Preparation

Make sure the related Kernel modules are loaded on your Kubernetes worker nodes as described in xref:SAP-EIC-SLEMicro#metal-slem[].
Ensure that the associated kernel modules are loaded on your Kubernetes worker nodes as described in xref:SAP-EIC-SLEMicro#metal-slem[].

Make sure you enabled strictarp as described in xref:SAP-Rancher-RKE2-Installation.adoc#metal-rke[]
Make sure you enabled `strictarp` as described in xref:SAP-Rancher-RKE2-Installation.adoc#metal-rke[]


===== Installation of {metallb}
===== Installing {metallb}

To install {metallb} run the following lines in your terminal:

Expand All @@ -33,7 +33,7 @@ $ helm install --namespace=metallb --set-json 'imagePullSecrets=[{"name":"applic
<?pdfpagebreak?>
++++

==== Configuration
==== Configuring {metallb}

{metallb} needs two configurations to function properly:

Expand All @@ -55,7 +55,7 @@ spec:
EOF
----

and the layer 2 network advertisement:
Create the layer 2 network advertisement:

----
# cat <<EOF > l2advertisement.yaml
Expand Down
58 changes: 36 additions & 22 deletions adoc/SAP-EIC-SLEMicro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ image::EIC_SLE_Micro_setup_NTP_Configuration.png[title=SLE Micro Setup NTP Confi
<?pdfpagebreak?>
++++

* On the next page fill out our password for the *root* user and if you want you can import public ssh keys for the root user.
* On the next page, enter your password for the *root* user. If you want, you can also import public SSH keys for the *root* user.
+
image::EIC_SLE_Micro_setup_Authentication.png[title=SLE Micro Setup Authentication for the System Administrator "root",scaledwidth=99%]

Expand All @@ -115,46 +115,60 @@ image::EIC_SLE_Micro_setup_Authentication.png[title=SLE Micro Setup Authenticati
image::EIC_SLE_Micro_setup_Installation_Settings01.png[title=SLE Micro Setup Installation Settings upper page,scaledwidth=99%]
image::EIC_SLE_Micro_setup_Installation_Settings02.png[title=SLE Micro Setup Installation Settings lower page,scaledwidth=99%]

* To disable Kdump, scroll down and click its label . This opens the *Kdump Start-Up* page.
On that page, make sure "Disable Kdump" is selected.
* To disable Kdump, scroll down and click its label. This opens the *Kdump Start-Up* page.
On that page, make sure *Disable Kdump* is selected.

* To set SELinux im permissive mode, scroll down and click on *Security*. This open the *Security* page. On the right site there is the menu entry *Selected Module*. Open the dropdown menu and select *Permissive*.
* To set SELinux im permissive mode, scroll down and click *Security*. This opens the *Security* page.
On the right site there is the menu entry *Selected Module*. Open the drop-down menu and select *Permissive*.

* Click on *Install* and confirm the installation.
* Click *Install* and confirm the installation.
+
image::EIC_SLE_Micro_setup_Confirm_Installation.png[title=SLE Micro Setup Confirm Installation,scaledwidth=99%]

* After the installation is finished you need to reboot the system.
* After the installation is finished, reboot the system.
+
image::EIC_SLE_Micro_setup_reboot.png[title=SLE Micro Setup reboot,scaledwidth=99%]

* You will see a login screen and you can login with your choosen Username and password.
* You will see a login screen. Log in with your choosen user name and password.

=== Register your system
To bring your system up to date you need to register your system against a SUSE Manager, RMT server or direct to the SCC Portal. We will describe the process in our guide with the direct connect to the SCC. For more information please look into the {slem} documentation.

Registering the system is possible from the command line using the *transactional-update register* command. For information that goes beyond the scope of this section, refer to the inline documentation with *SUSEConnect --help*. To register {slem} with SUSE Customer Center, run *transactional-update register* as follows:
=== Registering your system

To get your system up-to-date, you need to register it with SUSE Manager, an RMT server or directly with the SCC Portal.
We describe the process with the direct connection to SCC in the instructions below. For more information, see the {slem} documentation.

Registering the system is possible from the command line using the `transactional-update register` command.
For information that goes beyond the scope of this section, refer to the inline documentation with *SUSEConnect --help*.

To register {slem} with SUSE Customer Center, run `transactional-update register` as follows:
----
# transactional-update register -r REGISTRATION_CODE -e EMAIL_ADDRESS
----
To register with a local registration server, additionally provide the URL to the server:
To register with a local registration server, additionally specify the URL to the server:
----
# transactional-update register -r REGISTRATION_CODE -e EMAIL_ADDRESS \
--url "https://suse_register.example.com/"
----
Replace *REGISTRATION_CODE* with the registration code you received with your copy of {slem}. Replace *EMAIL_ADDRESS* with the e-mail address associated with the SUSE account you or your organization uses to manage subscriptions.
. Reboot your system to switch to the latest snapshot.
. {slem} is now registered.
You can found more information in the {slem} {slem_version} link:https://documentation.suse.com/sle-micro/{slem_version}/single-html/SLE-Micro-deployment/[Deployment Guide] .
Do not forget to replace

* *REGISTRATION_CODE* with the registration code you received with your copy of {slem}.
* *EMAIL_ADDRESS* with the e-mail address associated with the SUSE account you or your organization uses to manage subscriptions.

=== Update your system
Login into the system and after your system is registered you can update it with the *transactional-update* command.
Reboot your system to switch to the latest snapshot. {slem} is now registered.

Find more information about registering your system in the {slem} {slem_version} link:https://documentation.suse.com/sle-micro/{slem_version}/single-html/SLE-Micro-deployment/[Deployment Guide].

=== Updating your system

Log in to the system. After your system is registered, you can update it with the `transactional-update` command.
----
# transactional-update
----

=== Disable automatic reboot
Per default {slem} runs a timer for *transactional-update* in the background which could automatic reboot your system. We will disable it.
=== Disabling automatic reboot

Per default {slem} runs a timer for `transactional-update` in the background which could automatically reboot your system.
Disable it with the following command:

----
# systemctl --now disable transactional-update.timer
Expand All @@ -167,10 +181,10 @@ Per default {slem} runs a timer for *transactional-update* in the background whi
ifdef::metallb[]
// Needed due to Github issue: https://github.com/rancher/rke2/issues/3710
[#metal-slem]
=== Preparation for {metallb}
=== Preparing for {metallb}

If you want to use {metallb} as a Kubernetes Load Balancer, you need to make sure that the kernel modules for ip_vs are loaded correctly on boot time.
To do so, create and populate the file */etc/modules-load.d/ip_vs.conf* on each cluster node as followed:
If you want to use {metallb} as a Kubernetes Load Balancer, you need to make sure that the kernel modules for ip_vs are loaded correctly at boot time.
To do so, create and populate the file _/etc/modules-load.d/ip_vs.conf_ on each cluster node as follows:

[source, shell]
----
Expand Down

0 comments on commit 194b516

Please sign in to comment.