Add runbook

.github/runbooks.yml

@@ -0,0 +1,38 @@
+# These settings determine the behaviour of runbook.md's Runbook Validator bot
+# https://github.com/financial-times/runbook.md
+
+# Everything below is optional
+
+runbooks:
+  # All available settings are listed below
+
+  # Disable checks for this repo
+  # defaults to `false`
+  disabled: false
+
+  ### SUPPORT FOR MULTIPLE RUNBOOKS IN A SINGLE REPOSITORY
+
+  # Fail checks if `any` | `all` | `none` runbooks fail validation
+  # defaults to `any`
+  failOn: any
+
+  ### SUPPORT FOR UPDATING BIZ-OPS
+
+  # Update valid Biz-Ops runbooks on merge to a specific branch
+  #### IF YOUR DEPLOYMENTS ARE AUTOMATED (CircleCI, Heroku Pipelines)
+  #### PLEASE INTEGRATE WITH CHANGE-API INSTEAD
+  #### https://github.com/Financial-Times/change-api#change-api---v2
+  # defaults to `false`
+  updateOnMerge: true
+
+  # Merges to this branch trigger Biz-Ops updates updateOnMerge is `true`
+  # defaults to `master`
+  updateBranch: master
+
+  ### UPDATING BIZ-OPS REQUIRES EACH RUNBOOK TO BE TIED TO A VALID SYSTEM CODE
+  # Mappings between paths and system codes
+  # unless a custom mapping is specified here
+  # runbook.md tries to parse the system code from the runbook's filename (format: my-sys-code_runbook.md)
+  systemCodes:
+    # paths are relative to root, omitting ./ (case-insensitive)
+    public-brands-api: runbooks/runbook.md

runbooks/runbook.md

@@ -0,0 +1,116 @@
+# UPP - Public Brands API
+
+Provides a public API for Brands data.
+
+## Code
+
+public-brands-api
+
+## Primary URL
+
+<https://upp-prod-delivery-glb.upp.ft.com/__public-brands-api/>
+
+## Service Tier
+
+Bronze
+
+## Lifecycle Stage
+
+Production
+
+## Delivered By
+
+content
+
+## Supported By
+
+content
+
+## Known About By
+
+- elitsa.pavlova
+- kalin.arsov
+- miroslav.gatsanoga
+- ivan.nikolov
+- marina.chompalova
+
+## Host Platform
+
+AWS
+
+## Architecture
+
+The service provides an API to get the information about a particular brand. Requests are forwarded to [Public Concepts API](https://github.com/Financial-Times/public-concepts-api) and the responses are being transformed in a format that is backwards compatible.
+
+## Contains Personal Data
+
+No
+
+## Contains Sensitive Data
+
+No
+
+## Dependencies
+
+- public-concepts-api
+
+## Failover Architecture Type
+
+ActiveActive
+
+## Failover Process Type
+
+FullyAutomated
+
+## Failback Process Type
+
+FullyAutomated
+
+## Failover Details
+
+The service is deployed in both Delivery clusters. The failover guide for the cluster is located here:
+<https://github.com/Financial-Times/upp-docs/tree/master/failover-guides/delivery-cluster>
+
+## Data Recovery Process Type
+
+NotApplicable
+
+## Data Recovery Details
+
+The service does not store data, so it does not require any data recovery steps.
+
+## Release Process Type
+
+PartiallyAutomated
+
+## Rollback Process Type
+
+Manual
+
+## Release Details
+
+Manual failover is needed when a new version of the service is deployed to production. Otherwise, an automated failover is going to take place when releasing. For more details about the failover process please see: <https://github.com/Financial-Times/upp-docs/tree/master/failover-guides/delivery-cluster>
+
+## Key Management Process Type
+
+Manual
+
+## Key Management Details
+
+To access the service clients need to provide basic auth credentials.
+To rotate credentials you need to login to a particular cluster and update varnish-auth secrets.
+
+## Monitoring
+
+Service in UPP K8S delivery clusters:
+
+- Delivery-Prod-EU health: <https://upp-prod-delivery-eu.upp.ft.com/__health/__pods-health?service-name=public-brands-api>
+- Delivery-Prod-US health: <https://upp-prod-delivery-us.upp.ft.com/__health/__pods-health?service-name=public-brands-api>
+
+## First Line Troubleshooting
+
+<https://github.com/Financial-Times/upp-docs/tree/master/guides/ops/first-line-troubleshooting>
+
+## Second Line Troubleshooting
+
+Please refer to the GitHub repository README for troubleshooting information.