diff --git a/docs/sysadmins/ci-cd.md b/docs/sysadmins/ci-cd.md index 99f84d8426..c6058c069a 100644 --- a/docs/sysadmins/ci-cd.md +++ b/docs/sysadmins/ci-cd.md @@ -46,3 +46,7 @@ The `TM_ORG_*` vars are required for certain tests to pass; most notably )`test_ The CI stores the frontend node_modules folder to save time on builds. Sometimes it will be necessary to force all builds to use a fresh installation, so the cache will have to be refreshed manually. In the Tasking Manager CircleCI settings there is an environment variable "CACHEVERSION". Set this value to `v{n}` where {n} is an integer increased by 1 each time you wish to clear the cache. + +## Building container images + +## Deploying containers diff --git a/docs/sysadmins/index.md b/docs/sysadmins/index.md new file mode 100644 index 0000000000..856ec94d88 --- /dev/null +++ b/docs/sysadmins/index.md @@ -0,0 +1,67 @@ +# Introduction + +# Table of Contents + +## Architecture + +- Serivce Architecture +- Component Architecture +- Infrastructure Architecture + +## Development + +- Gitops - Branching Schema +- Database Schema +- Release Management and tagging + +## Deployment + + - Manual deployment steps - + - Capacity planning + - Dependencies + - CI/CD + - Containerisation - + - Building containers + +## Security + +- Backup and restore +- Network architecture design + +## Testing + +- Functional testing +- Testing Security + +## Service Administration + +### Inventory of third-party tools used + + - Quay.io + - CircleCI + - NewRelic + - Sentry + - AWS CloudWatch + +### Customisation + +### Monitoring & Alerts + +### Logging + +### Troubleshooting + + +## Service Continuity + +Persons holding key responsibilities +SLA +Escalation matrix +Instances maintained by HOT +Communication protocol +Blameless root-cause analyses and post-mortem / pre-mortem documentation + +## Miscellaneous + +Services dependent on Tasking Manager +Services on which Tasking Manager depends diff --git a/docs/sysadmins/monitoring-logging.md b/docs/sysadmins/monitoring-logging.md index 785481a3b2..b9ac03aec5 100644 --- a/docs/sysadmins/monitoring-logging.md +++ b/docs/sysadmins/monitoring-logging.md @@ -1,3 +1,10 @@ # Monitoring & Logging -TBD \ No newline at end of file +TBD + +## Alerts + +- AWS CloudWatch Alerts +- Alerts on Slack +- OpsGenie + diff --git a/docs/sysadmins/security-reliability-processes.md b/docs/sysadmins/security-reliability-processes.md index 59d426da48..53c1289588 100644 --- a/docs/sysadmins/security-reliability-processes.md +++ b/docs/sysadmins/security-reliability-processes.md @@ -1,3 +1,8 @@ # Security & Reliability Processes -TBD \ No newline at end of file +# Public endpoints + +List of all publicly exposed endpoints + +- Primary address - https://tasks.hotosm.org +- API - None