Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
msp-ops: architecture diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
@jac
jac committed Apr 26, 2024
1 parent 114fb0a commit 0f82ecb
Show file tree
Hide file tree
Showing 34 changed files with 2,439 additions and 252 deletions.
101 changes: 101 additions & 0 deletions content/departments/engineering/managed-services/build-tracker-prod.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 19 additions & 15 deletions content/departments/engineering/managed-services/build-tracker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Last updated: 2024-04-24 19:21:08.769199 +0000 UTC
Last updated: 2024-04-26 15:56:09.272465 +0000 UTC
Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
-->

Expand All @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]

## Service overview

| PROPERTY | DETAILS |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| PROPERTY | DETAILS |
|--------------|--------------------------------------------------------------------------------------------------------------------------------------|
| Service ID | `build-tracker` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/build-tracker/service.yaml)) |
| Owners | **dev-experience** |
| Service kind | Cloud Run service |
Expand All @@ -28,8 +28,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]

## Rollouts

| PROPERTY | DETAILS |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| PROPERTY | DETAILS |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Delivery pipeline | [`build-tracker-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/build-tracker-us-central1-rollout?project=build-tracker-prod-59bf) |
| Stages | [prod](#prod) |

Expand All @@ -39,8 +39,8 @@ Changes to Build Tracker are continuously delivered to the first stage ([prod](#

### prod

| PROPERTY | DETAILS |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| PROPERTY | DETAILS |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Project ID | [`build-tracker-prod-59bf`](https://console.cloud.google.com/run?project=build-tracker-prod-59bf) |
| Category | **test** |
| Deployment type | `rollout` |
Expand All @@ -53,8 +53,8 @@ Changes to Build Tracker are continuously delivered to the first stage ([prod](#

MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements.

| ACCESS | ENTITLE REQUEST TEMPLATE |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ACCESS | ENTITLE REQUEST TEMPLATE |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| GCP project read access | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) |
| GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) |

Expand All @@ -64,8 +64,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud).

The Build Tracker prod service implementation is deployed on [Google Cloud Run](https://cloud.google.com/run).

| PROPERTY | DETAILS |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| PROPERTY | DETAILS |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Console | [Cloud Run service](https://console.cloud.google.com/run?project=build-tracker-prod-59bf) |
| Service logs | [GCP logging](https://console.cloud.google.com/logs/query;query=resource.type%20%3D%20%22cloud_run_revision%22%20-logName%3D~%22logs%2Frun.googleapis.com%252Frequests%22;summaryFields=jsonPayload%252FInstrumentationScope,jsonPayload%252FBody,jsonPayload%252FAttributes%252Ferror:false:32:end?project=build-tracker-prod-59bf) |
| Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=build-tracker-prod-59bf) |
Expand All @@ -79,10 +79,14 @@ sg msp logs build-tracker prod

#### prod Redis

| PROPERTY | DETAILS |
| -------- | --------------------------------------------------------------------------------------------------------------------------- |
| PROPERTY | DETAILS |
|----------|-----------------------------------------------------------------------------------------------------------------------------|
| Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=build-tracker-prod-59bf) |

#### prod Architecture Diagram

![Architecture Diagram](./build-tracker-prod)

Check failure on line 88 in content/departments/engineering/managed-services/build-tracker.md

View workflow job for this annotation

GitHub Actions / link-check 

Link destination not found: ./build-tracker-prod. The full resolved path would be departments/engineering/managed-services/build-tracker-prod, which doesn't exist. For help on how linking in the handbook works, see https://handbook.sourcegraph.com/editing/linking-within-handbook

#### prod Terraform Cloud

This service's configuration is defined in [`sourcegraph/managed-services/services/build-tracker/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/build-tracker/service.yaml), and `sg msp generate build-tracker prod` generates the required infrastructure configuration for this environment in Terraform.
Expand All @@ -108,7 +112,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
sg msp tfc view build-tracker prod
```

### Alert Policies
## Alert Policies

The following alert policies are defined for each of this service's environments.

Expand Down Expand Up @@ -163,7 +167,7 @@ Severity: WARNING
#### Cloud Run Pending Requests

```md
There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further.
There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further.
```

Severity: WARNING
Expand Down
Loading

0 comments on commit 0f82ecb

Please sign in to comment.