From 44e1d661bb113626028ec7cd145c3b38b4a72348 Mon Sep 17 00:00:00 2001 From: Jacob Woffenden Date: Mon, 19 Feb 2024 14:21:49 +0000 Subject: [PATCH] Add extra ingress docs (#396) Signed-off-by: Jacob Woffenden --- source/documentation/apps/rshiny-app.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/source/documentation/apps/rshiny-app.md b/source/documentation/apps/rshiny-app.md index 04e8bec7..ea93243b 100644 --- a/source/documentation/apps/rshiny-app.md +++ b/source/documentation/apps/rshiny-app.md @@ -520,12 +520,11 @@ The number of app instances running on `dev`/`prod` is 1 by default, if users ex #### Remember: “With great power comes great responsibility” Your application’s namespace will be one of a number hosted on the same cluster, setting the values too high could crash the cluster! - #### Enabling Web Application Firewall (WAF) for Data Platform Apps There are two flags that need to be set to enable WAF for your application, Ingress.ModSec.enabled and GithubTeam -To do this modify your app's `build-push-deploy-dev.yml` and `build-push-deploy-prod.yml` GitHub action workflow files as follows: +To do this modify your app's `build-push-deploy-dev.yml` and `build-push-deploy-prod.yml` GitHub action workflow files as follows: ``` --set WebApp.Image.Tag=$NEW_TAG_V \ @@ -541,6 +540,20 @@ To disable: > --set Ingress.ModSec.enabled="false" +#### Adding Extra Annotations to an Ingress + +The Data Platform Apps template includes a default set of annotations ([link](https://github.com/ministryofjustice/analytics-platform-helm-charts/blob/222f9b70c51d026dd7c54610ebf7cfcd003064d7/charts/webapp-cp/templates/ingress.yaml#L12-L17)) for the ingress. To include extra annotations, modify your app's `build-push-deploy-dev.yml` and `build-push-deploy-prod.yml` GitHub action workflow files as follows: + +``` +--set 'Ingress.ExtraAnnotations.nginx\.ingress\.kubernetes\.io/key=value' +``` + +To add multiple, use a comma separated string + +``` +--set 'Ingress.ExtraAnnotations.nginx\.ingress\.kubernetes\.io/key=value,Ingress.ExtraAnnotations.nginx\.ingress\.kubernetes\.io/another-key=value' +``` + #### Storage guidance Guidance on storage within Cloud Platform can be found here [Cloud platform storage](https://user-guide.cloud-platform.service.justice.gov.uk/#storage-other-topics)