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

UM + MWS: Container Name added + Docu enhancements

apigateway/examples/house-keeping-job/README.md

@@ -1,3 +1,7 @@
 # House Keeping Job - Purge Transaction Events
 
-The examples in [values.yaml](./values-purge-transaction-events-job.yaml) creates a Kubernetes cron job to purge transaction events of all types which are older than specific days.
+The examples in [values.yaml](./values-purge-transaction-events-job.yaml) creates a Kubernetes cron job to purge transaction events of all types which are older than specific days.
+
+## Job Template and `DEPLOYMENT` Environment Variable
+
+The [Job template](../../helm/templates/job.yaml) is used to create a Kubernetes (Cron) Job object. A feature of this template is to set the environment variable `DEPLOYMENT` with the full deployment name. The deployment name is equal to the Kubernetes service name.

microservicesruntime/examples/msr-post-init/README.md

@@ -8,6 +8,10 @@ This use-case is similar to [msr-push-doc-types](../msr-push-doc-types/README.md
 
 This deployment depends on Universal Messaging. Make sure that UM is up and running before deploying this MSR example.
 
+## Job Template and `DEPLOYMENT` Environment Variable
+
+The [Job template](../../helm/templates/job.yaml) is used to create a Kubernetes (Cron) Job object. A feature of this template is to set the environment variable `DEPLOYMENT` with the full deployment name. The deployment name is equal to the Kubernetes service name.
+
 ## Values
 
 Following [values](./values-deploy-assets-to-um.yaml) create a Kubernetes job to deploy UM assets. The `sagcr.azurecr.io/universalmessaging-tools:10.15` image from [containers registry](https://containers.softwareag.com) is used to create JNDI connection factory. Inside the container, the tool [runUMTool.sh](https://documentation.softwareag.com/universal_messaging/num10-15/webhelp/num-webhelp/index.html#page/num-webhelp%2Fco-clu_standard_administration_tasks.html%23) is called.

microservicesruntime/examples/msr-push-doc-types/README.md

@@ -8,6 +8,10 @@ With the first deployment of IS packages in MSR (as Helm release), the Document
 * `curl` is used to call IS build-in services `pub.utils.messaging:syncDocTypesToUM` and `syncToProvider`. The call requires IS Administrator credentials. To inject the Administrator password into job, you should implement  [examples/msr-using-secrets](../examples/msr-using-secrets/README.md).
 * The job requires the hostname of deployed MSR. It is expected that the full name of Helm release Chart can be used. In order to do, the `job.yaml` Helm template contains a line to set the Helm release full name as environment variable `DEPLOYMENT`. The job shell script uses the endpoint `${DEPLOYMENT}:5555` to call IS build-in services.
 
+## Job Template and `DEPLOYMENT` Environment Variable
+
+The [Job template](../../helm/templates/job.yaml) is used to create a Kubernetes (Cron) Job object. A feature of this template is to set the environment variable `DEPLOYMENT` with the full deployment name. The deployment name is equal to the Kubernetes service name.
+
 ## Values
 
 If you have solved and committed the above prerequisites, you can include the `example/msr-push-doc-types/values.yalm` in the Helm release install or upgrade command with `-f` option.

mywebmethodsserver/helm/README.md

@@ -47,6 +47,7 @@ helm install wm-mws mywebmethodsserver
 | `1.0.0` | Initial release |
 | `1.0.1` | CRD `ServiceMonitor` added |
 | `1.0.2` | `storage.enabled` added in `values.yaml`. For backward reason is this value set to `true` as default. `false` doesn't create and mount any PV. (You can test this feature if you don't want to deploy any own MWS application. MWS is more stateless and has only the database as stateful dependency.) |
+| `1.0.2` | `containerName` added in `values.yaml`. Default is the Chart name. (Use `helm repo update` to get latest Helm Chart version.) |
 
 ## Values
 
@@ -57,6 +58,7 @@ helm install wm-mws mywebmethodsserver
 | autoscaling.maxReplicas | int | `100` |  |
 | autoscaling.minReplicas | int | `1` |  |
 | autoscaling.targetCPUUtilizationPercentage | int | `80` |  |
+| containerName | string | `nil` | The name of the main container, by default this will be Chart name. |
 | extraConfigMaps | list | `[]` | Extra config maps for addtional configurations such as extra ports, etc. |
 | extraContainers | string | `nil` | Extra containers which should run in addtion to the main container as a sidecar - name: do-something   image: busybox   command: ['do', 'something'] |
 | extraEnvs | object | `{}` | Exta environment properties to be passed on to the MyWebMethods Server |

mywebmethodsserver/helm/README.md.gotmpl

@@ -47,5 +47,6 @@ helm install wm-mws mywebmethodsserver
 | `1.0.0` | Initial release |
 | `1.0.1` | CRD `ServiceMonitor` added |
 | `1.0.2` | `storage.enabled` added in `values.yaml`. For backward reason is this value set to `true` as default. `false` doesn't create and mount any PV. (You can test this feature if you don't want to deploy any own MWS application. MWS is more stateless and has only the database as stateful dependency.) |
