Skip to content

Commit 388c3fe

Browse files
committed
First doc review: fixing format, wording, page breaks
According to documentation style guide, fixed several format issues, wording, style. Forced page breaks are okay after a chapter, but should not be added inside a chapters for sub-chapters at level 2 and below.
1 parent 588092f commit 388c3fe

File tree

6 files changed

+55
-86
lines changed

6 files changed

+55
-86
lines changed

adoc/SAP-EIC-General.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,14 @@ $ means that the command can be run by any user.
1616

1717

1818
# tag::disclaimer-production-versions[]
19-
IMPORTANT: If you want to use different versions of {slm}, {rancher}, {rke} or {lh}, make sure to check the support matrix for the related solutions you want to use:
19+
IMPORTANT: If you want to use different versions of {slem} or {slm}, {rancher}, {rke} or {lh}, make sure to check the support matrix for the related solutions you want to use:
2020
https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/ +
21-
For {redis} and {pg}, make sure to pick versions compatible to {eic}, which can be found in https://me.sap.com/notes/3247839 . +
22-
Other versions of {metallb} or {cm} can be used but may have not been tested.
21+
For {redis} and {pg}, make sure to pick versions compatible to {eic}, which can be found at https://me.sap.com/notes/3247839 . +
22+
Other versions of {metallb} or {cm} can be used, but they may not have been tested.
2323

2424
# end::disclaimer-production-versions[]
2525

2626

27-
2827
# tag::self-signed-certificates[]
2928

