Merge pull request #63 from SoftwareAG/dev-msr-thr

MSR READMEs updated for fluentd sidecar
SoftwareAG · Mar 7, 2024 · 455b74c · 455b74c
2 parents 8f70c9d + 5010c43
commit 455b74c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/apigateway/helm/README.md b/apigateway/helm/README.md
@@ -250,6 +250,9 @@ helm upgrade -i -f myvalues.yaml --set ingress.tls.key="$(<key.pem)" --set ingre
 | ingress.tls.secretProviderName | string | `""` |  |
 | ingress.tls.secretProviderParameters | object | `{}` |  |
 | ingresses.admin.annotations."nginx.ingress.kubernetes.io/affinity" | string | `"cookie"` |  |
+| ingresses.admin.annotations."nginx.ingress.kubernetes.io/proxy-body-size" | string | `"10m"` |  |
+| ingresses.admin.annotations."nginx.ingress.kubernetes.io/proxy-read-timeout" | string | `"600"` |  |
+| ingresses.admin.annotations."nginx.ingress.kubernetes.io/proxy_connect_timeout" | string | `"600"` |  |
 | ingresses.admin.className | string | `"nginx"` |  |
 | ingresses.admin.defaultHost | string | `""` |  |
 | ingresses.admin.enabled | bool | `true` |  |
@@ -262,7 +265,9 @@ helm upgrade -i -f myvalues.yaml --set ingress.tls.key="$(<key.pem)" --set ingre
 | ingresses.admin.tls[0].secretName | string | `nil` |  |
 | ingresses.admin.tls[0].secretProviderEnabled | bool | `false` |  |
 | ingresses.admin.tls[0].secretProviderSecretName | string | `nil` |  |
-| ingresses.rt.annotations | object | `{}` |  |
+| ingresses.rt.annotations."nginx.ingress.kubernetes.io/proxy-body-size" | string | `"10m"` |  |
+| ingresses.rt.annotations."nginx.ingress.kubernetes.io/proxy-read-timeout" | string | `"600"` |  |
+| ingresses.rt.annotations."nginx.ingress.kubernetes.io/proxy_connect_timeout" | string | `"600"` |  |
 | ingresses.rt.className | string | `"nginx"` |  |
 | ingresses.rt.defaultHost | string | `""` |  |
 | ingresses.rt.enabled | bool | `true` |  |
@@ -276,6 +281,9 @@ helm upgrade -i -f myvalues.yaml --set ingress.tls.key="$(<key.pem)" --set ingre
 | ingresses.rt.tls[0].secretProviderEnabled | bool | `false` |  |
 | ingresses.rt.tls[0].secretProviderSecretName | string | `nil` |  |
 | ingresses.ui.annotations."nginx.ingress.kubernetes.io/affinity" | string | `"cookie"` |  |
+| ingresses.ui.annotations."nginx.ingress.kubernetes.io/proxy-body-size" | string | `"10m"` |  |
+| ingresses.ui.annotations."nginx.ingress.kubernetes.io/proxy-read-timeout" | string | `"600"` |  |
+| ingresses.ui.annotations."nginx.ingress.kubernetes.io/proxy_connect_timeout" | string | `"600"` |  |
 | ingresses.ui.className | string | `"nginx"` |  |
 | ingresses.ui.defaultHost | string | `""` |  |
 | ingresses.ui.enabled | bool | `true` |  |

diff --git a/microservicesruntime/examples/msr-fluentd-sidecar/README.md b/microservicesruntime/examples/msr-fluentd-sidecar/README.md
@@ -4,7 +4,11 @@ This sample shows how to run Microservices Runtime with a Fluentd sidecar contai
 
 ## Prerequisites
 
-The fluentd sidecar container requires a fluentd configuration file. This sample uses the [fluentd.conf](fluentd.conf) file. The fluentd configuration file is mounted as a volume in the fluentd sidecar container and provided through the sample values file.
+The fluentd sidecar container requires a fluentd configuration file. This sample uses the `fluentd.conf` file. The *fluentd* configuration file is mounted as a volume in the fluentd sidecar container and provided through the sample values file.
+
+## Provided Example
+
+This example provides the [values.yaml](./values.yaml) and use the `extraConfigMaps`, `extraVolumeMounts`, `extraVolumes` and `extraContainers` to setup a fluentd sidecar container.
 
 ## Installing the Chart
 

diff --git a/microservicesruntime/helm/README.md b/microservicesruntime/helm/README.md
@@ -51,6 +51,7 @@ Sub-folder `examples` contains some *values* examples for more use-cases. To use
 |-----|------|
 | [external-postgresql-db](../examples/external-postgresql-db/README.md) | Using MSR with external PostgresQL database |
 | [msr-defaults](../examples/msr-defaults/README.md) | Recommended default application properties|
+| [Fluentd Sidecar](../examples/msr-fluentd-sidecar/README.md) | Running with Fluentd Sidecar |
 | [msr-post-init](../examples/msr-post-init/README.md) | Performs *post-init* actions after startup, e.g. deploy assets to Universal Messaging |
 | [msr-push-doc-types](../examples/msr-push-doc-types/README.md) | Pushing IS Document Types after startup |
 | [msr-statefulset-csq](../examples/msr-statefulset-csq/README.md) | Deploy MSR with stateful set |

diff --git a/microservicesruntime/helm/README.md.gotmpl b/microservicesruntime/helm/README.md.gotmpl
@@ -51,6 +51,7 @@ Sub-folder `examples` contains some *values* examples for more use-cases. To use
 |-----|------|
 | [external-postgresql-db](../examples/external-postgresql-db/README.md) | Using MSR with external PostgresQL database |
 | [msr-defaults](../examples/msr-defaults/README.md) | Recommended default application properties|
+| [Fluentd Sidecar](../examples/msr-fluentd-sidecar/README.md) | Running with Fluentd Sidecar |
 | [msr-post-init](../examples/msr-post-init/README.md) | Performs *post-init* actions after startup, e.g. deploy assets to Universal Messaging |
 | [msr-push-doc-types](../examples/msr-push-doc-types/README.md) | Pushing IS Document Types after startup |
 | [msr-statefulset-csq](../examples/msr-statefulset-csq/README.md) | Deploy MSR with stateful set |