+| `1.0.2` | `containerName` added in `values.yaml`. Default is the Chart name. (Use `helm repo update` to get latest Helm Chart version.) |
 
 {{ template "chart.valuesSection" . }}

mywebmethodsserver/helm/templates/statefulset.yaml

@@ -68,7 +68,7 @@ spec:
         {{- toYaml .Values.extraInitContainers | nindent 8 }}
       {{- end }}
       containers:
-        - name: {{ .Chart.Name }}
+        - name: {{ .Values.containerName | default .Chart.Name }}
           securityContext:
             {{- toYaml .Values.securityContext | nindent 12 }}
           {{ if .Values.image.tag  }}

mywebmethodsserver/helm/values.yaml

@@ -16,6 +16,9 @@ nameOverride: ""
 # -- Overwrites full workload name. As default, the workload name is release name + '-' + Chart name.
 fullnameOverride: ""
 
+# -- The name of the main container, by default this will be Chart name.
+containerName:
+
 serviceAccount:
   create: false
 

universalmessaging/examples/post-init/README.md

@@ -6,6 +6,10 @@ This example starts a post-initialization job to configure UM after release inst
 
 See general Prerequisites.
 
+## Job Template and `DEPLOYMENT` Environment Variable
+
+The [Job template](../../helm/templates/job.yaml) is used to create a Kubernetes (Cron) Job object. A feature of this template is to set the environment variable `DEPLOYMENT` with the full deployment name. The deployment name is equal to the Kubernetes service name.
+
 ## Values
 
 Download the [values.yaml](./values.yaml) file. Add the content to you existing or create a new file. Afterwards, you can install the release with ...

universalmessaging/helm/README.md

@@ -61,12 +61,14 @@ helm install um webmethods/universalmessaging
 | `1.0.2` | Change startup, liveness and readiness probes. All configuration settings are in `values.yaml`. Now, The probes are using `httpGet` instead of `runUMTool.sh` utility. |
 | `1.0.3` | Make license file handling same as MSR |
 | `1.0.4` | CRD `ServiceMonitor` added |
+| `1.0.4` | `containerName` added in `values.yaml`. Default is the Chart name. (Use `helm repo update` to get latest Helm Chart version.) |
 
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
+| containerName | string | `nil` | The name of the main container, by default this will be Chart name. |
 | customMetricExporterConfig | object | `{"content":""}` | Custom metric JMX exporter configuration. Overwriting the default content of file [jmx_exporter.yaml](./files/jmx_exporter.yaml). See [Prometheus JMX exporter configuration](https://github.com/SoftwareAG/universalmessaging-prometheus-jmx-exporter-config) for more configuration samples. |
 | customServerConfig | object | `{"content":""}` | Custom server configuration file. Overwriting the content of file `Custom_Server_Common.conf` in container.  |
 | externalLoadBalancer | bool | `false` | Deploy Nginx as external LB. The LB will be configured to dispatch incoming requests to all `replicaCount` replicas. Nginx is configured by example from [Universal Messaging documentation](https://documentation.softwareag.com/universal_messaging/num10-15/webhelp/num-webhelp/#page/num-webhelp%2Fre-configure_nginx_to_serve_http_requests.html%23) |

universalmessaging/helm/README.md.gotmpl

@@ -61,5 +61,6 @@ helm install um webmethods/universalmessaging
 | `1.0.2` | Change startup, liveness and readiness probes. All configuration settings are in `values.yaml`. Now, The probes are using `httpGet` instead of `runUMTool.sh` utility. |
 | `1.0.3` | Make license file handling same as MSR |
 | `1.0.4` | CRD `ServiceMonitor` added |
+| `1.0.4` | `containerName` added in `values.yaml`. Default is the Chart name. (Use `helm repo update` to get latest Helm Chart version.) |
 
 {{ template "chart.valuesSection" . }}

universalmessaging/helm/templates/statefulset.yaml

@@ -85,7 +85,7 @@ spec:
       initContainers:
         {{- toYaml .Values.extraInitContainers | nindent 8 }}            
       containers:
-        - name: {{ .Chart.Name }}
+        - name: {{ .Values.containerName | default .Chart.Name }}
           securityContext:
             {{- toYaml .Values.securityContext | nindent 12 }}
           {{ if .Values.image.tag  }}

universalmessaging/helm/values.yaml

@@ -87,6 +87,9 @@ nameOverride: ""
 # -- Overwrites full workload name. As default, the workload name is release name + '-' + Chart name.
 fullnameOverride: ""
 
+# -- The name of the main container, by default this will be Chart name.
+containerName:
+
 # -- Custom server configuration file. Overwriting the content of file `Custom_Server_Common.conf` in container. 
 customServerConfig: 
   content: |