3029
[#selfSignedCertificates]
@@ -40,7 +39,7 @@ The following excerpt provides an example of how to create one with a passphrase
4039
$ openssl req -x509 -sha256 -days 1825 -newkey rsa:2048 -keyout rootCA.key -out rootCA.crt -passout pass:<ca-passphrase> -subj "/C=DE/ST=BW/L=Nuremberg/O=SUSE"
4140
----
4241

43-
This will give you the files `rootCA.key` and `rootCA.crt`.
42+
This will give you the files _rootCA.key_ and _rootCA.crt_.
4443
The server certificate requires a certificate signing request (hereinafter referred to as CSR).
4544
The following excerpt shows how to create such a CSR:
4645

adoc/SAP-EIC-Harvester-main.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ include::SAP-EIC-General.adoc[tags=disclaimer-production-versions]
7373
** {rancher4SAP} *
7474
** {sle_ha} **
7575

76-
+++*+++ The {rancher4SAP} subscription holds support for all required components like {slm}, {rancher} and {harvester}.
76+
+++*+++ The {rancher4SAP} subscription includes support for all required components like {slm}, {rancher} and {harvester}.
7777

7878
+++**+++ Only needed if you want to set up {rancher} in a high availability setup without the {harvester} Load Balancer feature.
7979

@@ -100,12 +100,12 @@ Additionally,
100100

101101
== Landscape Overview
102102

103-
To run {eic} in a production-ready and supported way, you need to set up multiple Kubernetes clusters and their nodes.
104-
Those comprise a Kubernetes cluster where you will install {rancher} to set up and manage the production and non-production clusters.
103+
To run {eic} in a production-ready and supported way, you need to set up multiple Kubernetes clusters and their respective nodes.
104+
These include a Kubernetes cluster where {rancher} is installed to set up and manage both production and non-production clusters.
105105
For this {rancher} cluster, we recommend using three Kubernetes nodes and a Load Balancer.
106106

107-
When using {harvester} you can provision all virtual machines needed within our example landscape.
108-
While the VMs for the {rancher} cluster have to be created in {harvester} itself, the Kubernetes clusters and the related virtual machines can be created through {rancher}.
107+
When using {harvester}, you can provision all virtual machines required for the example landscape.
108+
While the VMs for the {rancher} cluster must be created directly in {harvester}, the Kubernetes clusters and the related virtual machines can be created through {rancher}.
109109

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

adoc/SAP-EIC-Harvester.adoc

Lines changed: 35 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,20 @@
33

44
// {harvester} is SUSE's hyper converged infrastructure solution //TODO
55
# tag::harvester-intro[]
6-
{harvester} is an open-source hyperconverged infrastructure (HCI) software that simplifies the management of virtual machines (VMs) and containerized workloads on bare metal servers. This cloud-native virtualization platform leverages core open-source technologies like Linux, KVM (Kernel-based Virtual Machine), Kubernetes, KubeVirt, and Longhorn, offering a flexible and cost-effective alternative to traditional virtualization.
6+
{harvester} is an open-source hyperconverged infrastructure (HCI) software that simplifies the management of
7+
virtual machines (VMs) and containerized workloads on bare metal servers. This cloud native virtualization platform leverages
8+
core open source technologies like Linux, KVM (Kernel-based Virtual Machine), Kubernetes, KubeVirt, and Longhorn,
9+
offering a flexible and cost-effective alternative to traditional virtualization.
710

811
# end::harvester-intro[]
912

1013

1114
# tag::harvester-setup[]
1215
=== Setting up {harvester}
1316

14-
Please follow the instructions on:
17+
Follow the instructions at the:
1518
link:https://docs.harvesterhci.io/v1.4/[official website for {harvester}]
16-
to get more information how to setup {harvester}.
19+
to get more information how to set up {harvester}.
1720

1821
NOTE: Make sure you meet the hardware requirements specified in
1922
https://docs.harvesterhci.io/v1.4/install/requirements
@@ -26,11 +29,11 @@ to set up your {harvester} environments.
2629

2730
=== Integrating {harvester} into {rancher}
2831

29-
IMPORTANT: Make sure you checked the support matrix at and use a supported {rancher} version:
32+
IMPORTANT: Make sure you checked the support matrix and use a supported {rancher} version:
3033
https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/harvester-v1-4-x/
3134

3235
To benefit from the synergies {rancher} and {harvester} can create, you need to import your {harvester} in the {rancher} UI.
33-
To do so, follow the steps described at:
36+
To do so, follow the steps described here:
3437
link:https://docs.harvesterhci.io/v1.4/rancher/virtualization-management[Importing Harvester cluster]
3538

3639
# end::harvester-rancher-integration[]
@@ -50,7 +53,7 @@ https://docs.harvesterhci.io/v1.4/vm/index
5053

5154
=== Uploading images to {harvester}
5255

53-
To find information how to upload images to {harvester} that will be used to spin up virtual machines, please refer to:
56+
To find information how to upload images to {harvester} that will be used to spin up virtual machines, refer to:
5457

5558
https://docs.harvesterhci.io/v1.4/image/upload-image
5659

@@ -63,17 +66,17 @@ You can get an overview of the currently supported images at https://docs.harves
6366
# tag::harvester-kubernetes-storage[]
6467

6568
A benefit of using {harvester} is the provisioning of storage to your Kubernetes clusters.
66-
If you create a cluster as described in xref:SAP-Rancher-RKE2-Installation.adoc#installRKE2Harvester[the previous chapter], a storageClass will automatically be created within your Kubernetes cluster.
69+
If you create a cluster as described in xref:SAP-Rancher-RKE2-Installation.adoc#installRKE2Harvester[the previous chapter], a _storageClass_ will automatically be created within your Kubernetes cluster.
6770

6871
# end::harvester-kubernetes-storage[]
6972

7073

7174
# tag::harvester-lb[]
7275

73-
You can use {harvester} to create a guest Kubernetes cluster load balancer as also described at
76+
You can use {harvester} to create a guest Kubernetes cluster load balancer, as also described at
7477
https://docs.harvesterhci.io/v1.4/networking/loadbalancer#guest-kubernetes-cluster-load-balancer
7578
and
76-
https://docs.harvesterhci.io/v1.4/rancher/cloud-provider/#load-balancer-support .
79+
https://docs.harvesterhci.io/v1.4/rancher/cloud-provider/#load-balancer-support.
7780

7881

7982
# end::harvester-lb[]
@@ -82,22 +85,20 @@ https://docs.harvesterhci.io/v1.4/rancher/cloud-provider/#load-balancer-support
8285

8386
== Creating an IP Pool in {harvester}
8487

85-
To create an IP Pool, login to your {harvester} instance and go to *Networks -> IP Pools*.
86-
Click on *Create* in the upper right corner to create a new IP Pool:
88+
To create an IP Pool, log in to your {harvester} instance and go to *Networks -> IP Pools*.
89+
Click *Create* in the upper right corner to create a new IP Pool:
8790

88-
image::SAP-EIC-Harvester-IPPool-Empty.png[scaledwidth=99%,opts=inline,Embedded]
91+
image::SAP-EIC-Harvester-IPPool-Empty.png[titel=Create a new IP Pool,scaledwidth=99%,opts=inline,Embedded]
8992

90-
++++
91-
<?pdfpagebreak?>
92-
++++
9393

94-
On the next screen, you should see a menu like this:
9594

96-
image::SAP-EIC-Harvester-IPPool-Create.png[scaledwidth=99%,opts=inline,Embedded]
95+
On the next screen, you should see a menu similar to this:
9796

98-
Click on *Edit as YAML* and adjust the IP Pool to your needs.
97+
image::SAP-EIC-Harvester-IPPool-Create.png[Create IP Pool Menu,scaledwidth=99%,opts=inline,Embedded]
9998

100-
Here's an example for such an IP Pool:
99+
Click *Edit as YAML* and adjust the IP Pool to your needs.
100+
101+
Find an example for an IP Pool below:
101102

102103
[source, yaml]
103104
----
@@ -120,17 +121,14 @@ spec:
120121
type: range
121122
----
122123

123-
When you're done, click the *Create* button at the bottom right.
124+
When you are done, click the *Create* button at the bottom right.
124125

125-
image::SAP-EIC-Harvester-IPPool-Example.png[scaledwidth=99%,opts=inline,Embedded]
126+
image::SAP-EIC-Harvester-IPPool-Example.png[title=IP Pool Example,scaledwidth=99%,opts=inline,Embedded]
126127

127-
++++
128-
<?pdfpagebreak?>
129-
++++
130128

131-
At this point your IP Pool should have been created and show up in list of IP Pools:
129+
At this stage, your IP Pool should have been created and appear in the list of IP Pools.
132130

133-
image::SAP-EIC-Harvester-IPPool.png[scaledwidth=99%,opts=inline,Embedded]
131+
image::SAP-EIC-Harvester-IPPool.png[title=List of IP Pools,scaledwidth=99%,opts=inline,Embedded]
134132

135133
# end::harvester-ippool[]
136134

@@ -148,29 +146,24 @@ If your management network is not managed by a DHCP, your first step would be to
148146

149147
# tag::rancher-harvester-lb-config[]
150148

151-
To create a Load Balancer, login to your {harvester} instance and go to *Networks -> Load Balancers*.
152-
Click on *Create* in the upper right corner to create a new Load Balancer:
149+
To create a Load Balancer, log in to your {harvester} instance and go to *Networks -> Load Balancers*.
150+
Click *Create* in the upper right corner to create a new Load Balancer:
153151

154-
image::SAP-EIC-Harvester-LB-Empty.png[scaledwidth=99%,opts=inline,Embedded]
152+
image::SAP-EIC-Harvester-LB-Empty.png[title=Create New Load Balancer,scaledwidth=99%,opts=inline,Embedded]
155153

156-
++++
157-
<?pdfpagebreak?>
158-
++++
159154

160-
On the next screen, you should see a menu like this:
155+
On the next screen, you should see a menu similar to this:
161156

162-
image::SAP-EIC-Harvester-LB-Create.png[scaledwidth=99%,opts=inline,Embedded]
157+
image::SAP-EIC-Harvester-LB-Create.png[title=CreateLoad Balancer Menu,scaledwidth=99%,opts=inline,Embedded]
163158

164159
Select the IPAM method you want to use - either DHCP or Pool.
165160

166161
// TODO image
167162

168-
++++
169-
<?pdfpagebreak?>
170-
++++
171163

172-
Next configure the *Listeners*. The *Port* is the port on which the Load Balancer will listen for requests. The *Backend Port* will be the port of the target virtual machine the traffic is forwarded to.
173-
If you want to use this Load Balancer to forward traffic to a {rancher} management cluster, you'd need to configure two listeners:
164+
Next, configure the *Listeners*. The *Port* is the port on which the Load Balancer will listen for requests.
165+
The *Backend Port* is the port of the target virtual machine the traffic is forwarded to.
166+
If you want to use this Load Balancer to forward traffic to a {rancher} management cluster, you need to configure two listeners:
174167

175168
[options="header"]
176169
|===
@@ -179,18 +172,14 @@ If you want to use this Load Balancer to forward traffic to a {rancher} manageme
179172
|https|TCP|443|443
180173
|===
181174

182-
image::SAP-EIC-Harvester-LB-Listeners.png[scaledwidth=99%,opts=inline,Embedded]
183-
175+
image::SAP-EIC-Harvester-LB-Listeners.png[title=Configuring Load Balancer Listeners,scaledwidth=99%,opts=inline,Embedded]
184176

185-
++++
186-
<?pdfpagebreak?>
187-
++++
188177

189178
The next step is to configure the *Backend Server Selector*.
190-
Here you'll configure which virtual machines are getting addressed by the Load Balancer.
179+
Here you will specify which virtual machines the Load Balancer will target.
191180
Therefore the *Key* and *Value* must match the *Instance Labels* of the target virtual machines.
192181

193-
image::SAP-EIC-Harvester-LB-Selector.png[scaledwidth=99%,opts=inline,Embedded]
182+
image::SAP-EIC-Harvester-LB-Selector.png[title=Load Balancer Backend Server Selector,scaledwidth=99%,opts=inline,Embedded]
194183

195184

196185

adoc/SAP-EIC-Main.adoc

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::SAP-EIC-General.adoc[tags=disclaimer-EIC-sizing;disclaimer-annotation]
2828

2929
== Supported and used versions
3030

31-
The support matrix below shows which versions of the given software we'll use in this guide.
31+
The support matrix below shows which versions of the given software we will use in this guide.
3232

3333
[cols="1,1"]
3434
|===
@@ -91,7 +91,7 @@ For an HA setup of this cluster, we recommend using three Kubernetes control pla
9191

9292
For a graphical overview of what is needed, take a look at the landscape overview:
9393

94-
image::SAP-EIC-Architecture.svg[scaledwidth=99%,opts=inline,Embedded]
94+
image::SAP-EIC-Architecture.svg[title=Architecture Overview,scaledwidth=99%,opts=inline,Embedded]
9595

9696
* The dark blue rectangles represent Kubernetes clusters.
9797
* The olive rectangles represent Kubernetes nodes that hold the roles of Control Plane and Worker combined.
@@ -122,7 +122,7 @@ By now you should have installed the operating system on every Kubernetes node.
122122
You are now ready to install a {rancher} cluster.
123123
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:
124124

125-
image::SAP-EIC-Architecture-Rancher.svg[scaledwidth=99%,opts=inline,Embedded]
125+
image::SAP-EIC-Architecture-Rancher.svg[title=Architecture SUSE Rancher Prime,scaledwidth=99%,opts=inline,Embedded]
126126

127127
include::SAP-K8s-HA.adoc[tags=**]
128128

@@ -139,18 +139,12 @@ SAP recommends to set up not only a production landscape, but to have QA / Dev
139139
How to do this is covered in this chapter.
140140
Looking at the landscape overview again, we will now deal with setting up the lower part of the given graphic:
141141

142-
image::SAP-EIC-Architecture-RKE2.svg[scaledwidth=99%,opts=inline,Embedded]
143-
144-
++++
145-
<?pdfpagebreak?>
146-
++++
142+
image::SAP-EIC-Architecture-RKE2.svg[title=Architecture Overview RKE2,scaledwidth=99%,opts=inline,Embedded]
147143

148144

149145
include::SAP-Rancher-RKE2-Installation.adoc[tags=!install-rke2-harvester]
150146

151-
++++
152-
<?pdfpagebreak?>
153-
++++
147+
154148

155149
include::SAPDI3-Longhorn.adoc[]
156150

@@ -171,7 +165,7 @@ The easiest way to do so is to use the built-in shell in {rancher}. To access it
171165

172166
image::EIC-Rancher-Kubectl-Button.png[title=Rancher Shell Access,scaledwidth=99%]
173167

174-
A shell will open as shown in the image:
168+
A shell will open as shown in the image below:
175169

176170
image::EIC-Rancher-Kubectl-Shell.png[title=Rancher Shell Overview,scaledwidth=99%]
177171

@@ -183,18 +177,13 @@ You must log in to {rac}. This can be done as follows:
183177
$ helm registry login dp.apps.rancher.io/charts -u <yourUser> -p <your-token>
184178
----
185179

186-
++++
187-
<?pdfpagebreak?>
188-
++++
189180

190181
=== Installing {metallb}
191182

192183
This chapter is intended to guide you through installing and configuring {metallb} on your Kubernetes cluster used for {eic}.
193184

194185
include::SAP-EIC-Metallb.adoc[Metallb, leveloffset=2]
195-
++++
196-
<?pdfpagebreak?>
197-
++++
186+
198187

199188
=== Installing {redis}
200189

@@ -210,9 +199,6 @@ https://redis.io/docs/management/persistence/.
210199

211200
include::SAP-EIC-Redis.adoc[leveloffset=2]
212201

213-
++++
214-
<?pdfpagebreak?>
215-
++++
216202

217203
=== Installing {pg}
218204

@@ -242,9 +228,8 @@ to install {eic} in your prepared environments.
242228
== Appendix
243229

244230
include::SAP-EIC-ImagePullSecrets.adoc[leveloffset=+2]
245-
++++
246-
<?pdfpagebreak?>
247-
++++
231+
232+
248233
include::SAP-EIC-LoginRegistryApplicationCollection.adoc[tags=general-login;eic-reference,leveloffset=+2]
249234

250235
=== Using self-signed certificates

adoc/SAP-EIC-Redis.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
IMPORTANT::
88
SUSE does not offer database support for {redis}.
9-
For support requests contact link:https://redis.com/[Redis Ltd.].
9+
For support requests, contact link:https://redis.com/[Redis Ltd.].
1010

1111

1212
IMPORTANT::
@@ -21,10 +21,6 @@ instead of link:https://redis.io/docs/management/scaling/[{redis} Cluster].
2121
Although {redis} is available for deployment using the {rancher} Apps, we recommend using the {rac}.
2222
The {redis} chart can be found at https://apps.rancher.io/applications/redis.
2323

24-
++++
25-
<?pdfpagebreak?>
26-
++++
27-
2824

2925
=== Deploying the chart
3026

adoc/SAP-K8s-HA.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# tag::rancher-haproxy-preps[]
22
=== Preparation
3-
To have a highly available {rancher} setup, you need a load balancer for your {rancher} nodes.
3+
To provide a highly available {rancher} setup, you need a load balancer for your {rancher} nodes.
44
If you already have a load balancer, you can use that to make {rancher} highly available.
55

66
If you do not plan to set up a highly available {rancher} cluster, you can skip this section.

0 commit comments

Comments
 (0)