Skip to content

Commit 596648e

Browse files
committed
proofread results
1 parent f4919d1 commit 596648e

1 file changed

Lines changed: 21 additions & 30 deletions

File tree

  • docs/deploy-and-configure/configuration/graphinsights

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

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Follow the instructions related to your deployment type: a) docker-compose or b)
1414

1515
In our Corporate Memory docker-orchestration all main configurations can be directed by setting environment
1616
variables in `environments/config.env`.
17-
You can find the environments are set as usual in `environments/default.env` and `environments/config.env`.
17+
You can find the environment variables set as usual in `environments/default.env` and `environments/config.env`.
1818

19-
Add your license to ```licenses/graphinsights.lic``` then start the extension on a already running Corporate Memory
19+
Add your license to `licenses/graphinsights.lic` then start the extension on an already running Corporate Memory
2020
deployment.
2121

2222
``` console
@@ -29,9 +29,9 @@ Please also have a look at `extensions/README.graphinsights.md`.
2929

3030
### (b) Enable in helm deployment
3131

32-
In helm based deployment you can enable Graph Insights by enable it in your value file.
32+
In helm based deployment you can enable Graph Insights by enabling it in your value file.
3333
It creates a new StatefulSet.
34-
Preemptive you have to create a secret containing your license file.
34+
Preemptively, you have to create a secret containing your license file.
3535

3636
``` console
3737
kubectl -n cmem create secret generic graphinsights-license --from-file your-graphinsights.lic
@@ -45,8 +45,8 @@ graphinsights:
4545
enabled: true
4646
```
4747
48-
Beside enabling the extension you also have to create a route/path in your Ingress or Route.
49-
In the Charts `value.yaml` file is a configuration commented out.
48+
Besides enabling the extension you also have to create a route/path in your Ingress or Route.
49+
In the Chart's `value.yaml` file, a configuration is commented out.
5050
You should enable this in your `value.yaml` file.
5151

5252
``` yaml
@@ -72,7 +72,7 @@ for more information.
7272

7373
## Activate and verify the installation
7474

75-
Fist you have enable the Graph Insight in your Explore workspace. By default ist is disabled.
75+
First, you have to enable the Graph Insight in your Explore workspace. By default, it is disabled.
7676

7777
![Explore workspace configuration](explore-workspace-enable-graphinsights.png)
7878

@@ -84,28 +84,24 @@ Then you are able to create a snapshot, send it to Graph Insights and select the
8484

8585
## Configuration
8686

87-
This section explains the basic configuration of Graph Insights. Since Graph Insights is an application integrated
88-
into explore, we need to have to configure Explore for the integration and Graph Insights as application itself.
87+
This section explains the basic configuration of Graph Insights.
88+
Since Graph Insights is an application integrated into explore, we need to configure Explore for the integration and Graph Insights as application itself.
8989

9090
The following chapters explain the configuration in case you want to change the default behavior.
9191

92-
While the extension in the docker-orchestration it is enabled through Spring profiles, we just use the benefits of
93-
templating in helm and only use one profile.
92+
While the extension in the docker-orchestration is enabled through Spring profiles, we just use the benefits of templating in helm and only use one profile.
9493

95-
This is why the configuration differs in both deployments, but we tried to use the same variable names and configuration
96-
snippets.
94+
This is why the configuration differs in both deployments, but we tried to use the same variable names and configuration snippets.
9795

9896
### Explore configuration
9997

10098
In our **docker-orchestration** you find the file which is loaded as `graphinsight` profile
10199
at `conf/explore/application-graphinsights.yml`.
102100
Environment variables as usual can be found in `environments/default.env` and `environments/config.env`.
103101
Sizing can be changed in the loaded memory profile, e.g. at `environments/config.mem.16g.env`.
104-
The deployment definition for explore with the extension is defined `extensions/docker-compose.graphinsights.yml`
105-
in the explore service.
102+
The deployment definition for explore with the extension is defined in `extensions/docker-compose.graphinsights.yml` in the explore service.
106103

