Skip to content

Commit 7267b2d

Browse files
authored
📝 updated documentation by rearranging (#242)
* 📝 updated documentation by rearranging * bumped version patch
1 parent 95c2b1e commit 7267b2d

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

charts/refarch-templates/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: refarch-templates
33
description: Helm Chart for deploying a it@M Reference Architecture application.
44
type: application
5-
version: 1.1.9
5+
version: 1.1.10
66
home: https://github.com/it-at-m/helm-charts/tree/main/charts/refarch-templates
77
icon: https://raw.githubusercontent.com/it-at-m/helm-charts/main/images/logo.png
88
dependencies:

charts/refarch-templates/README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,16 @@ refarch-gateway:
118118
```
119119
Further configuration option can be seen in the documentation of the [API-Gateway](https://refarch.oss.muenchen.de/gateway.html).
120120
121+
#### Autorollout (works only on OpenShift)
122+
123+
This feature is ideal for development, so you don't need to update the chart each time. The image tag is linked, for example, to `latest`. Each time the tag gets overridden, a new rollout is triggered ([see also](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/images/triggering-updates-on-imagestream-changes)).
124+
125+
```yaml
126+
imageStream:
127+
enabled: true
128+
name: stream
129+
```
130+
121131
### Module configurations
122132

123133
Modules consist of individual components in an array.
@@ -339,25 +349,11 @@ The following configuration is picked up by default:
339349
> **Note:**: Those defaults are suitable for Spring-based applications, because applications like `refarch-backend` or `refarch-eai` expose those endpoints via Spring Actuator.
340350
Web components like `refarch-frontend` or `refarch-webcomponent` are compatible as well, as those mimic the actuator API
341351

342-
#### Autorollout (works only on OpenShift)
343-
344-
This feature is ideal for development, so you don't need to update the chart each time. The image tag is linked, for example, to `latest`. Each time the tag gets overridden, a new rollout is triggered.
345-
346-
[details](https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/images/triggering-updates-on-imagestream-changes)
347-
348-
```yaml
349-
imageStream:
350-
enabled: true
351-
name: stream
352-
```
353-
354352
#### Service-Monitor (works only on OpenShift)
355353

356-
You can monitor metrics for a service by configuring monitoring stacks managed by the Cluster Observability Operator (COO)
354+
You can monitor metrics for a service by configuring monitoring stacks managed by the Cluster Observability Operator (COO) ([see also](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service#specifying-how-a-service-is-monitored-by-cluster-observability-operator_configuring_the_cluster_observability_operator_to_monitor_a_service)).
357355

358356
```yaml
359357
serviceMonitor:
360358
enabled: true
361359
```
362-
363-
[details](https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/cluster_observability_operator/configuring-the-cluster-observability-operator-to-monitor-a-service#specifying-how-a-service-is-monitored-by-cluster-observability-operator_configuring_the_cluster_observability_operator_to_monitor_a_service)

0 commit comments

Comments
 (0)