Skip to content

Commit 61409ee

Browse files
Adding docs for restricted cluster setup for SAP EIC
1 parent 550d022 commit 61409ee

17 files changed

+593
-23
lines changed

adoc/SAP-EIC-General.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ https://help.sap.com/docs/integration-suite?locale=en-US and search for the "Edg
77
# end::disclaimer-EIC-sizing[]
88

99

10-
1110
# tag::disclaimer-production-versions[]
12-
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:
11+
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:
1312
https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/ +
1413
For {redis} and {pg}, make sure to pick versions compatible to {eic}, which can be found at https://me.sap.com/notes/3247839 . +
15-
Other versions of {metallb} or {cm} can be used, but they may not have been tested.
1614

1715
# end::disclaimer-production-versions[]
1816

19-
2017
# tag::self-signed-certificates[]
2118

2219
[#selfSignedCertificates]

adoc/SAP-EIC-Harvester-main-docinfo.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@
6767
<orgname>SUSE</orgname>
6868
</affiliation>
6969
</author>
70+
<author>
71+
<personname>
72+
<firstname>Felipe</firstname>
73+
<surname>Vieira</surname>
74+
</personname>
75+
<affiliation>
76+
<jobtitle>SAP Solution Software Engineer</jobtitle>
77+
<orgname>SUSE</orgname>
78+
</affiliation>
79+
</author>
7080
</authorgroup>
7181

7282
<cover role="logos">

adoc/SAP-EIC-Harvester-main.adoc

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,17 @@ The support matrix below outlines the versions of the software we will be using
5757
|{cm} | {cm_version}
5858
|{pg} | {pg_version}
5959
|{redis} | {redis_version}
60+
|{istio} | {istio_version}
61+
|{kiali} | {kiali_version}
62+
|{prometheus} | {prometheus_version}
63+
|{grafana} | {grafana_version}
6064
|===
6165

66+
[IMPORTANT]
67+
====
6268
include::SAP-EIC-General.adoc[tags=disclaimer-production-versions]
69+
Other versions of {cm} can be used, but they may not have been tested.
70+
====
6371

6472
++++
6573
<?pdfpagebreak?>
@@ -241,7 +249,7 @@ in a Kubernetes cluster in the following chapter.
241249

242250
== Installing the mandatory databases
243251

244-
In the following chapter, we provide an example for setting up {metallb}, {redis} and {pg}.
252+
In the following chapter, we provide an example for setting up {redis} and {pg}.
245253

246254
NOTE: Keep in mind that the descriptions and instructions provided may differ from the
247255
deployment requirements for your specific infrastructure and use cases.
@@ -270,6 +278,40 @@ https://me.sap.com/notes/3247839 are met.
270278

271279
include::SAP-EIC-PostgreSQL.adoc[leveloffset=2]
272280

281+
++++
282+
<?pdfpagebreak?>
283+
++++
284+
285+
== Restricted Access for {eic}
286+
287+
This section provides instructions for configuring Restricted Access feature for {eic}.
288+
289+
NOTE: Keep in mind that the descriptions and instructions provided may differ from the
290+
deployment requirements for your specific infrastructure and use cases.
291+
292+
[#serviceMesh]
293+
=== Configuring the {istio} Service Mesh
294+
295+
This section guides you through configuring the {istio} Service Mesh for the Restricted Access feature on {eic}.
296+
297+
include::SAP-EIC-SharedCluster-main.adoc[tags=istio-installation, leveloffset=+2]
298+
299+
=== Configuring the Monitoring
300+
301+
This section covers the deployment of key monitoring and observability tools
302+
that integrate with the Istio Service Mesh configured previously in <<serviceMesh>>.
303+
304+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-prometheus-installation, leveloffset=+2]
305+
306+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-grafana-installation, leveloffset=+2]
307+
308+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-kiali-installation, leveloffset=+2]
309+
310+
++++
311+
<?pdfpagebreak?>
312+
++++
313+
314+
include::SAP-EIC-SharedCluster-main.adoc[tags=shared-cluster-configuration, leveloffset=+1]
273315

274316
++++
275317
<?pdfpagebreak?>

adoc/SAP-EIC-ImagePullSecrets.adoc

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
To make the resources available for deployment, you need to create an imagePullSecret.
66
In this guide, we use the name _application-collection_ for it.
77

