Skip to content

Commit

Permalink
Implemented fixes and edits from doc review
Browse files Browse the repository at this point in the history
According to style guide and doc policies, fixed typos, wording, style,
grammar.
  • Loading branch information
chabowski committed Sep 10, 2024
1 parent 93b5d91 commit 3dd7f94
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 77 deletions.
4 changes: 2 additions & 2 deletions adoc/SAP-EIC-LoginRegistryApplicationCollection.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[#LoginApplicationCollection]
= Login into the Application Collection Registry

To install the Helm Charts from the _application-collection_ you need to login into the registry. This needs to be done with the Helm client.
To install the Helm Charts from the _application-collection_ you need to log in into the registry. This needs to be done with the Helm client.

To login to the {rac} run:
To log in to the {rac}, run:
[source, bash]
----
$ helm registry login dp.apps.rancher.io/charts -u <yourUser> -p <your-token>
Expand Down
28 changes: 12 additions & 16 deletions adoc/SAP-EIC-Main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,14 @@ Additionally,

== Landscape Overview

To run {eic} in a production ready and supported way, you'll need to setup multiple Kubernetes clusters and their nodes.
Those comprise a Kubernetes cluster where you'll install {rancher} to setup and manage the production and non-production clusters.
For this {rancher} cluster, we recommend using 3 Kubernetes nodes and a load balancer.
To run {eic} in a production-ready and supported way, you need to set up multiple Kubernetes clusters and their nodes.
Those comprise a Kubernetes cluster where you will install {rancher} to set up and manage the production and non-production clusters.
For this {rancher} cluster, we recommend using three Kubernetes nodes and a load balancer.

The {eic} will need to run in a dedicated Kubernetes cluster.
For a HA setup of this cluster, we recommend using 3 Kubernetes Control Plane and 3 Kubernetes Worker nodes.
For an HA setup of this cluster, we recommend using three Kubernetes control planes and three Kubernetes worker nodes.

To give you a graphical overview of what's needed, please take a look at the landscape overview:
For a graphical overview of what is needed, take a look at the landscape overview:

image::SAP-EIC-Architecture.svg[scaledwidth=99%,opts=inline,Embedded]

Expand All @@ -125,17 +125,17 @@ image::SAP-EIC-Architecture.svg[scaledwidth=99%,opts=inline,Embedded]
* The green rectangles represent Kubernetes Control Plane nodes.
* The orange rectangles represent Kubernetes Worker nodes.

We'll use this graphical overview through the guide to visualize what's the next step and what it's for.
We will use this graphic overview in the guide to illustrate what the next step is and what it is for.


Starting with the installation of the operating system of each machine/ Kubernetes node, we'll guide you through every step to take to get a fully set up Kubernetes landscape ready for the deployment of {eic}.
Starting with installing the operating system of each machine or Kubernetes node, we will walk you through all the steps you need to take to get a fully set up Kubernetes landscape for deploying {eic}.

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

== Installing {slem} {slem_version}
There are several ways to install {slem} {slem_version}. For this best practice guide, we use the installation method via graphical installer. But in cloud-native deployments it is highly recommended to use Infrastructure as Code technologies to fully automate the deployment and lifecycle processes.
There are several ways to install {slem} {slem_version}. For this best practice guide, we use the installation method via graphical installer. But in cloud-native deployments it is highly recommended to use Infrastructur- as-Code technologies to fully automate the deployment and lifecycle processes.

include::SAP-EIC-SLEMicro.adoc[SLEMicro]

Expand All @@ -146,15 +146,11 @@ include::SAP-EIC-SLEMicro.adoc[SLEMicro]
== Installing {rancher}

By now you should have installed the operating system on every Kubernetes node.
You're now ready to install a {rancher} cluster.
Taking a look again on the landscape overview, this means, we'll now cover how to setup the upper part of the given graphic:
You are now ready to install a {rancher} cluster.
Taking a look again on the landscape overview, this means, we will now cover how to set up the upper part of the given graphic:

image::SAP-EIC-Architecture-Rancher.svg[scaledwidth=99%,opts=inline,Embedded]

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

include::SAPDI3-Rancher.adoc[Rancher]

++++
Expand All @@ -164,9 +160,9 @@ include::SAPDI3-Rancher.adoc[Rancher]
== Installing RKE2 using {rancher}

After installing the {rancher} cluster, we can now facilitate this one to create the {rke} clusters for {eic}.
SAP recommends to setup not only a production landscape, but to have QA / Dev systems for {eic}. Both can be set up the same way using {rancher}.
SAP recommends to set up not only a production landscape, but to have QA / Dev systems for {eic}. Both can be set up the same way using {rancher}.
How to do this is covered in this chapter.
Taking a look again on the landscape overview, this means, we'll now cover how to setup the lower part of the given graphic:
Looking at the landscape overview again, we will now deal with setting up the lower part of the given graphic:

image::SAP-EIC-Architecture-RKE2.svg[scaledwidth=99%,opts=inline,Embedded]

Expand Down
25 changes: 11 additions & 14 deletions adoc/SAP-EIC-PostgreSQL.adoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
:pg: PostgreSQL
:redis: Redis

In the instructions below, we only describe one variant of installing {pg}.
There are other possible ways to set up {pg} which are not covered in this guide. It is also possible
to install {pg} as a single instance on the operating system.
We will focus on installing {pg} in a Kubernetes cluster as we also need a {redis} database and we will clustering that together.

IMPORTANT::
SUSE does *not* offer database support for {pg} on Kubernetes.
To get support, go to link:https://www.postgresql.org/support/[The PostgreSQL Global Development Group].


IMPORTANT::
In this guide we'll describe one variant of installing {pg}.
There are other possible ways to setup {pg} which are not focussed in this guide. It is also possible to install {pg} as a single instance on top of our operation system.
We will focus on installing {pg} into a kubernetes cluster, because we also need a {redis} database and we will put them together into one cluster.
The instructions below describe only one variant of installing {pg}.
There are other possible ways to set up {pg} which are not covered in this guide.
It is also possible to install {pg} as a single instance on the operating system.
We will focus on installing {pg} in a Kubernetes cluster as we also need a {redis} database and we will clustering that together.

== Deploying {pg}
Even though {pg} is available for deployment using the {rancher} Apps, we recommend to use the {rac}.
The {pg} chart can be found at https://apps.rancher.io/applications/postgresql.

== Create Secret for {rac}
First we need to create a namespace and the *imagePullSecret* for installing the {pg} database into the cluster.
== Creating Secret for {rac}
First, create a namespace and the *imagePullSecret* for installing the {pg} database onto the cluster.
[source, bash]
----
$ kubectl create namespace postgresql
Expand All @@ -31,14 +28,14 @@ $ kubectl create namespace postgresql
How to create the *imagePullSecret* is described in the Section xref:SAP-EIC-ImagePullSecrets.adoc#imagePullSecret[].

=== Create Secret with certificates
Second we need to create the Kubernetes secret with the certificates. You will find an example how to do this in the xref:SAP-EIC-Main.adoc#selfSignedCertificates[].
Second, create the Kubernetes secret with the certificates. You will find an example how to do this in the xref:SAP-EIC-Main.adoc#selfSignedCertificates[].

=== Installing the application
[#pgLIR]
Before you can install the application, you need to login into the registry. You can find the instruction in xref:SAP-EIC-LoginRegistryApplicationCollection.adoc#LoginApplicationCollection[]
Before you can install the application, you need to log in to the registry. You can find the instruction in xref:SAP-EIC-LoginRegistryApplicationCollection.adoc#LoginApplicationCollection[]

Create a file *values.yaml* which holds some configuration for the {pg} Helm chart.
The config may look like:
Create a file *values.yaml* which holds some configurations for the {pg} Helm chart.
The configuration may look like:
[source, yaml]
----
global:
Expand Down Expand Up @@ -76,7 +73,7 @@ persistentVolumeClaimRetentionPolicy:
whenDeleted: Delete
----

To install the application run:
To install the application, run:
[source, bash]
----
$ helm install metallb oci://dp.apps.rancher.io/charts/postgres -f values.yaml --namespace=postgres
Expand Down
29 changes: 12 additions & 17 deletions adoc/SAP-EIC-Redis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,18 @@

:redis: Redis

The following instructions describe only one variant of installing {redis} which is called Redis Cluster.
There are other possible ways to set up {redis} that are not covered in this guide.
Check if you require link:https://redis.io/docs/management/sentinel/[{redis} Sentinel]
instead of link:https://redis.io/docs/management/scaling/[{redis} Cluster].

IMPORTANT::
SUSE does not offer database support for {redis}.
For support requests contact link:https://redis.com/[Redis Ltd.].


IMPORTANT::
In this guide we'll describe one variant of installing {redis} which is called Redis Cluster.
There are other possible ways to setup {redis} which are not focussed in this guide.
Please check out if you rather require
link:https://redis.io/docs/management/sentinel/[Sentinel]
instead of
link:https://redis.io/docs/management/scaling/[Cluster]
The following instructions describe only one variant of installing {redis} which is called Redis Cluster.
There are other possible ways to set up {redis} that are not covered in this guide.
Check if you require link:https://redis.io/docs/management/sentinel/[{redis} Sentinel]
instead of link:https://redis.io/docs/management/scaling/[{redis} Cluster].


== Deploying Redis

Expand All @@ -30,9 +25,9 @@ The {redis} chart can be found at https://apps.rancher.io/applications/redis .
++++


=== Deploy the chart
=== Deploying the chart

To deploy the chart you'll need to create the related namespace and *imagePullSecret* first.
To deploy the chart, create the related namespace and *imagePullSecret* first.
To create the namespace, run:

[source, bash]
Expand All @@ -44,14 +39,14 @@ $ kubectl create namespace redis
Instructions how to create the *imagePullSecret* can be found in xref:SAP-EIC-ImagePullSecrets.adoc#imagePullSecret[]


If you want to use self signed certificates, you can find instructions how to create such in xref:SAP-EIC-Main.adoc#selfSignedCertificates[]
If you want to use self-signed certificates, you can find instructions how to create such in xref:SAP-EIC-Main.adoc#selfSignedCertificates[]

[#redisLIR]
Before you can install the application, you need to login into the registry. You can find the instruction in xref:SAP-EIC-LoginRegistryApplicationCollection.adoc#LoginApplicationCollection[]
Before you can install the application, you need to log in to the registry. You can find the instruction in xref:SAP-EIC-LoginRegistryApplicationCollection.adoc#LoginApplicationCollection[]


Create a file *values.yaml* which holds some configuration for the {redis} Helm chart.
The config may look like:
Create a file *values.yaml* which holds some configurations for the {redis} Helm chart.
The configuration may look like:

[source, yaml]
----
Expand Down Expand Up @@ -83,7 +78,7 @@ tls:
caCertFilename: "root.pem"
----

To install the application run:
To install the application, run:
[source, bash]
----
$ helm install metallb oci://dp.apps.rancher.io/charts/redis \
Expand Down
45 changes: 19 additions & 26 deletions adoc/SAP-EIC-SLEMicro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ At the end of the installation process in the summary windows you need to check
** The SSH service will be enabled.
** SELinux will be set in permissive mode.

We need to set SELinux into permissive mode, because some components of the Edge Integration Cell violated SELinux rules and the application will not work.
Set SELinux into _permissive_ mode, because otherwise, some components of the Edge Integration Cell violate SELinux rules, and the application will not work.


TIP: If you have already set up all machines and the operating system,
skip this chapter.
TIP: If you have already set up all machines and the operating system, skip this chapter.

=== 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.
To get your system up-to-date, you need to register it with SUSE Manager, an RMT server, or directly with the SCC Portal.
Find the registrationprocess with a direct connection to SCC describedin 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*.
Expand Down Expand Up @@ -60,76 +60,69 @@ Disable it with the following command:
$ systemctl --now disable transactional-update.timer
----

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

=== Preparation for {lh}
For {lh} we need to do some preparation steps. First we need to install addional packages on all worker nodes. Then we will attach a second disk to the worker nodes, create a filesystem ontop of it and mount it to the longhorn default location. The size of the second disk depends on your use case.
=== Preparing for {lh}
For {lh} you need to do some preparation steps. First, install some addional packages on all worker nodes. Then attach a second disk to the worker nodes, create a filesystem ontop of it and mount it to the longhorn default location. The size of the second disk depends on your use case.

We need to install some packages as a requirement for longhorn and Logical Volume Management for adding a filesystem to longhorn.
Install some packages as a requirement for longhorn and Logical Volume Management for adding a file system to longhorn.
[source, bash]
----
$ transactional-update pkg install lvm2 jq nfs-client cryptsetup open-iscsi
----

After the needed packages are installed you need to reboot your machine.
After the needed packages are installed, you need to reboot your machine.
[source, bash]
----
$ reboot
----

Now we can you enable the iscsid server.
Now you can enable the _iscsid_ server.

[source, bash]
----
$ systemctl enable iscsid --now
----

++++
<?pdfpagebreak?>
++++
==== Creating file system for {lh}

==== Create filesystem for longhorn
Then we will create with the Logical Volume Management a new logical volume.
The next step is to create a new logical volume with the Logical Volume Managemen.

First we want to create a new physical volume. In our case the second disk is called vdb and we use this as longhorn volume.
First, you need to create a new physical volume. In our case the second disk is called _vdb_. Use this as longhorn volume.
[source, bash]
----
$ pvcreate /dev/vdb
----

After the physical volume is created we create a volume group called vgdata
After the physical volume is created, create a volume group called _vgdata_:
[source, bash]
----
$ vgcreate vgdata /dev/vdb
----

Now we cann create the logical volume and we will use 100% of the disk.
Now create the logical volume; use 100% of the disk.
[source, bash]
----
$ lvcreate -n lvlonghorn -l100%FREE vgdata
----

We will create the XFS filesystem on the logical volume. You don't need to create a partion on top of it.
On the logical volume, create the XFS file system. You do not need to create a partion on top of it.
[source, bash]
----
$ mkfs.xfs /dev/vgdata/lvlonghorn
----

Before we can mount the device we need to create the directory structure.
Before you can mount the device, you need to create the directory structure.
[source, bash]
----
$ mkdir -p /var/lib/longhorn
----

That the mount of the filesystem is persistent we add an entry into the fstab
Add an entry to _fstab_ to ensure that the mount of the file system is persistent:
[source, bash]
----
$ echo -e "/dev/vgdata/lvlonghorn /var/lib/longhorn xfs defaults 0 0" >> /etc/fstab
----

Now we can mount the filesystem
Finally, you can mount the file system as follows:
[source, bash]
----
$ mount -a
Expand Down
4 changes: 2 additions & 2 deletions adoc/SAP-Rancher-RKE2-Installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ In the next step, make sure you select a Kubernetes version that is supported by
++++


If you don't have any further requirements to Kubernetes, you can click the "Create" button at the very bottom.
If you do not have any further requirements to Kubernetes, you can click the *Create* button at the very bottom.
In any other cases talk to your administrators before making adjustements.

After you click *Create*, you should see a screen like this:
After you clicked *Create*, you should see a screen like this:

image::SAP-Rancher-Create-Register.png[title=Rancher create registration,scaledwidth=99%]

Expand Down

0 comments on commit 3dd7f94

Please sign in to comment.