Skip to content

Commit

Permalink
Merge pull request #8 from forza-mor-rotterdam/add-v1-prefix-on-endpo…
Browse files Browse the repository at this point in the history
…ints

Rename taaktypes to taaktype and add some readme info
  • Loading branch information
DelanoWAF committed Jul 2, 2024
2 parents 223e777 + 7164777 commit 3236f6f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 49 deletions.
75 changes: 29 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,31 @@
# morcore2ultimo

Project for Frank applications deployed by JAR or Docker

<!-- TOC -->
* [Skeleton Project for Frank applications deployed by JAR or Docker](#skeleton-project-for-frank-applications-deployed-by-jar-or-docker)
* [Introduction](#introduction)
* [Included](#included)
* [Usage](#usage)
* [Steps](#steps)
* [Template variables](#template-variables)
<!-- TOC -->

## Introduction

This project serves as a starting point for new projects or as example for existing ones.
This "empty" Frank! will have configuration files to build and deploy.

## Included

* Dockerfile
* Docker compose
* Publicode (WIP)
* GitHub Actions
* Continuous Integration workflow
* Release workflow

Please check if you deem all these functionalities necessary, if not remove them.

## Usage

### Steps

1. Create a new repository and choose this as template repository
2. Clone the newly created project
3. Fill in the skeletonrc.json to replace the template strings
4. Run the skeleton.js script with node e.g. `node ./skeleton.js`
5. Add your own configuration files
6. Make sure that the GitHub action credentials are added
7. Commit & Profit!

### Template variables

| Template variable | Description | Example |
|-------------------------------|------------------------------------------------------------------------------------------------|----------------|
| `morcore2ultimo` | The name of the Frank! to be deployed. It's best to keep this inline with the name of the repo | Frank2Skeleton |
| `morcore2ultimo` | Lowercase version of the instance name. | frank2example |
| `morcoreMessageProcessor` | The name of the first configuration (others have to be added manually) | Sans |
## Frank!Console

After deployment the Frank!Console is available on `/iaf/gui`

## Helm values

image.registry=docker.io
image.repository=wearefrank/morcore2ultimo
image.tag=latest
image.pullPolicy=Always

connections.create=true
connections.jdbc[0].type=postgresql
connections.jdbc[0].host=
connections.jdbc[0].database=
connections.jdbc[0].username=
connections.jdbc[0].password=

ingress.enabled=false

frank.dtap.stage=ACC

MorCore.taak.API.root-url=https://mor-core-acc.forzamor.nl/
Ultimo.ESB.root-url=https://ultimo-env-name.ultimo.net/api/V1/Action/

frank.credentials.secret=app-secrets
frank.credentials.key=credentials.properties
Frank.API.root-url=https://your-frank-domain

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<Receiver name="Frank_ListTaakTypes">
<ApiListener
name="Frank_ListTaakTypes"
uriPattern="/api/v1/taaktypes"
uriPattern="/api/v1/taaktype"
headerParams="Authorization" />
</Receiver>

Expand All @@ -31,7 +31,7 @@
</FixedResultPipe>

<FixedResultPipe name="InputTaaktypesLijst" filename="responses/ZaakTypes.xml" getInputFromSessionKey="originalMessage"/>

<ReplacerPipe name="InsertHostName" find="[hostname]" replace="${Frank.API.root-url}"/>

<XmlValidatorPipe name="ValidateInputMessage" schema="xsd/ValidateGetTaakTypes.xsd"
Expand All @@ -52,7 +52,7 @@
<Receiver name="Frank_GetTaakType">
<ApiListener
name="Frank_GetTaakType"
uriPattern="/api/v1/taaktypes/{uuid}"
uriPattern="/api/v1/taaktype/{uuid}"
headerParams="Authorization" />
</Receiver>

Expand Down

0 comments on commit 3236f6f

Please sign in to comment.