alphagov / paas-community

🏣 🚀⚡GOV.UK PaaS

paas-community

A repository where GOV.UK PaaS and our user community store code snippets, demos, and recipes for how to run useful software.

If you're new to GOV.UK PaaS these examples can help teach you how to use it. If you're an established user you can learn new ways of doing things. This sits alongside our written documentation.

Index

alertmanager shows you how to run the Alertmanager alert management and routing tool for Prometheus on GOV.UK PaaS.

department-examples contains demos that we have done with departments and councils.

helloworld-examples some simple examples showing how to deploy different languages

jaeger shows you how to run a distributed tracing and analysis server.

kong enables you to run Kong, the open source API platform on GOV.UK PaaS

nginx-301 a configuration of nginx ready for performing 301 domain redirects for things that have moved off the platform.

pgadmin4 shows you how to run PgAdmin4 on GOV.UK PaaS to administer your Postgres backing services.

sentry shows you how to run the Sentry exception monitoring tool on GOV.UK PaaS.

stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks.

the-hive is an open-source incident management platform.

Other sources of examples

GOV.UK PaaS is based on Cloud Foundry. The Cloud Foundry community maintain another shared set of examples in the cloudfoundry-samples GitHub organisation

Some of the GOV.UK PaaS tenants also have examples to share and ways they've solved problems too:

• How DfE are using terraform to deploy a Prometheus ecosystem to Cloud Foundry for monitoring on GOV.UK PaaS
• Recordings of presentations from our GOV.UK PaaS Community Show and Tells are available on YouTube

Contributing

If you discover any errors, or if you have an open source tool which you run on GOV.UK PaaS and want to share it, please fork this repository and raise a pull request.

Disclaimer

These components are not officially supported by GOV.UK PaaS.

paas-community's Issues

add an example of how to use the influxdb backing service to self host prometheus on the PaaS

investigate hosting the spree ecommerce platform on PaaS

https://spreecommerce.org/

Add an example of how to access an AWS sqs queue in python/flask

A minimal worked example in python to show how to interact with a paas provisioned queue

• python3
• flask
• gunicorn
• boto3

add an example that shows how to use the cloud foundry terraform provider to provision GOV.UK applications and services

https://github.com/cloudfoundry-community/terraform-provider-cf is a thing that is being used buy a number of teams. Organisations that use terraform to shape their IAAS may like to manage their PaaS estate in the same way.

See https://pay-omnibus-docs.london.cloudapps.digital/infrastructure.html#infrastructure to understand how GOV.UK Pay makes use of terraform to manage micro services in GOV.UK PaaS

add a worked example for hosting the keycloak identity and access management service

The GOV.UK PaaS does not offer an IDAM option "out of the box", this is something that the tenant must bring with them to the platform. see: https://www.cloud.service.gov.uk/constraints

One possible solution is to use keycloak

investigate postgrest to expose a posgres database as an API for crud transactiond

spike out using postgrest with a paas backing service to explore idiomatic paas patterns for providing a simple API to a database as an alternative to

• a headless content management system
• running something like wordpress in headless mode

Add a worked example of how to self host grafana to the incubator

potentiall using something like https://github.com/SpringerPE/cf-grafana-buildpack as suggested by @tlwr

add example of how to host the axe-core accessibility testing tool on paas

• https://github.com/dequelabs/axe-core

Add a worked example of running periodic scheduled tasks in python

There is a requirement for tenants to run scheduled tasks in our roadmap https://github.com/alphagov/paas-roadmap/issues/52

For tenants using.python a example using the schedule would be useful since it solves a common problem.

Reasons to run a scheduled task include

• periodic generation of output
• periodic ingestion of data from exter al data sources, s3 buckets
• housekeeping

add an example to paas-incubator to show the use of sidekiq with ruby and the redis backing service

Teams using ruby typically want to use sidekiq with their application and a redis backing service. It would be helpful to have a simple example in the incubator that we can point developers at to help them understand the pattern in the context of Cloud Foundry