Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial draft improvemnt to documentation #5548

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/sysadmins/ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
67 changes: 67 additions & 0 deletions docs/sysadmins/index.md
Original file line number Diff line number Diff line change
@@ -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
9 changes: 8 additions & 1 deletion docs/sysadmins/monitoring-logging.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Monitoring & Logging

TBD
TBD

## Alerts

- AWS CloudWatch Alerts
- Alerts on Slack
- OpsGenie

7 changes: 6 additions & 1 deletion docs/sysadmins/security-reliability-processes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Security & Reliability Processes

TBD
# Public endpoints

List of all publicly exposed endpoints

- Primary address - https://tasks.hotosm.org
- API - None