Skip to content

Commit 18a951c

Browse files
github-actions[bot]github-actions[bot]
committed
Update README.md automatically via GitHub Actions
1 parent 3593c45 commit 18a951c

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

  • charts/nl-portal-backend/nl-portal-backend

‎charts/nl-portal-backend/nl-portal-backend/README.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,33 +64,33 @@ Kubernetes: `>=1.23.0`
6464
| serviceAccount.annotations | object | `{}` | |
6565
| serviceAccount.create | bool | `true` | |
6666
| serviceAccount.name | string | `""` | |
67-
| settings | object | `{"app":{"features":{"configurationPanel":{"applicationName":"","enabled":false,"token":null,"uri":""}},"logLevel":"INFO","security":{"cors":{"config":{"allowedHeaders":"","allowedMethods":"","allowedOrigins":""},"path":""},"endpoints":{"unsecured":""}}},"database":{"password":"","url":null,"username":"nlportal"},"keycloak":{"audience":null,"clientID":null,"httpRelativePath":null,"realm":null,"token_exchange_secret":null,"url":null,"version":null},"services":{"authentication":{"machtingsdienst":{"resourceUrl":""}},"berichten":{"enabled":false,"properties":{"berichtObjectTypeUrl":""}},"besluitenapi":{"enabled":false,"properties":{"clientId":"","secret":"","url":""}},"catalogiapi":{"enabled":false,"properties":{"clientId":"","documentTypeUrl":"","rsin":"","secret":"","url":""}},"dmn":{"enabled":false,"properties":{"url":""}},"documentenapis":{"enabled":false,"properties":{"configurations":{"dummydoc":{"clientId":"","secret":"","url":""},"openzaak":{"clientId":"","documentTypeUrl":"","rsin":"","secret":"","url":""}},"defaultDocumentApi":""}},"haalcentraal2":{"enabled":false,"properties":{"bewoningApiUrl":"","brpApiUrl":""}},"haalcentraal_brp":{"enabled":false,"properties":{"apiKey":"","ssl":{"enabled":false,"key":{"certChain":"","key":"","keyPassword":""},"trustedCertificate":""},"url":""}},"haalcentraal_hr":{"enabled":false,"properties":{"apiKey":"","ssl":{"enabled":false,"key":{"certChain":"","key":"","keyPassword":""},"trustedCertificate":""},"url":""}},"objectenapi":{"enabled":false,"properties":{"token":"","url":""}},"openklant":{"enabled":false,"properties":{"clientId":"","secret":"","url":""}},"openklant2":{"enabled":false,"properties":{"contactgegevensApiUrl":"","klantinteractiesApiUrl":"","token":""}},"openproduct":{"enabled":false,"properties":{"dmn":{"clientId":"","password":"","secret":"","username":""},"productApiUrl":"","productTypeApiUrl":"","token":""}},"payment":{"direct":{"enabled":false,"properties":{"configurations":{"belastingzaken":{"apiKey":"","apiSecret":"","language":"","pspId":"","returnUrl":"","webhookApiKey":"","webhookApiSecret":""}},"shaOutParameters":"","url":""}},"ogone":{"enabled":false,"properties":{"configurations":{"belastingzaken":{"failureUrl":"","pspId":"","shaInKey":"","shaOutKey":"","successUrl":"","title":""}},"shaOutParameters":"","url":""}}},"prefill":{"enabled":false,"properties":{"typeUrl":""}},"product":{"enabled":false,"properties":{"productDetailsTypeUrl":"","productInstantieTypeUrl":"","productTypeUrl":"","productVerbruiksObjectTypeUrl":""}},"taak":{"enabled":false,"properties":{"typeUrl":"","typeUrlV2":""}},"virusscan":{"clamav":{"enabled":false,"properties":{"hostname":""}}},"zakenapi":{"enabled":false,"properties":{"clientId":"","secret":"","url":"","zaakdocumentenConfig":{"statusWhitelist":"","vertrouwelijkheidsaanduidingWhitelist":""}}}},"theme":{"logo":"","style":""}}` | Application Settings |
67+
| settings | object | `{"app":{"features":{"configurationPanel":{"applicationName":"","enabled":false,"token":null,"uri":""}},"logLevel":"INFO","security":{"cors":{"config":{"allowedHeaders":"","allowedMethods":"","allowedOrigins":""},"path":""},"endpoints":{"unsecured":""}}},"database":{"password":"","url":null,"username":"nlportal"},"keycloak":{"audience":null,"clientID":null,"clientSecret":null,"httpRelativePath":null,"realm":null,"url":null,"version":null},"services":{"authentication":{"machtingsdienst":{"allMachtigingUuid":"","resourceUrl":""}},"berichten":{"enabled":false,"properties":{"berichtObjectTypeUrl":""}},"besluitenapi":{"enabled":false,"properties":{"clientId":"","secret":"","url":""}},"catalogiapi":{"enabled":false,"properties":{"clientId":"","secret":"","url":""}},"dmn":{"enabled":false,"properties":{"clientId":"","password":"","secret":"","ssl":{"enabled":false},"url":"","username":""}},"documentenapis":{"enabled":false,"properties":{"allowedMimeTypes":"","configurations":{"dummydoc":{"clientId":"","secret":"","url":""},"openzaak":{"clientId":"","documentTypeUrl":"","rsin":"","secret":"","ssl":{"enabled":false},"url":""}},"defaultDocumentApi":""}},"haalcentraal2":{"enabled":false,"properties":{"apiKey":"","bewoningApiUrl":"","brpApiUrl":"","brpFields":"","ssl":{"enabled":false}}},"haalcentraalHr":{"enabled":false,"properties":{"apiKey":"","ssl":{"enabled":false,"key":{"certChain":"","key":"","keyPassword":""},"trustedCertificate":""},"url":""}},"objectenapi":{"enabled":false,"properties":{"token":"","url":""}},"openklant2":{"enabled":false,"properties":{"contactgegevensApiUrl":"","digitalAdressenReferentie":"","klantinteractiesApiUrl":"","token":""}},"openproduct":{"enabled":false,"properties":{"dmn":{"clientId":"","password":"","secret":"","username":""},"productApiUrl":"","productTypeApiUrl":"","token":""}},"payment":{"direct":{"enabled":false,"properties":{"configurations":{"belastingzaken":{"apiKey":"","apiSecret":"","currency":"","language":"","pspId":"","returnUrl":"","webhookApiKey":"","webhookApiSecret":""}},"customTemplateUrl":"","shaOutParameters":"","showResultPage":false,"ssl":{"enabled":false},"url":"","webhookHeaders":"","webhookUrl":""}},"ogone":{"enabled":false,"properties":{"configurations":{"belastingzaken":{"currency":"","failureUrl":"","language":"","pspId":"","shaInKey":"","shaOutKey":"","shaVersion":"","successUrl":"","title":""}},"shaOutParameters":"","url":""}}},"prefill":{"enabled":false,"properties":{"prefillShaVersion":"","typeUrl":""}},"product":{"enabled":false,"properties":{"productDetailsTypeUrl":"","productInstantieTypeUrl":"","productTypeUrl":"","productVerbruiksObjectTypeUrl":""}},"taak":{"enabled":false,"properties":{"typeUrl":"","typeUrlV2":""}},"virusscan":{"clamav":{"enabled":false,"properties":{"hostname":"","port":3310}}},"zakenapi":{"enabled":false,"properties":{"clientId":"","secret":"","url":"","useNnpKvkQueryIdentificators":false,"zaakDocumentenConfig":{"statusWhitelist":"","vertrouwelijkheidsaanduidingWhitelist":""},"zaakTypesIdsExcluded":""}}},"theme":{"logo":"","style":""}}` | Application Settings |
6868
| settings.app.features.configurationPanel.token | string | `nil` | If using existingSecret, set via key: CONFIGURATION_PANEL_TOKEN |
6969
| settings.app.logLevel | string | `"INFO"` | TODO: what log levels are there? |
7070
| settings.app.security | object | `{"cors":{"config":{"allowedHeaders":"","allowedMethods":"","allowedOrigins":""},"path":""},"endpoints":{"unsecured":""}}` | CORS configuration |
7171
| settings.database.password | string | `""` | If using existingSecret, set via key: DATABASE_PASSWORD |
7272
| settings.database.url | string | `nil` | Required: JDBC-style URL to a Postgres database, e.g. jdbc:postgresql://localhost:5432/nl-portal |
73-
| settings.keycloak.audience | string | `nil` | Required: TODO: explain |
73+
| settings.keycloak.audience | string | `nil` | Required: Audience used for Keycloak token exchange |
7474
| settings.keycloak.clientID | string | `nil` | Required: Client ID for NL Portal backend |
75+
| settings.keycloak.clientSecret | string | `nil` | If using existingSecret, set via key: KEYCLOAK_CLIENT_SECRET |
7576
| settings.keycloak.httpRelativePath | string | `nil` | Else, you should configure this value if your Keycloak instance has a non-default `KC_HTTP_RELATIVE_PATH`. |
7677
| settings.keycloak.realm | string | `nil` | Required: Keycloak Realm that holds the NL Portal users |
77-
| settings.keycloak.token_exchange_secret | string | `nil` | If using existingSecret, set via key: KEYCLOAK_TOKEN_EXCHANGE_SECRET |
7878
| settings.keycloak.url | string | `nil` | Required: URL of Keycloak, without any route parameters (e.g. without /auth) |
7979
| settings.keycloak.version | string | `nil` | N.B. this is not necessarily the same as the Keycloak Helm chart version. |
8080
| settings.services.besluitenapi.properties.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_BESLUITENAPI_PROPERTIES_SECRET |
8181
| settings.services.catalogiapi.properties.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_CATALOGIAPI_PROPERTIES_SECRET |
82+
| settings.services.dmn.properties.password | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_DMN_PROPERTIES_PASSWORD |
83+
| settings.services.dmn.properties.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_DMN_PROPERTIES_SECRET |
84+
| settings.services.documentenapis.properties.allowedMimeTypes | string | `""` | Comma-separated list of allowed MIME types for document upload |
8285
| settings.services.documentenapis.properties.configurations.dummydoc.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_DOCUMENTENAPIS_PROPERTIES_CONFIGURATIONS_DUMMYDOC_SECRET |
8386
| settings.services.documentenapis.properties.configurations.openzaak.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_DOCUMENTENAPIS_PROPERTIES_CONFIGURATIONS_OPENZAAK_SECRET |
84-
| settings.services.haalcentraal_brp.properties.apiKey | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_BRP_PROPERTIES_APIKEY |
85-
| settings.services.haalcentraal_brp.properties.ssl.key.key | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_BRP_PROPERTIES_SSL_KEY_KEY |
86-
| settings.services.haalcentraal_brp.properties.ssl.key.keyPassword | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_BRP_PROPERTIES_SSL_KEY_KEYPASSWORD |
87-
| settings.services.haalcentraal_brp.properties.ssl.trustedCertificate | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_BRP_PROPERTIES_SSL_TRUSTEDCERTIFICATE |
88-
| settings.services.haalcentraal_hr.properties.apiKey | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_APIKEY |
89-
| settings.services.haalcentraal_hr.properties.ssl.key.key | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_KEY_KEY |
90-
| settings.services.haalcentraal_hr.properties.ssl.key.keyPassword | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_KEY_KEYPASSWORD |
91-
| settings.services.haalcentraal_hr.properties.ssl.trustedCertificate | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_TRUSTEDCERTIFICATE |
87+
| settings.services.haalcentraal2.properties.apiKey | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL2_PROPERTIES_APIKEY |
88+
| settings.services.haalcentraal2.properties.brpFields | string | `""` | Comma-separated list of BRP fields to request (defaults to standard fields if not set) |
89+
| settings.services.haalcentraalHr.properties.apiKey | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_APIKEY |
90+
| settings.services.haalcentraalHr.properties.ssl.key.key | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_KEY_KEY |
91+
| settings.services.haalcentraalHr.properties.ssl.key.keyPassword | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_KEY_KEYPASSWORD |
92+
| settings.services.haalcentraalHr.properties.ssl.trustedCertificate | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_HAALCENTRAAL_HR_PROPERTIES_SSL_TRUSTEDCERTIFICATE |
9293
| settings.services.objectenapi.properties.token | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_OBJECTENAPI_PROPERTIES_TOKEN |
93-
| settings.services.openklant.properties.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_OPENKLANT_PROPERTIES_SECRET |
9494
| settings.services.openklant2.properties.token | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_OPENKLANT2_PROPERTIES_TOKEN |
9595
| settings.services.openproduct.properties.dmn.password | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_OPENPRODUCT_PROPERTIES_DMN_PASSWORD |
9696
| settings.services.openproduct.properties.dmn.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_OPENPRODUCT_PROPERTIES_DMN_SECRET |
@@ -104,6 +104,7 @@ Kubernetes: `>=1.23.0`
104104
| settings.services.payment.ogone.properties.configurations.belastingzaken.shaOutKey | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_PAYMENT_OGONE_PROPERTIES_CONFIGURATIONS_BELASTINGZAKEN_SHAOUTKEY |
105105
| settings.services.payment.ogone.properties.shaOutParameters | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_PAYMENT_OGONE_PROPERTIES_SHAOUTPARAMETERS |
106106
| settings.services.zakenapi.properties.secret | string | `""` | If using existingSecret, set via key: NLPORTAL_CONFIG_ZAKENAPI_PROPERTIES_SECRET |
107+
| settings.services.zakenapi.properties.zaakTypesIdsExcluded | string | `""` | Comma-separated list of zaaktype UUIDs to exclude |
107108
| startupProbe.failureThreshold | int | `90` | |
108109
| startupProbe.httpGet.path | string | `"/actuator/health"` | |
109110
| startupProbe.httpGet.port | string | `"http"` | |

0 commit comments

Comments
 (0)