This repository has been archived by the owner on May 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add runbook and update codeowners (#52)
* Add runbook and update codeowners * Update runbook.md * Update runbook.md * Update runbooks/runbook.md Co-authored-by: Elina Kaneva <45562864+ekaneva@users.noreply.github.com> * Update runbooks/runbook.md Co-authored-by: Elina Kaneva <45562864+ekaneva@users.noreply.github.com> * Update runbook.md * Update runbooks/runbook.md Co-authored-by: Elina Kaneva <45562864+ekaneva@users.noreply.github.com> Co-authored-by: Elina Kaneva <45562864+ekaneva@users.noreply.github.com>
- Loading branch information
Showing
3 changed files
with
151 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
# This repo is owned by the universal-publishing team, which is administered by the FT Content Programme Team. | ||
* @Financial-Times/universal-publishing | ||
|
||
# This repo is supported by: | ||
* @Financial-Times/content-team |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# 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) | ||
publish-carousel: runbooks/runbook.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# UPP Publish Carousel | ||
|
||
A microservice that continuously republishes content and annotations available in the native store. | ||
|
||
## Code | ||
|
||
publish-carousel | ||
|
||
## Primary URL | ||
|
||
<https://upp-prod-publish.ft.com/__publish-carousel/> | ||
|
||
## Service Tier | ||
|
||
Bronze | ||
|
||
## Lifecycle Stage | ||
|
||
Production | ||
|
||
## Delivered By | ||
|
||
content | ||
|
||
## Supported By | ||
|
||
content | ||
|
||
## Known About By | ||
|
||
- hristo.georgiev | ||
- elina.kaneva | ||
- robert.marinov | ||
- tsvetan.dimitrov | ||
|
||
## Host Platform | ||
|
||
AWS | ||
|
||
## Architecture | ||
|
||
A microservice that continuously republishes content and annotations from the | ||
native store. Checkout the project repository README for more details: | ||
<https://github.com/Financial-Times/publish-carousel> | ||
|
||
## Contains Personal Data | ||
|
||
No | ||
|
||
## Contains Sensitive Data | ||
|
||
No | ||
|
||
## Failover Architecture Type | ||
|
||
ActivePassive | ||
|
||
## Failover Process Type | ||
|
||
FullyAutomated | ||
|
||
## Failback Process Type | ||
|
||
FullyAutomated | ||
|
||
## Failover Details | ||
|
||
The service is deployed in both Publishing clusters. The failover guide for the cluster is located here: <https://github.com/Financial-Times/upp-docs/tree/master/failover-guides/publishing-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 | ||
|
||
The release is triggered by making a Github release which is then picked up by a Jenkins multibranch pipeline. The Jenkins pipeline should be manually started in order for it to deploy the helm package to the Kubernetes clusters. | ||
|
||
## Key Management Process Type | ||
|
||
NotApplicable | ||
|
||
## Key Management Details | ||
|
||
There is no key rotation procedure for this system. | ||
|
||
## Monitoring | ||
|
||
- <https://upp-prod-publish-eu.upp.ft.com/__health/__pods-health?service-name=publish-carousel> | ||
- <https://upp-prod-publish-us.upp.ft.com/__health/__pods-health?service-name=publish-carousel> | ||
|
||
## 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. |