8+
NOTE: For details on authenticating with the {rac}, refer to the https://docs.apps.rancher.io/get-started/first-steps/#distribution-platform[{rac}].
9+
810
# end::application-collection[]
911

1012
# tag::create-kubectl[]
@@ -32,16 +34,26 @@ The related secret can then be used for the components:
3234
* xref:SAP-EIC-Metallb.adoc#metalIPS[MetalLB]
3335
* xref:SAP-EIC-Redis.adoc#redisIPS[Redis]
3436
* xref:SAP-EIC-PostgreSQL.adoc#pgIPS[PostgreSQL]
37+
* Istio (<<istioIPS>>)
38+
* Kiali (<<kialiIPS>>)
39+
* Prometheus (<<prometheusIPS>>)
40+
* Grafana (<<grafanaIPS>>)
41+
* {eic} with Restricted Cluster option (<<elmIPS>>)
3542

3643
# end::eic-links[]
3744

3845
# tag::eic-harvester-links[]
3946

4047
The related secret can then be used for the components:
4148

42-
* Cert-Manager <<rancherIPS>>
43-
* Redis <<redisIPS>>
44-
* PostgreSQL <<pgIPS>>
49+
* Cert-Manager (<<rancherIPS>>)
50+
* Redis (<<redisIPS>>)
51+
* PostgreSQL (<<pgIPS>>)
52+
* Istio (<<istioIPS>>)
53+
* Kiali (<<kialiIPS>>)
54+
* Prometheus (<<prometheusIPS>>)
55+
* Grafana (<<grafanaIPS>>)
56+
* {eic} with Restricted Cluster option (<<elmIPS>>)
4557

4658
# end::eic-harvester-links[]
4759

adoc/SAP-EIC-LoginRegistryApplicationCollection.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,27 @@ end::general-login[]
1919

2020
The login process is needed for the following application installations:
2121

22-
* Cert-Manager <<rancherLIR>>
23-
* MetalLB <<metalLIR>>
24-
* Redis <<redisLIR>>
25-
* PostgreSQL <<pgLIR>>
22+
* Cert-Manager (<<rancherLIR>>)
23+
* MetalLB (<<metalLIR>>)
24+
* Redis (<<redisLIR>>)
25+
* PostgreSQL (<<pgLIR>>)
26+
* Istio (<<istioLIR>>)
27+
* Kiali (<<kialiLIR>>)
28+
* Prometheus (<<prometheusLIR>>)
29+
* Grafana (<<grafanaLIR>>)
2630

2731
# end::eic-reference[]
2832

2933
# tag::eic-harvester-reference[]
3034

3135
The login process is needed for the following application installations:
3236

33-
* Cert-Manager <<rancherLIR>>
34-
* Redis <<redisLIR>>
35-
* PostgreSQL <<pgLIR>>
37+
* Cert-Manager (<<rancherLIR>>)
38+
* Redis (<<redisLIR>>)
39+
* PostgreSQL (<<pgLIR>>)
40+
* Istio (<<istioLIR>>)
41+
* Kiali (<<kialiLIR>>)
42+
* Prometheus (<<prometheusLIR>>)
43+
* Grafana (<<grafanaLIR>>)
3644

3745
# end::eic-harvester-reference[]

adoc/SAP-EIC-Main-docinfo.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@
6464
<orgname>SUSE</orgname>
6565
</affiliation>
6666
</author>
67+
<author>
68+
<personname>
69+
<firstname>Felipe</firstname>
70+
<surname>Vieira</surname>
71+
</personname>
72+
<affiliation>
73+
<jobtitle>SAP Solution Software Engineer</jobtitle>
74+
<orgname>SUSE</orgname>
75+
</affiliation>
76+
</author>
6777
</authorgroup>
6878

6979
<cover role="logos">

adoc/SAP-EIC-Main.adoc

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,17 @@ The support matrix below shows which versions of the given software we will use
4242
|{metallb} | {metallb_version}
4343
|{pg} | {pg_version}
4444
|{redis} | {redis_version}
45+
|{istio} | {istio_version}
46+
|{kiali} | {kiali_version}
47+
|{prometheus} | {prometheus_version}
48+
|{grafana} | {grafana_version}
4549
|===
4650

