Skip to content

Commit 44133fc

Browse files
committed
update linter issues and copy/paste issue.
1 parent 4049c1a commit 44133fc

File tree

1 file changed

+18
-22
lines changed
  • docs/deploy-and-configure/configuration/graphinsights

1 file changed

+18
-22
lines changed

docs/deploy-and-configure/configuration/graphinsights/index.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tags:
88

99
## Enable Graph Insights
1010

11+
Follow the instructions related to your deployment type: a) docker-compose or b) helm / Kubernetes based.
12+
1113
### (a) Enable in docker-compose deployment
1214

1315
In our Corporate Memory docker-orchestration all main configurations can be directed by setting environment
@@ -32,7 +34,7 @@ It creates a new StatefulSet.
3234
Preemptive you have to create a secret containing your license file.
3335

3436
``` console
35-
- "kubectl -n cmem create secret generic graphinsights-license --from-file your-graphinsights.lic
37+
kubectl -n cmem create secret generic graphinsights-license --from-file your-graphinsights.lic
3638
```
3739

3840
All needed configuration can be done in the Corporate Memory helm chart `value.yaml` file.
@@ -60,15 +62,14 @@ See [Configure OAuth clients (helm)](../../../deploy-and-configure/configuration
6062

6163
The configuration mentioned below is rendered with those files, but you usually don't have to touch those:
6264

63-
- `configuration-files/explore-application.yml` for Explore
64-
- `configuration-files/cmem.integration.config.yml` for Graph Insights
65+
- `configuration-files/explore-application.yml` for Explore
66+
- `configuration-files/cmem.integration.config.yml` for Graph Insights
6567

6668
For more details please have a look in the helm value file.
6769
Every configuration is documented there.
6870
Please refer to [Kubernetes deployments](../../../deploy-and-configure/installation/scenario-k8s-deployment/index.md)
6971
for more information.
7072

71-
7273
## Activate and verify the installation
7374

7475
Fist you have enable the Graph Insight in your Explore workspace. By default ist is disabled.
@@ -81,8 +82,6 @@ Then you are able to create a snapshot, send it to Graph Insights and select the
8182

8283
![Explore select_graphinsights](explore-select-graphinsights-tab.png)
8384

84-
85-
8685
## Configuration
8786

8887
This section explains the basic configuration of Graph Insights. Since Graph Insights is an application integrated
@@ -143,7 +142,6 @@ Environment variables as usual can be found in `environments/default.env` and `e
143142
Sizing can be changed in the loaded memory profile, e.g. at `environments/config.mem.16g.env`.
144143
The deployment definition of the extension is defined `extensions/docker-compose.graphinsights.yml`.
145144

146-
147145
In **helm deployments** you find the file at `configuration-files/cmem.integration.config.yml`, which is rendered as
148146
ConfigMap and then mounted into the Graph Insight StatefulSet.
149147
Environment variables are set in the `value.yaml` and rendered in a ConfigMap `templates/graphinsights-configmap.yaml`.
@@ -243,7 +241,6 @@ logging:
243241
Please refer to [Graph Insights Sizing](../../../deploy-and-configure/requirements/graph-insights-sizing.md) for more
244242
information.
245243

246-
247244
### OAuth configuration
248245

249246
Graph Insights requires authentication similar to Explore and Build (DataIntegration).
@@ -318,12 +315,12 @@ separate clients are already created when starting the Postgresql container.
318315

319316
However, regenerating a new client secret is advisable:
320317

321-
- Select the `eccenca Corporate Memory`-realm
322-
- Select `Clients`
323-
- Select the client `graph-insights-service-account`.
324-
- Select the tab `Credentials`
325-
- Press `Regenerate`
326-
- Then copy the new secret and fill in the values from above.
318+
- Select the `eccenca Corporate Memory`-realm
319+
- Select `Clients`
320+
- Select the client `graph-insights-service-account`.
321+
- Select the tab `Credentials`
322+
- Press `Regenerate`
323+
- Then copy the new secret and fill in the values from above.
327324

328325
![Keycloak client secret regenerate](keycloak-client-secret-regenerate.png)
329326

@@ -333,8 +330,9 @@ Also have a look below and check if your
333330
In an already running deployment you would have to create those clients on your own.
334331

335332
We assume the we name the clients as following:
336-
- Browser client: `graph-insights`
337-
- Inter-component client: `graph-insights-service-account`
333+
334+
- Browser client: `graph-insights`
335+
- Inter-component client: `graph-insights-service-account`
338336

339337
#### Set Backchannel logout URL for Graph Insights
340338

@@ -344,11 +342,9 @@ differently, e.g. as above.
344342
In addition, on last step is missing: To have the logout working properly you have to add a client Backchannel logout
345343
URL for the client ment for browser authentication (`graph-insights`):
346344

347-
- Select the `eccenca Corporate Memory`-realm
348-
- Select `Clients`
349-
- Select the client `graph-insights`.
350-
- Scroll down to this section and add this: `https://<your-deploy-host>/graphinsights/logout/connect/back-channel/keycloak`
351-
345+
- Select the `eccenca Corporate Memory`-realm
346+
- Select `Clients`
347+
- Select the client `graph-insights`.
348+
- Scroll down to this section and add this: `https://<your-deploy-host>/graphinsights/logout/connect/back-channel/keycloak`
352349

353350
![Keycloak backchannel LogExplore select_graphinsights](keycloak-client-backchannel.png)
354-

0 commit comments

Comments
 (0)