ministryofjustice / analytical-platform

Analytical Platform • This repository is defined and managed in Terraform
https://docs.analytical-platform.service.justice.gov.uk
MIT License
12 stars 4 forks source link

✨ Update webapp guidance for AP #4181

Closed mshodge closed 4 months ago

mshodge commented 7 months ago

Describe the feature request.

Based off the issues experienced in https://github.com/ministryofjustice/data-platform-support/issues/544 I thought it would be good to list where the current guidance, and templates can be improved.

Update the template to include the healthcheck

Need the following added before line 164:

--set WebApp.AlternativeHealthCheck.enabled="true" \
--set WebApp.AlternativeHealthCheck.port=9999 \

This is to prevent healthcheck issues

Update the guidance to state the port needs to be 9999

The healthcheck and other endpoints are sent to port 9999, but this normally isn't the default or norm port when people build webapps. So the guidance needs to specific that they need to use port 9999.

A good place to include this is probably where the Dockerfile is first mentioned here.

Add note to make sure user doesn't set the namespace to be the same as the repo name

The Cloud Platform namespace should be different to the github repository name the app is in; this isn't explicitly stated so I think it would be good to just mentioned in here.

Examples of working webapps using different app languages

Would be good to include a list of known, working webapps at the end of the guidance for the various types of webapp people typically create. It's very RShiny heavy at the moment, so examples of Flask, Dash and streamlit would be useful too.

Describe the context.

No response

Value / Purpose

No response

User Types

No response

Ed-Bajo commented 6 months ago

We would look into the suggestions for the guidance.

Emterry commented 4 months ago

https://github.com/moj-analytical-services/user-guidance/pull/424 https://github.com/ministryofjustice/data-platform-app-template/pull/32