Skip to content

Commit

Permalink
Job: docu for environment variable DEPLOYMENT enhanced
Browse files Browse the repository at this point in the history
  • Loading branch information
thr authored and thr committed May 21, 2024
1 parent de9eb31 commit 0f735de
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 1 deletion.
6 changes: 5 additions & 1 deletion apigateway/examples/house-keeping-job/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions microservicesruntime/examples/msr-post-init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions microservicesruntime/examples/msr-push-doc-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions universalmessaging/examples/post-init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ...
Expand Down

0 comments on commit 0f735de

Please sign in to comment.