-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into refactor-stuurgegevens
- Loading branch information
Showing
14 changed files
with
40,839 additions
and
240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| FrankConfig.xsd | ||
| Test.properties | ||
| /.idea/ | ||
| /target/ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,18 @@ | ||
| # Contributing | ||
|
|
||
| # Bumping dependencies | ||
| ## Frank!Framework version | ||
| We like to stay up-to-date with the latest version of the Frank!Framework to get the latest features, improvements, bug fixes and security patches. For stability reasons we do not want to use the "latest" tag for this. Instead we periodically(~weekly) do a manual bump to the latest available snapshot build of Frank!Framework at that time. Mainly because we use custom code that needs to be manual checked and updated with changes made in the Frank!Framework. | ||
|
|
||
| Execute the following steps when bumping the Frank!Framework version: | ||
| 1. Look up the latest framework snapshot build on [DockerHub - Frank!Framework](https://hub.docker.com/r/wearefrank/frank-framework/tags). The format of the tag should be: `<major>.<minor>-<date>.<build>`. For example: 7.9-20230907.223421. | ||
| 2. Replace the tag in the `Dockerfile` with the new tag. | ||
| 3. Replace the tag in `frank-runner.properties` with the new tag. | ||
| 4. Start ZaakBrug with the `Frank!Runner` to automatically replace the `./src/main/configuration/<configuration-name>/FrankConfig.xsd` and `./src/main/configuration/FrankConfig.xsd` with the newer version. You can stop the Frank!Runner once the files are replaced. Note that currently the Frank!Runner will also add `FrankConfig.xsd` to the `.gitignore` file. Make sure to revert the change to `.gitignore`. | ||
| 5. Check [GitHub - Frank!Framework - Parameter.java commit history](https://github.com/ibissource/iaf/commits/master/core/src/main/java/nl/nn/adapterframework/parameters/Parameter.java) for any changes to this class. If there are indeed changes, update the corresponding file under `./src/main/java/nl/nn/adapterframework/...`. The `.java-orig` file content should be 1 on 1 equal to the new version on GitHub. Take care to not accidentally remove the intended customization of the code in the `.java` file. | ||
| 6. Run the e2e testsuite by using the below Docker-Compose and configuration to validate the changes. You should only need `docker-compose -f ./docker-compose.zaakbrug.dev.yml -f ./docker-compose.openzaak.dev.yml up --build --force-recreate` for this. (TODO: Automate running of e2e tests in ci/cd). | ||
| 7. Commit you changes on a branch with as message: `build(dependencies): bump f!f version to <new tag>`. Create a PR to have you changes merged to master. | ||
|
|
||
| # Docker-compose | ||
| The docker-compose development environment is designed to be flexible and composable. This prevents the need for developers to run the entire stack eventhough their work requires only a small part of the stack. For this we make use of a docker-compose feature that merges a given array of docker-compose files together. Simply provide a `-f ./docker-compose.<application>.yml` argument for each docker-compose file you wish to include in the `docker-compose up`command. | ||
|
|
||
|
|
@@ -63,3 +76,30 @@ Open Formulieren can be accessed from `host.docker.internal:9000/openforms/` | |
| Open Formulieren is also exposed on `host.docker.internal:9003/` | ||
|
|
||
| TODO | ||
|
|
||
| ## docker-compose.sentry.dev | ||
| Contains a Sentry instance for monitoring applications in the environment. Particularly useful for troubleshooting OpenZaak, OpenForms, etc. | ||
|
|
||
| The Sentry GUI can be accessed at `host.docker.internal:9500` or `localhost:9500`. | ||
|
|
||
| #### Configuration | ||
| Running Sentry for the first time requires some configuration. | ||
|
|
||
| TODO: Automate configuration | ||
|
|
||
| 1. Makes sure the `docker-compose.sentry.dev.yml` is included in your ` docker-compose up` and is running. | ||
| 2. Open a CMD or Powershell in this repository folder and run `docker-compose -f ./docker-compose.sentry.dev.yml exec sentry sentry upgrade`. | ||
| 3. After approx. a minute you will get asked if you want to create a user account. Choose `y` and hit enter. | ||
| 4. We use the following defaults: email=`[email protected]`, password: `admin`. | ||
| 5. Once finished, run the command: `docker-compose -f ./docker-compose.sentry.dev.yml restart sentry` to restart the sentry container. | ||
| 6. Open a browser and navigate to `host.docker.internal:9500` or `localhost:9500`. You should see the Sentry login page. Login we the email and password from step 4. | ||
| 7. Make sure the root url is `http://host.docker.internal:9500` and choose `Please keep my usage information anonymous` under Usage Statistics. | ||
| 8. In the top-right corner hit the `add...` button and choose `project`. | ||
| 9. Select the appropriate platform. For OpenZaak, ZaakBrug-Staging and OpenForms this will be `Django`. Change the project name appropriately and hit the `Create Project` button. | ||
| 10. On the next page look for the word `dsn` and copy the value. | ||
| 11. In the appropriate docker-compose file, add the following to the environment variables of the `open-zaak`, `zaakbrug-staging` and/or `open-forms` service: | ||
| ``` | ||
| - SENTRY_DSN=<Your copied DSN from step 10> | ||
| - SDK_SENTRY_DSN=<Your copied DSN from step 10> | ||
| ``` | ||
| 12. Repeat step 8 - 11 for each application you want to monitor. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| version: '3.8' | ||
|
|
||
| services: | ||
| sentry-redis: | ||
| image: redis:${REDIS_VERSION:-6} | ||
| command: ["redis-server", "--appendonly", "yes"] | ||
| networks: | ||
| - sentry-backend | ||
| volumes: | ||
| - sentry-redis-data:/data | ||
|
|
||
| sentry-postgres: | ||
| image: postgres:${POSTGRES_VERSION:-14} | ||
| environment: | ||
| POSTGRES_USER: sentry | ||
| POSTGRES_PASSWORD: sentry | ||
| POSTGRES_DB: sentry | ||
| POSTGRES_HOST_AUTH_METHOD: trust | ||
| networks: | ||
| - sentry-backend | ||
| volumes: | ||
| - sentry-postgres-data:/var/lib/postgresql/data | ||
|
|
||
| # sentry-pgadmin: | ||
| # image: dpage/pgadmin4:${PGADMIN_VERSION:-latest} | ||
| # user: root | ||
| # depends_on: | ||
| # - sentry-postgres | ||
| # ports: | ||
| # - 5050:80 | ||
| # environment: | ||
| # PGADMIN_DEFAULT_EMAIL: [email protected] | ||
| # PGADMIN_DEFAULT_PASSWORD: admin | ||
| # # volumes: | ||
| # # - sentry-postgres-data:/var/lib/pgadmin | ||
| # networks: | ||
| # - sentry-backend | ||
|
|
||
| sentry: | ||
| image: sentry:${SENTRY_VERSION:-latest} | ||
| depends_on: | ||
| - sentry-redis | ||
| - sentry-postgres | ||
| ports: | ||
| - 9500:9000 | ||
| environment: &sentry-env | ||
| SENTRY_SECRET_KEY: ${SECRET_KEY:-t$9llt$7fu65$nt$rmm4y^(xt)!%imecnia87ta(p4t^vf(w(+} | ||
| SENTRY_POSTGRES_HOST: sentry-postgres | ||
| SENTRY_DB_USER: sentry | ||
| SENTRY_DB_PASSWORD: sentry | ||
| SENTRY_REDIS_HOST: sentry-redis | ||
| networks: | ||
| - sentry-backend | ||
| - zaakbrug-stack | ||
|
|
||
| sentry-cron: | ||
| image: sentry:${SENTRY_VERSION:-latest} | ||
| depends_on: | ||
| - sentry-redis | ||
| - sentry-postgres | ||
| command: "sentry run cron" | ||
| environment: *sentry-env | ||
| networks: | ||
| - sentry-backend | ||
|
|
||
| sentry-worker: | ||
| image: sentry:${SENTRY_VERSION:-latest} | ||
| depends_on: | ||
| - sentry-redis | ||
| - sentry-postgres | ||
| command: "sentry run worker" | ||
| environment: *sentry-env | ||
| networks: | ||
| - sentry-backend | ||
|
|
||
| volumes: | ||
| sentry-redis-data: | ||
| sentry-postgres-data: | ||
|
|
||
| networks: | ||
| zaakbrug-stack: | ||
| sentry-backend: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,4 @@ | ||
| classloader.type=ScanningDirectoryClassLoader | ||
| classloader.type=ScanningDirectoryClassLoader | ||
|
|
||
| # Keep in sync with version in Dockerfile. Detailed instructions can be found in CONTRIBUTING.md. | ||
| ff.version=7.9-20230905.223421 |
Oops, something went wrong.