msp-ops: architecture diagrams (#8919)

this handbook is still the source of truth for msp-ops pages --- This PR adds architecture diagrams generated per environment for each service https://github.com/sourcegraph/sourcegraph/pull/62213 --------- Co-authored-by: jac <[email protected]>
sourcegraph · May 1, 2024 · a9586b3 · a9586b3
1 parent ff67b67
commit a9586b3
Show file tree

Hide file tree

Showing 34 changed files with 2,404 additions and 50 deletions.
diff --git a/content/departments/engineering/managed-services/build-tracker-prod.svg b/content/departments/engineering/managed-services/build-tracker-prod.svg
diff --git a/content/departments/engineering/managed-services/build-tracker.md b/content/departments/engineering/managed-services/build-tracker.md
@@ -3,8 +3,8 @@
 <!--
 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
-Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
+Last updated: 2024-05-01 12:30:43.488421 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/d0e016b97b93281abe4e18a9933ef0195d17296c
 -->
 
 This document describes operational guidance for Build Tracker infrastructure.
@@ -83,6 +83,10 @@ sg msp logs build-tracker prod
 | -------- | --------------------------------------------------------------------------------------------------------------------------- |
 | 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.svg)
+
 #### 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.
@@ -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.
 

diff --git a/content/departments/engineering/managed-services/cloud-ops-dev.svg b/content/departments/engineering/managed-services/cloud-ops-dev.svg
diff --git a/content/departments/engineering/managed-services/cloud-ops-prod.svg b/content/departments/engineering/managed-services/cloud-ops-prod.svg
diff --git a/content/departments/engineering/managed-services/cloud-ops.md b/content/departments/engineering/managed-services/cloud-ops.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-04-24 19:21:08.772189 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
+Last updated: 2024-05-01 12:30:43.648378 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/d0e016b97b93281abe4e18a9933ef0195d17296c
 -->
 
 This document describes operational guidance for Cloud Ops Dashboard infrastructure.
@@ -74,6 +74,10 @@ sg msp logs cloud-ops prod
 | -------- | ----------------------------------------------------------------------------------------------------------------------- |
 | Console  | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=cloud-ops-prod-dd32) |
 
+#### prod Architecture Diagram
+
+![Architecture Diagram](./cloud-ops-prod.svg)
+
 #### prod Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-ops/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml), and `sg msp generate cloud-ops prod` generates the required infrastructure configuration for this environment in Terraform.
@@ -145,6 +149,10 @@ sg msp logs cloud-ops dev
 | -------- | ---------------------------------------------------------------------------------------------------------------------- |
 | Console  | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=cloud-ops-dev-caff) |
 
+#### dev Architecture Diagram
+
+![Architecture Diagram](./cloud-ops-dev.svg)
+
 #### dev Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-ops/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml), and `sg msp generate cloud-ops dev` generates the required infrastructure configuration for this environment in Terraform.
@@ -170,7 +178,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
 sg msp tfc view cloud-ops dev
 ```
 
-### Alert Policies
+## Alert Policies
 
 The following alert policies are defined for each of this service's environments.
 

diff --git a/content/departments/engineering/managed-services/cloud-relay-prod.svg b/content/departments/engineering/managed-services/cloud-relay-prod.svg
diff --git a/content/departments/engineering/managed-services/cloud-relay.md b/content/departments/engineering/managed-services/cloud-relay.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-04-24 19:21:08.774776 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
+Last updated: 2024-05-01 12:30:43.717725 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/d0e016b97b93281abe4e18a9933ef0195d17296c
 -->
 
 This document describes operational guidance for Cloud Relay infrastructure.
@@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs:
 sg msp logs cloud-relay prod
 ```
 
+#### prod Architecture Diagram
+
+![Architecture Diagram](./cloud-relay-prod.svg)
+
 #### prod Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-relay/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-relay/service.yaml), and `sg msp generate cloud-relay prod` generates the required infrastructure configuration for this environment in Terraform.
@@ -93,7 +97,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
 sg msp tfc view cloud-relay prod
 ```
 
-### Alert Policies
+## Alert Policies
 
 The following alert policies are defined for each of this service's environments.
 

diff --git a/content/departments/engineering/managed-services/cody-analytics-dev.svg b/content/departments/engineering/managed-services/cody-analytics-dev.svg
diff --git a/content/departments/engineering/managed-services/cody-analytics-prod.svg b/content/departments/engineering/managed-services/cody-analytics-prod.svg
diff --git a/content/departments/engineering/managed-services/cody-analytics.md b/content/departments/engineering/managed-services/cody-analytics.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-04-24 19:21:08.777205 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
+Last updated: 2024-05-01 12:30:43.834017 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/d0e016b97b93281abe4e18a9933ef0195d17296c
 -->
 
 This document describes operational guidance for Cody Analytics infrastructure.
@@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs:
 sg msp logs cody-analytics dev
 ```
 
+#### dev Architecture Diagram
+
+![Architecture Diagram](./cody-analytics-dev.svg)
+
 #### dev Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/cody-analytics/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml), and `sg msp generate cody-analytics dev` generates the required infrastructure configuration for this environment in Terraform.
@@ -133,6 +137,10 @@ You can also use `sg msp` to quickly open a link to your service logs:
 sg msp logs cody-analytics prod
 ```
 
+#### prod Architecture Diagram
+
+![Architecture Diagram](./cody-analytics-prod.svg)
+
 #### prod Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/cody-analytics/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml), and `sg msp generate cody-analytics prod` generates the required infrastructure configuration for this environment in Terraform.
@@ -158,7 +166,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
 sg msp tfc view cody-analytics prod
 ```
 
-### Alert Policies
+## Alert Policies
 
 The following alert policies are defined for each of this service's environments.
 

diff --git a/content/departments/engineering/managed-services/entitler-prod.svg b/content/departments/engineering/managed-services/entitler-prod.svg
diff --git a/content/departments/engineering/managed-services/entitler.md b/content/departments/engineering/managed-services/entitler.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-04-24 19:21:08.779263 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/e15ad322081b292b9f9f25ede520ae9a51568190
+Last updated: 2024-05-01 12:30:43.901434 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/d0e016b97b93281abe4e18a9933ef0195d17296c
 -->
 
 This document describes operational guidance for Entitler infrastructure.
@@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs:
 sg msp logs entitler prod
 ```
 
+#### prod Architecture Diagram
+
+![Architecture Diagram](./entitler-prod.svg)
+
 #### prod Terraform Cloud
 
 This service's configuration is defined in [`sourcegraph/managed-services/services/entitler/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/entitler/service.yaml), and `sg msp generate entitler prod` generates the required infrastructure configuration for this environment in Terraform.
@@ -93,7 +97,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
 sg msp tfc view entitler prod
 ```
 
-### Alert Policies
+## Alert Policies
 
 The following alert policies are defined for each of this service's environments.