51+
[IMPORTANT]
52+
====
4753
include::SAP-EIC-General.adoc[tags=disclaimer-production-versions]
54+
Other versions of {metallb} or {cm} can be used, but they may not have been tested.
55+
====
4856

4957
++++
5058
<?pdfpagebreak?>
@@ -148,7 +156,8 @@ include::SAP-Rancher-RKE2-Installation.adoc[tags=!install-rke2-harvester]
148156
<?pdfpagebreak?>
149157
++++
150158

151-
159+
:context-eic-main:
160+
[#preparingStorage]
152161
== Preparing storage
153162

154163
To make storage available for Kubernetes workloads, prepare the storage solution you want to use.
@@ -237,6 +246,41 @@ include::SAP-EIC-PostgreSQL.adoc[leveloffset=2]
237246
<?pdfpagebreak?>
238247
++++
239248

249+
== Restricted Access for {eic}
250+
251+
This section provides instructions for configuring Restricted Access feature for {eic}.
252+
253+
NOTE: Keep in mind that the descriptions and instructions provided may differ from the
254+
deployment requirements for your specific infrastructure and use cases.
255+
256+
[#serviceMesh]
257+
=== Configuring the {istio} Service Mesh
258+
259+
This section guides you through configuring the {istio} Service Mesh for the Restricted Access feature on {eic}.
260+
261+
include::SAP-EIC-SharedCluster-main.adoc[tags=istio-installation, leveloffset=+2]
262+
263+
=== Configuring the Monitoring
264+
265+
This section covers the deployment of key monitoring and observability tools
266+
that integrate with the Istio Service Mesh configured previously in <<serviceMesh>>.
267+
268+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-prometheus-installation, leveloffset=+2]
269+
270+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-grafana-installation, leveloffset=+2]
271+
272+
include::SAP-EIC-SharedCluster-main.adoc[tags=monitoring-kiali-installation, leveloffset=+2]
273+
274+
++++
275+
<?pdfpagebreak?>
276+
++++
277+
278+
include::SAP-EIC-SharedCluster-main.adoc[tags=shared-cluster-configuration, leveloffset=+1]
279+
280+
++++
281+
<?pdfpagebreak?>
282+
++++
283+
240284
== Installing {eic}
241285

242286
// include::SAP-EIC.adoc[]

adoc/SAP-EIC-Metallb.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,18 @@ Create a _values.yaml_ file with the following configuration:
3636

3737
[source,yaml]
3838
----
39-
imagePullSecrets:
40-
- name: application-collection
39+
global:
40+
imagePullSecrets:
41+
- name: application-collection
4142
----
4243

4344
Then install the metallb application.
44-
[source, bash]
45+
[source, bash, subs="attributes"]
4546
----
4647
helm install metallb oci://dp.apps.rancher.io/charts/metallb \
4748
-f values.yaml \
4849
--namespace=metallb \
49-
--version 0.14.7
50+
--version {metallb_chart_version}
5051
----
5152

5253

adoc/SAP-EIC-PostgreSQL.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ podSecurityContext:
8989
To install the application, run:
9090
[source, bash, subs="attributes"]
9191
----
92-
helm install {pg_app_name} oci://dp.apps.rancher.io/charts/{pg_app_name} -f values.yaml --namespace={pg_app_name}
92+
helm install {pg_app_name} oci://dp.apps.rancher.io/charts/{pg_app_name} -f values.yaml --namespace={pg_app_name} --version {pg_chart_version}
9393
----
9494

9595

adoc/SAP-EIC-Redis.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,16 @@ tls:
7777
caCertFilename: "root.pem"
7878
----
7979

80+
ifdef::context-eic-main[]
81+
NOTE: The `storageClassName` in the `values.yaml` file should be adjusted to match the storage class you intend to use.
82+
For more details on configuring storage, refer to <<preparingStorage>>.
83+
endif::[]
84+
8085
To install the application, run:
8186
[source, bash, subs="attributes"]
8287
----
8388
helm install {app_name} oci://dp.apps.rancher.io/charts/{app_name} \
8489
-f values.yaml \
85-
--namespace={app_name}
90+
--namespace={app_name} \
91+
--version {redis_chart_version}
8692
----

0 commit comments

Comments
 (0)