Merge pull request #23 from SoftwareAG/dev-readme

Several little changes in READMEs and examples

README.md

@@ -36,7 +36,7 @@ Each chart has a README for *how to use* and lists some prerequisites.
 
 ## Chart Versions
 
-Per default, Helm uses the latest version on release installation. If you have successfully installed a webMethods release, you should notice the current used Chart version. Therefore, on further release installation oder upgrades (with `helm upgrade --install`) you should use the `--version X.Y.Z` to guarantee that the same is installed everywhere.
+Per default, Helm uses the latest version on release installation. If you have successfully installed a webMethods release, you should notice the current used Chart version. Therefore, on further release installation or upgrades (with `helm upgrade --install`) you should use the `--version X.Y.Z` to guarantee that the same is installed everywhere.
 
 ## Utilities
 

microservicesruntime/examples/msr-push-doc-types/values.yaml

@@ -34,5 +34,5 @@ jobs:
         for dt in ${pusdDTs};
         do
           echo Pushing [${dt}] ...;
-          curl -s -u "Administrator:${ADMIN_PASSWORD}" -H "Content-Type: application/json" "${DEPLOYMENT}:5555/invoke/pub.publish:syncToProvider?documentTypes[0]=${dt}" | jq '.';
+          curl -X POST -s -u "Administrator:${ADMIN_PASSWORD}" -H "Content-Type: application/json" "${DEPLOYMENT}:5555/invoke/pub.publish:syncToProvider" -d "{ \"documentTypes\": [\"${dt}\"] }" | jq '.';
         done;

microservicesruntime/examples/process-engine/values.yaml

@@ -172,7 +172,7 @@ microservicesruntime:
 
 jobs:
 # -- Create PE topics in UM on Helm post-install hook 
-- name: deploy-PE-assets-to-um
+- name: deploy-pe-assets-to-um
   annotations:
     "helm.sh/hook": post-install
     "helm.sh/hook-weight": "0"

microservicesruntime/helm/README.md

@@ -63,10 +63,16 @@ Install release with pulling image and setting secret (to pull image) ...
 helm install wm-msr webmethods/microservicesruntime   \
 ```
 
-... (optionally) provide the license key at installation time (can be ommitted for upgrade later)
+... (optionally) provide the license key at installation time (can be ommitted for upgrade later) ...
 
 ```shell
---set-file=licensekey=<your path and filename to Microservices Runtime license file>
+--set-file=licensekey=<your path and filename to Microservices Runtime license file> \
+```
+
+... set your own image pull secret if you didn't create the default `regcred` ...
+
+```shell
+--set "imagePullSecrets[0].name=your-registry-credentials" \
 ```
 
 ... Ingress is enabled per default. Define Ingress service host ...

microservicesruntime/helm/README.md.gotmpl

@@ -63,10 +63,16 @@ Install release with pulling image and setting secret (to pull image) ...
 helm install wm-msr webmethods/microservicesruntime   \
 ```
 
-... (optionally) provide the license key at installation time (can be ommitted for upgrade later)
+... (optionally) provide the license key at installation time (can be ommitted for upgrade later) ...
 
 ```shell
---set-file=licensekey=<your path and filename to Microservices Runtime license file>
+--set-file=licensekey=<your path and filename to Microservices Runtime license file> \
+```
+
+... set your own image pull secret if you didn't create the default `regcred` ... 
+
+```shell
+--set "imagePullSecrets[0].name=your-registry-credentials" \
 ```
 
 ... Ingress is enabled per default. Define Ingress service host ...

universalmessaging/helm/README.md

@@ -22,6 +22,8 @@ Hence before running `helm install` create the configmap:
 kubectl create configmap universalmessaging-licence-key --from-file=licence.xml=<your path and filename to Universal Messaging license file>
 ```
 
+Optionally you can also provide the license directly when installing your release (see also below).
+
 ## Examples for Use-cases
 
 Sub-folder `examples` contains some *values* examples for more use-cases. To use the use-case, adapt and add the provided `values.yaml` to your values.
@@ -38,6 +40,18 @@ Install release
 helm install um webmethods/universalmessaging
 ```
 
+... (optionally) provide the license key at installation time (can be ommitted for upgrade later) ...
+
+```shell
+--set-file=licensekey=<your path and filename to Universal Messaging license file> \
+```
+
+... set your own image pull secret if you didn't create the default `regcred` ...
+
+```shell
+--set "imagePullSecrets[0].name=your-registry-credentials" \
+```
+
 ## Version History
 
 | Version | Changes and Description |

universalmessaging/helm/README.md.gotmpl

@@ -22,6 +22,8 @@ Hence before running `helm install` create the configmap:
 kubectl create configmap universalmessaging-licence-key --from-file=licence.xml=<your path and filename to Universal Messaging license file>
 ```
 
+Optionally you can also provide the license directly when installing your release (see also below).
+
 ## Examples for Use-cases
 
 Sub-folder `examples` contains some *values* examples for more use-cases. To use the use-case, adapt and add the provided `values.yaml` to your values.
@@ -38,6 +40,18 @@ Install release
 helm install um webmethods/universalmessaging
 ```
 
+... (optionally) provide the license key at installation time (can be ommitted for upgrade later) ...
+
+```shell
+--set-file=licensekey=<your path and filename to Universal Messaging license file> \
+```
+
+... set your own image pull secret if you didn't create the default `regcred` ... 
+
+```shell
+--set "imagePullSecrets[0].name=your-registry-credentials" \
+```
+
 ## Version History
 
 | Version | Changes and Description |

universalmessaging/helm/templates/license.yaml

@@ -0,0 +1,36 @@
+{{ if .Values.license }}
+---
+# /*
+#  * Copyright (c) 2021 Software AG, Darmstadt, Germany and/or its licensors
+#  *
+#  * SPDX-License-Identifier: Apache-2.0
+#  *
+#  *   Licensed under the Apache License, Version 2.0 (the "License");
+#  *   you may not use this file except in compliance with the License.
+#  *   You may obtain a copy of the License at
+#  *
+#  *       http://www.apache.org/licenses/LICENSE-2.0
+#  *
+#  *   Unless required by applicable law or agreed to in writing, software
+#  *   distributed under the License is distributed on an "AS IS" BASIS,
+#  *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  *   See the License for the specific language governing permissions and
+#  *   limitations under the License.
+#  *
+#  */
+
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ .Values.licenseConfigMap }}
+  labels:  
+    {{- include "common.labels.standard" . | nindent 4 }}
+    {{- with .Values.extraLabels -}}
+    {{ toYaml . | nindent 4 }}
+    {{- end }}
+  annotations:
+    helm.sh/resource-policy: keep
+data:
+  licensekey:
+    {{ .Values.license | toYaml | nindent 4 }}
+{{- end }}