Provides consistent navigation for FT applications. See the production service for API information.
❗️ If you need to edit the links that the Navigation Service provides, this isn't the right place – you need to edit files in the Origami Navigation Data repo
Before we can run the application, we'll need to install dependencies:
Run the application in development mode with
Now you can access the app over HTTP on port
We configure Origami Navigation Service using environment variables. In development, configurations are set in a
.env file. In production, these are set through Heroku config. Further documentation on the available options can be found in the Origami Service documentation.
NAVIGATION_DATA_STORE: The location of the JSON navigation data that powers the service. This should be a URL.
NODE_ENV: The environment to run the application in. One of
test(for use in automated tests).
PORT: The port to run the application on.
CMDB_API_KEY: The API key to use when performing CMDB operations
FASTLY_PURGE_API_KEY: A Fastly API key which is used to purge URLs (when somebody POSTs to the
GRAPHITE_API_KEY: The FT's internal Graphite API key.
PURGE_API_KEY: The API key to require when somebody POSTs to the
/purgeendpoint. This should be a non-memorable string, for example a UUID
REGION: The region the application is running in. One of
CHANGE_API_KEY: The change-log API key to use when creating and closing change-logs.
RELEASE_ENV: The Salesforce environment to include in change-logs. One of
SENTRY_DSN: The Sentry URL to send error information to.
GRAFANA_API_KEY: The API key to use when using Grafana push/pull
The service can also be configured by sending HTTP headers, these would normally be set in your CDN config:
FT-Origami-Service-Base-Path: The base path for the service, this gets prepended to all paths in the HTML and ensures that redirects work when the CDN rewrites URLs.
The source documentation for the runbook and healthcheck endpoints are stored in the
operational-documentation folder. These files are pushed to CMDB upon every promotion to production. You can push them to CMDB manually by running the following command:
The tests are split into unit tests and integration tests. To run tests on your machine you'll need to install Node.js and run
make install. Then you can run the following commands:
make test # run all the tests make test-unit # run the unit tests make test-integration # run the integration tests
You can run the unit tests with coverage reporting, which expects 90% coverage or more:
make test-unit-coverage verify-coverage
The code will also need to pass linting on CI, you can run the linter locally with:
We run the tests and linter on CI, you can view results on CircleCI.
make test and
make lint must pass before we merge a pull request.
The production (EU/US) and QA applications run on Heroku. We deploy continuously to QA via CircleCI, you should never need to deploy to QA manually. We use a Heroku pipeline to promote QA deployments to production.
You can promote either through the Heroku interface, or by running the following command locally:
We've outlined some common issues that can occur in the running of the Navigation Service:
For now, restart the Heroku dynos:
heroku restart --app origami-navigation-service-eu heroku restart --app origami-navigation-service-us
If this doesn't help, then a temporary measure could be to add more dynos to the production applications, or switch the existing ones to higher performance dynos.
If you really need to deploy manually, you should only do so to QA. Production deploys should always be a promotion from QA.
You'll need to provide an API key for change request logging. You can get this from Vault in
teams/origami/navigation-service. Now deploy to QA using the following:
The Financial Times has published this software under the MIT license.