FFC Template Node

Template to support rapid delivery of microservices for FFC Platform. It contains the configuration needed to deploy a simple Hapi Node server to the Azure Kubernetes Platform.

Usage

Create a new repository from this template and run ./rename.js specifying the new name of the project and the description to use e.g.

./rename.js ffc-demo-web "Web frontend for demo workstream"

The script will update the following:

• package.json: update name, description, homepage
• docker-compose.yaml: update the service name, image and container_name
• docker-compose.test.yaml: update the service name, image and container_name
• docker-compose.override.yaml: update the service name, image and container_name
• Rename helm/ffc-template-node
• helm/ffc-template-node/Chart.yaml: update description and name
• helm/ffc-template-node/values.yaml: update name, namespace, workstream, image, containerConfigMap.name
• helm/ffc-template-node/templates/_container.yaml: update the template name
• helm/ffc-template-node/templates/cluster-ip-service.yaml: update the template name and list parameter of include
• helm/ffc-template-node/templates/config-map.yaml: update the template name and list parameter of include
• helm/ffc-template-node/templates/deployment.yaml: update the template name, list parameter of deployment and container includes

Notes on automated rename

• The Helm chart deployment values in helm/ffc-template-node/values.yaml may need updating depending on the resource needs of your microservice
• The rename is a one-way operation i.e. currently it doesn't allow the name being changed from to be specified
• There is some validation on the input to try and ensure the rename is successful, however, it is unlikely to stand up to malicious entry
• Once the rename has been performed the script can be removed from the repo
• Should the rename go awry the changes can be reverted via git clean -df && git checkout -- .

Licence

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the licence

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.