msp: update generated docs (#8455)

- Add Sentry projects to envs - Add releaseregistry page --------- Co-authored-by: jac <[email protected]>
sourcegraph · Jan 18, 2024 · 1042a6f · 1042a6f
1 parent eedc08d
commit 1042a6f
Show file tree

Hide file tree

Showing 10 changed files with 308 additions and 19 deletions.
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-01-11 23:32:32.139894 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.639211 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 This document describes operational guidance for Cloud Ops Dashboard infrastructure.
@@ -33,6 +33,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Category       | **internal**                                                                                       |
 | Resources      | [prod Redis](#prod-redis)                                                                          |
 | Alerts         | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=cloud-ops-prod-dd32) |
+| Sentry         | [`cloud-ops-prod`](https://sourcegraph.sentry.io/projects/cloud-ops-prod/)                         |
 | Domain         | [cloud-ops.sgdev.org](https://cloud-ops.sgdev.org)                                                 |
 | Cloudflare WAF | ✅                                                                                                 |
 

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-01-11 23:32:32.141619 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.640608 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 This document describes operational guidance for Cody Analytics infrastructure.
@@ -33,6 +33,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Category       | **test**                                                                                               |
 | Resources      |                                                                                                        |
 | Alerts         | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=cody-analytics-dev-bd34) |
+| Sentry         | [`cody-analytics-dev`](https://sourcegraph.sentry.io/projects/cody-analytics-dev/)                     |
 | Domain         | [cody-analytics.sgdev.org](https://cody-analytics.sgdev.org)                                           |
 | Cloudflare WAF | ✅                                                                                                     |
 

diff --git a/content/departments/engineering/managed-services/gatekeeper.md b/content/departments/engineering/managed-services/gatekeeper.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-01-11 23:32:32.143069 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.641714 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 This document describes operational guidance for Cody Gatekeeper infrastructure.
@@ -33,6 +33,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Category   | **internal**                                                                                        |
 | Resources  |                                                                                                     |
 | Alerts     | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=gatekeeper-prod-1c93) |
+| Sentry     | [`gatekeeper-prod`](https://sourcegraph.sentry.io/projects/gatekeeper-prod/)                        |
 
 MSP infrastructure access needs to be requested using Entitle for time-bound privileges.
 

diff --git a/content/departments/engineering/managed-services/index.md b/content/departments/engineering/managed-services/index.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-01-11 23:32:32.157895 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.652986 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 These pages contain generated operational guidance for the infrastructure of [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md) services.
@@ -51,6 +51,12 @@ Managed Services Platform services owned by `core-services`:
 - [Sourcegraph Accounts](./sams.md)
 - [Telemetry Gateway](./telemetry-gateway.md)
 
+## dev-experience
+
+Managed Services Platform services owned by `dev-experience`:
+
+- [Release Registry](./releaseregistry.md)
+
 ## General guidance
 
 ### Infrastructure access

diff --git a/content/departments/engineering/managed-services/msp-testbed.md b/content/departments/engineering/managed-services/msp-testbed.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-01-11 23:32:32.144784 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.642845 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 This document describes operational guidance for MSP Testbed infrastructure.
@@ -19,7 +19,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Service ID   | [`msp-testbed`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml)                     |
 | Owners       | **core-services**                                                                                                                |
 | Service kind | Cloud Run service                                                                                                                |
-| Environments | [test](#test)                                                                                                                    |
+| Environments | [test](#test), [robert](#robert)                                                                                                 |
 | Docker image | `us.gcr.io/sourcegraph-dev/msp-example`                                                                                          |
 | Source code  | [`github.com/sourcegraph/sourcegraph` - `cmd/msp-example`](https://github.com/sourcegraph/sourcegraph/tree/HEAD/cmd/msp-example) |
 
@@ -33,6 +33,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Category   | **test**                                                                                                                          |
 | Resources  | [test Redis](#test-redis), [test PostgreSQL instance](#test-postgresql-instance), [test BigQuery dataset](#test-bigquery-dataset) |
 | Alerts     | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=msp-testbed-test-77589aae45d0)                      |
+| Sentry     | [`msp-testbed-test`](https://sourcegraph.sentry.io/projects/msp-testbed-test/)                                                    |
 | Domain     | [msp-testbed.sgdev.org](https://msp-testbed.sgdev.org)                                                                            |
 
 MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements.
@@ -114,3 +115,95 @@ The Terraform Cloud workspaces for this service environment are [grouped under t
 ```bash
 sg msp tfc view msp-testbed test
 ```
+
+### robert
+
+| PROPERTY       | DETAILS                                                                                                                                       |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| Project ID     | [`msp-testbed-robert-7be9`](https://console.cloud.google.com/run?project=msp-testbed-robert-7be9)                                             |
+| Category       | **test**                                                                                                                                      |
+| Resources      | [robert Redis](#robert-redis), [robert PostgreSQL instance](#robert-postgresql-instance), [robert BigQuery dataset](#robert-bigquery-dataset) |
+| Alerts         | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=msp-testbed-robert-7be9)                                        |
+| Sentry         | [`msp-testbed-robert`](https://sourcegraph.sentry.io/projects/msp-testbed-robert/)                                                            |
+| Domain         | [msp-testbed-robert.sgdev.org](https://msp-testbed-robert.sgdev.org)                                                                          |
+| Cloudflare WAF | ✅                                                                                                                                            |
+
+MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements.
+
+| ACCESS                   | ENTITLE REQUEST TEMPLATE                                                                                                                                                                                                                                                                                                                                  |
+| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| GCP project read access  | [Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) |
+| GCP project write access | [Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) |
+
+For Terraform Cloud access, see [robert Terraform Cloud](#robert-terraform-cloud).
+
+#### robert Cloud Run
+
+The MSP Testbed robert service implementation is deployed on [Google Cloud Run](https://cloud.google.com/run).
+
+| PROPERTY     | DETAILS                                                                                                                                                                                                                                                                                                                              |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Console      | [Cloud Run service](https://console.cloud.google.com/run?project=msp-testbed-robert-7be9)                                                                                                                                                                                                                                            |
+| 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=msp-testbed-robert-7be9) |
+
+You can also use `sg msp` to quickly open a link to your service logs:
+
+```bash
+sg msp logs msp-testbed robert
+```
+
+#### robert Redis
+
+| PROPERTY | DETAILS                                                                                                                     |
+| -------- | --------------------------------------------------------------------------------------------------------------------------- |
+| Console  | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=msp-testbed-robert-7be9) |
+
+#### robert PostgreSQL instance
+
+| PROPERTY  | DETAILS                                                                                               |
+| --------- | ----------------------------------------------------------------------------------------------------- |
+| Console   | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=msp-testbed-robert-7be9) |
+| Databases | `primary`                                                                                             |
+
+To connect to the PostgreSQL instance in this environment, use `sg msp` in the [`sourcegraph/managed-services`](https://github.com/sourcegraph/managed-services) repository:
+
+```bash
+# For read-only access
+sg msp pg connect msp-testbed robert
+
+# For write access - use with caution!
+sg msp pg connect -write-access msp-testbed robert
+```
+
+#### robert BigQuery dataset
+
+| PROPERTY        | DETAILS                                                                                                                |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| Dataset Project | `msp-testbed-robert-7be9`                                                                                              |
+| Dataset ID      | `msp_testbed`                                                                                                          |
+| Tables          | [`example`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/example.bigquerytable.json) |
+
+#### robert Terraform Cloud
+
+This service's configuration is defined in [`sourcegraph/managed-services/services/msp-testbed/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml), and `sg msp generate msp-testbed robert` generates the required infrastructure configuration for this environment in Terraform.
+Terraform Cloud (TFC) workspaces specific to each service then provisions the required infrastructure from this configuration.
+You may want to check your service environment's TFC workspaces if a Terraform apply fails (reported via GitHub commit status checks in the [`sourcegraph/managed-services`](https://github.com/sourcegraph/managed-services) repository, or in #alerts-msp-tfc).
+
+> [!NOTE]
+> If you are looking for service logs, see the [robert Cloud Run](#robert-cloud-run) section instead. In general:
+>
+> - check service logs ([robert Cloud Run](#robert-cloud-run)) if your service has gone down or is misbehaving
+> - check TFC workspaces for infrastructure provisioning or configuration issues
+
+To access this environment's Terraform Cloud workspaces, you will need to [log in to Terraform Cloud](https://app.terraform.io/app/sourcegraph) and then [request Entitle access to membership in the "Managed Services Platform Operator" TFC team](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjM2MDAiLCJqdXN0aWZpY2F0aW9uIjoiSlVTVElGSUNBVElPTiBIRVJFIiwicm9sZUlkcyI6W3siaWQiOiJiMzg3MzJjYy04OTUyLTQ2Y2QtYmIxZS1lZjI2ODUwNzIyNmIiLCJ0aHJvdWdoIjoiYjM4NzMyY2MtODk1Mi00NmNkLWJiMWUtZWYyNjg1MDcyMjZiIiwidHlwZSI6InJvbGUifV19).
+The "Managed Services Platform Operator" team has access to all MSP TFC workspaces.
+
+> [!WARNING]
+> You **must [log in to Terraform Cloud](https://app.terraform.io/app/sourcegraph) before making your Entitle request**.
+> If you make your Entitle request, then log in, you will be removed from any team memberships granted through Entitle by Terraform Cloud's SSO implementation.
+
+The Terraform Cloud workspaces for this service environment are [grouped under the `msp-msp-testbed-robert` tag](https://app.terraform.io/app/sourcegraph/workspaces?tag=msp-msp-testbed-robert), or you can use:
+
+```bash
+sg msp tfc view msp-testbed robert
+```
diff --git a/content/departments/engineering/managed-services/pings.md b/content/departments/engineering/managed-services/pings.md
@@ -3,8 +3,8 @@
 <!--
 Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
 
-Last updated: 2024-01-11 23:32:32.146527 +0000 UTC
-Generated from: https://github.com/sourcegraph/managed-services/tree/f8d4d7205ba81e75f01920f1034cb2f52e039ace
+Last updated: 2024-01-18 17:51:09.645325 +0000 UTC
+Generated from: https://github.com/sourcegraph/managed-services/tree/cebd22d6f89166213a4ca810202620ee7825d86c
 -->
 
 This document describes operational guidance for Pings Service infrastructure.
@@ -33,6 +33,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
 | Category   | **external**                                                                                           |
 | Resources  |                                                                                                        |
 | Alerts     | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=pings-prod-2f4f73edf1db) |
+| Sentry     | [`pings-prod`](https://sourcegraph.sentry.io/projects/pings-prod/)                                     |
 | Domain     | [pings.sourcegraph.com](https://pings.sourcegraph.com)                                                 |
 
 MSP infrastructure access needs to be requested using Entitle for time-bound privileges.