diff --git a/apigateway/examples/house-keeping-job/README.md b/apigateway/examples/house-keeping-job/README.md index 2ed2607..b338652 100644 --- a/apigateway/examples/house-keeping-job/README.md +++ b/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. \ No newline at end of file +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. diff --git a/microservicesruntime/examples/msr-post-init/README.md b/microservicesruntime/examples/msr-post-init/README.md index 0bae3c8..0d3afbc 100644 --- a/microservicesruntime/examples/msr-post-init/README.md +++ b/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. diff --git a/microservicesruntime/examples/msr-push-doc-types/README.md b/microservicesruntime/examples/msr-push-doc-types/README.md index 0524021..96d6076 100644 --- a/microservicesruntime/examples/msr-push-doc-types/README.md +++ b/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. diff --git a/mywebmethodsserver/helm/README.md b/mywebmethodsserver/helm/README.md index 740aff1..fceb335 100644 --- a/mywebmethodsserver/helm/README.md +++ b/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 | diff --git a/mywebmethodsserver/helm/README.md.gotmpl b/mywebmethodsserver/helm/README.md.gotmpl index c3dc3bf..24005d6 100644 --- a/mywebmethodsserver/helm/README.md.gotmpl +++ b/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" . }} diff --git a/mywebmethodsserver/helm/templates/statefulset.yaml b/mywebmethodsserver/helm/templates/statefulset.yaml index 9c26402..5e29ca0 100644 --- a/mywebmethodsserver/helm/templates/statefulset.yaml +++ b/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 }} diff --git a/mywebmethodsserver/helm/values.yaml b/mywebmethodsserver/helm/values.yaml index bf738a1..2cf41a2 100644 --- a/mywebmethodsserver/helm/values.yaml +++ b/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 diff --git a/universalmessaging/examples/post-init/README.md b/universalmessaging/examples/post-init/README.md index e10d16a..d61c236 100644 --- a/universalmessaging/examples/post-init/README.md +++ b/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 ... diff --git a/universalmessaging/helm/README.md b/universalmessaging/helm/README.md index 03ecde4..6f2c357 100644 --- a/universalmessaging/helm/README.md +++ b/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) | diff --git a/universalmessaging/helm/README.md.gotmpl b/universalmessaging/helm/README.md.gotmpl index b2f33fb..399db71 100644 --- a/universalmessaging/helm/README.md.gotmpl +++ b/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" . }} diff --git a/universalmessaging/helm/templates/statefulset.yaml b/universalmessaging/helm/templates/statefulset.yaml index 53df81a..e411fdd 100644 --- a/universalmessaging/helm/templates/statefulset.yaml +++ b/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 }} diff --git a/universalmessaging/helm/values.yaml b/universalmessaging/helm/values.yaml index 088127c..b083017 100644 --- a/universalmessaging/helm/values.yaml +++ b/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: |