107-
In **helm deployments** you find the needed section inside the `.Values.graphinsights.enabled` in file
108-
at `configuration-files/explore-application.yml`, where most of the configuration is inserted with GO-templates.
104+
In **helm deployments** you find the needed section inside the `.Values.graphinsights.enabled` block in the file at `configuration-files/explore-application.yml`, where most of the configuration is inserted with GO-templates.
109105
Some environment variables are set in the `value.yaml` and rendered in a ConfigMap `templates/explore-configmap.yaml`.
110106

111107
``` yaml
@@ -134,16 +130,14 @@ semspect:
134130

135131
### Graph Insights configuration
136132

137-
Graph Insights, like Explore, is a Spring Boot application, so it gets configured with environment variables and a YAML
138-
file.
133+
Graph Insights, like Explore, is a Spring Boot application, so it gets configured with environment variables and a YAML file.
139134

140135
In our **docker-orchestration** you find the file at `conf/graphinsights/cmem.integration.config.yml`.
141136
Environment variables as usual can be found in `environments/default.env` and `environments/config.env`.
142137
Sizing can be changed in the loaded memory profile, e.g. at `environments/config.mem.16g.env`.
143-
The deployment definition of the extension is defined `extensions/docker-compose.graphinsights.yml`.
138+
The deployment definition of the extension is defined in `extensions/docker-compose.graphinsights.yml`.
144139

145-
In **helm deployments** you find the file at `configuration-files/cmem.integration.config.yml`, which is rendered as
146-
ConfigMap and then mounted into the Graph Insight StatefulSet.
140+
In **helm deployments** you find the file at `configuration-files/cmem.integration.config.yml`, which is rendered as a ConfigMap and then mounted into the Graph Insights StatefulSet.
147141
Environment variables are set in the `value.yaml` and rendered in a ConfigMap `templates/graphinsights-configmap.yaml`.
148142
Sizing regarding memory, CPU or disk usage are configured in the `value.yaml`.
149143

@@ -194,7 +188,7 @@ spring.security.oauth2:
194188
resourceserver:
195189
jwt:
196190
jwk-set-uri: "${OAUTH_JWK_SET_URL}"
197-
# semspect backend for frontent as oauth2client
191+
# semspect backend for frontend as oauth2client
198192
# To enable SLO add this as back-channel logout uri to the client semspect uses:
199193
# http://docker.localhost/graphinsights/logout/connect/back-channel/keycloak
200194
client:
@@ -267,7 +261,7 @@ GRAPHINSIGHTS_OAUTH_CLIENT_ID=graph-insights
267261
268262
# This is the inter component client:
269263
GRAPHINSIGHTS_OAUTH_SERVICE_CLIENT_ID=graph-insights-service-account
270-
# change the credital depending on your client secret, default would be: 7Ctw7eZvTeFYdwwvwopy8OjuMUVPb8A9
264+
# change the credential depending on your client secret, default would be: 7Ctw7eZvTeFYdwwvwopy8OjuMUVPb8A9
271265
GRAPHINSIGHTS_OAUTH_SERVICE_CLIENT_SECRET=changeme
272266
```
273267

@@ -329,18 +323,15 @@ Also have a look below and check if your
329323

330324
In an already running deployment you would have to create those clients on your own.
331325

332-
We assume the we name the clients as following:
326+
We assume that we name the clients as following:
333327

334328
- Browser client: `graph-insights`
335329
- Inter-component client: `graph-insights-service-account`
336330

337331
#### Set Backchannel logout URL for Graph Insights
338332

339-
You would follow the same steps as in
340-
[Keycloak Client configuration](../../../deploy-and-configure/configuration/keycloak/index.md) but name them
341-
differently, e.g. as above.
342-
In addition, on last step is missing: To have the logout working properly you have to add a client Backchannel logout
343-
URL for the client ment for browser authentication (`graph-insights`):
333+
You would follow the same steps as in [Keycloak Client configuration](../../../deploy-and-configure/configuration/keycloak/index.md) but name them differently, e.g. as above.
334+
In addition, one last step is missing: To have the logout working properly you have to add a client Backchannel logout URL for the client meant for browser authentication (`graph-insights`):
344335

345336
- Select the `eccenca Corporate Memory`-realm
346337
- Select `Clients`

0 commit comments

Comments
 (0)