From 495cc6490b66b549a1af96edb2d656ba0301498d Mon Sep 17 00:00:00 2001 From: Robert Lin Date: Mon, 25 Mar 2024 17:14:26 +0900 Subject: [PATCH] msp: update generated docs --- .../engineering/managed-services/cloud-ops.md | 28 +++--- .../managed-services/cody-analytics.md | 38 ++++---- .../engineering/managed-services/entitler.md | 24 ++--- .../managed-services/gatekeeper.md | 24 ++--- .../engineering/managed-services/index.md | 11 ++- .../managed-services/msp-testbed.md | 68 +++++++------- .../engineering/managed-services/pings.md | 24 ++--- .../managed-services/releaseregistry.md | 52 ++++++----- .../engineering/managed-services/sams.md | 74 ++++++++------- .../managed-services/sourcegraph-accounts.md | 92 ++++++++++--------- .../managed-services/support-integration.md | 24 ++--- .../managed-services/telemetry-gateway.md | 38 ++++---- 12 files changed, 265 insertions(+), 232 deletions(-) diff --git a/content/departments/engineering/managed-services/cloud-ops.md b/content/departments/engineering/managed-services/cloud-ops.md index aee7bdbfdf91..ad82b67b2101 100644 --- a/content/departments/engineering/managed-services/cloud-ops.md +++ b/content/departments/engineering/managed-services/cloud-ops.md @@ -3,22 +3,22 @@ This document describes operational guidance for Cloud Ops Dashboard infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------| | Service ID | [`cloud-ops`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml) | | Owners | **cloud** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| -------------- | -------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|----------------------------------------------------------------------------------------------------| | Project ID | [`cloud-ops-prod-dd32`](https://console.cloud.google.com/run?project=cloud-ops-prod-dd32) | | Category | **internal** | | Resources | [prod Redis](#prod-redis) | @@ -42,8 +42,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Cloud Ops Dashboard 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=cloud-ops-prod-dd32) | | 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=cloud-ops-prod-dd32) | @@ -66,8 +66,8 @@ sg msp logs cloud-ops prod #### prod Redis -| PROPERTY | DETAILS | -| -------- | ----------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=cloud-ops-prod-dd32) | #### prod Terraform Cloud @@ -78,7 +78,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/cody-analytics.md b/content/departments/engineering/managed-services/cody-analytics.md index 1865373acfe7..b5f44adca5d0 100644 --- a/content/departments/engineering/managed-services/cody-analytics.md +++ b/content/departments/engineering/managed-services/cody-analytics.md @@ -3,22 +3,22 @@ This document describes operational guidance for Cody Analytics infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | ------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|--------------|--------------------------------------------------------------------------------------------------------------------| | Service ID | [`cody-analytics`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml) | | Owners | **cody-strat** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### dev -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|----------------|--------------------------------------------------------------------------------------------------------| | Project ID | [`cody-analytics-dev-bd34`](https://console.cloud.google.com/run?project=cody-analytics-dev-bd34) | | Category | **test** | | Resources | | @@ -42,8 +42,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] 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 | [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) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Cody Analytics dev 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=cody-analytics-dev-bd34) | | 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=cody-analytics-dev-bd34) | @@ -72,7 +72,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [dev Cloud Run](#dev-cloud-run) section instead. In general: -> +> > - check service logs ([dev Cloud Run](#dev-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -91,8 +91,8 @@ sg msp tfc view cody-analytics dev ### prod -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|---------------------------------------------------------------------------------------------------------| | Project ID | [`cody-analytics-prod-da5a`](https://console.cloud.google.com/run?project=cody-analytics-prod-da5a) | | Category | **external** | | Resources | | @@ -103,8 +103,8 @@ sg msp tfc view cody-analytics dev MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -114,8 +114,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Cody Analytics 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=cody-analytics-prod-da5a) | | 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=cody-analytics-prod-da5a) | @@ -133,7 +133,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/entitler.md b/content/departments/engineering/managed-services/entitler.md index 2316f194cb5f..c382395cead5 100644 --- a/content/departments/engineering/managed-services/entitler.md +++ b/content/departments/engineering/managed-services/entitler.md @@ -3,22 +3,22 @@ This document describes operational guidance for Entitler infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | --------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|-----------------------------------------------------------------------------------------------------------------------------------------| | Service ID | [`entitler`](https://github.com/sourcegraph/managed-services/blob/main/services/entitler/service.yaml) | | Owners | **security** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|---------------------------------------------------------------------------------------------------| | Project ID | [`entitler-prod-0516`](https://console.cloud.google.com/run?project=entitler-prod-0516) | | Category | **internal** | | Resources | | @@ -42,8 +42,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Entitler 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=entitler-prod-0516) | | 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=entitler-prod-0516) | @@ -72,7 +72,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/gatekeeper.md b/content/departments/engineering/managed-services/gatekeeper.md index 16e8ecf87e2f..40630bb609bb 100644 --- a/content/departments/engineering/managed-services/gatekeeper.md +++ b/content/departments/engineering/managed-services/gatekeeper.md @@ -3,22 +3,22 @@ This document describes operational guidance for Cody Gatekeeper infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------| | Service ID | [`gatekeeper`](https://github.com/sourcegraph/managed-services/blob/main/services/gatekeeper/service.yaml) | | Owners | **cody-services** | | Service kind | Cloud Run job | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| ---------- | --------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|------------|-----------------------------------------------------------------------------------------------------| | Project ID | [`gatekeeper-prod-1c93`](https://console.cloud.google.com/run/jobs?project=gatekeeper-prod-1c93) | | Category | **internal** | | Resources | | @@ -40,8 +40,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -51,8 +51,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Cody Gatekeeper prod service implementation is deployed on [Google Cloud Run](https://cloud.google.com/run). -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Console | [Cloud Run job](https://console.cloud.google.com/run/jobs?project=gatekeeper-prod-1c93) | | Service logs | [GCP logging](https://console.cloud.google.com/logs/query;query=resource.type%20%3D%20%22cloud_run_job%22;summaryFields=labels%252F%2522run.googleapis.com%252Fexecution_name%2522,jsonPayload%252FInstrumentationScope,jsonPayload%252FBody,jsonPayload%252FAttributes%252Ferror:false:32:end?project=gatekeeper-prod-1c93) | @@ -70,7 +70,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/index.md b/content/departments/engineering/managed-services/index.md index 336bd2cce6c8..e15e0be528e3 100644 --- a/content/departments/engineering/managed-services/index.md +++ b/content/departments/engineering/managed-services/index.md @@ -3,8 +3,8 @@ These pages contain generated operational guidance for the infrastructure of [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md) services. @@ -30,6 +30,12 @@ Managed Services Platform services owned by `cloud`: - [Cloud Ops Dashboard](./cloud-ops.md) +## cody-plg + +Managed Services Platform services owned by `cody-plg`: + +- [Self-Serve Cody](./sams.md) + ## cody-services Managed Services Platform services owned by `cody-services`: @@ -48,7 +54,6 @@ Managed Services Platform services owned by `core-services`: - [MSP Testbed](./msp-testbed.md) - [Pings Service](./pings.md) -- [Self-Serve Cody](./sams.md) - [Sourcegraph Accounts](./sourcegraph-accounts.md) - [Telemetry Gateway](./telemetry-gateway.md) diff --git a/content/departments/engineering/managed-services/msp-testbed.md b/content/departments/engineering/managed-services/msp-testbed.md index 574f7bfd38a8..ba3d2dcd0bb1 100644 --- a/content/departments/engineering/managed-services/msp-testbed.md +++ b/content/departments/engineering/managed-services/msp-testbed.md @@ -3,22 +3,22 @@ This document describes operational guidance for MSP Testbed infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------------| | 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 | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### test -| PROPERTY | DETAILS | -| ---------- | --------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|------------|-----------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`msp-testbed-test-77589aae45d0`](https://console.cloud.google.com/run?project=msp-testbed-test-77589aae45d0) | | Category | **test** | | Resources | [test Redis](#test-redis), [test PostgreSQL instance](#test-postgresql-instance), [test BigQuery dataset](#test-bigquery-dataset) | @@ -41,8 +41,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] 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 | [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) | @@ -52,8 +52,8 @@ For Terraform Cloud access, see [test Terraform Cloud](#test-terraform-cloud). The MSP Testbed test 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=msp-testbed-test-77589aae45d0) | | 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-test-77589aae45d0) | @@ -65,17 +65,20 @@ sg msp logs msp-testbed test #### test Redis -| PROPERTY | DETAILS | -| -------- | --------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-----------------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=msp-testbed-test-77589aae45d0) | #### test PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ----------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|-------------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=msp-testbed-test-77589aae45d0) | | Databases | `primary` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -88,8 +91,8 @@ sg msp pg connect -write-access msp-testbed test #### test BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | ---------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------------|------------------------------------------------------------------------------------------------------------------------| | Dataset Project | `msp-testbed-test-77589aae45d0` | | Dataset ID | `msp_testbed` | | Tables | [`example`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/example.bigquerytable.json) | @@ -102,7 +105,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [test Cloud Run](#test-cloud-run) section instead. In general: -> +> > - check service logs ([test Cloud Run](#test-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -121,8 +124,8 @@ sg msp tfc view msp-testbed test ### robert -| PROPERTY | DETAILS | -| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| 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) | @@ -133,8 +136,8 @@ sg msp tfc view msp-testbed test 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 | [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) | @@ -144,8 +147,8 @@ For Terraform Cloud access, see [robert Terraform Cloud](#robert-terraform-cloud The MSP Testbed robert 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=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) | @@ -157,17 +160,20 @@ sg msp logs msp-testbed robert #### robert Redis -| PROPERTY | DETAILS | -| -------- | --------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-----------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=msp-testbed-robert-7be9) | #### robert PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ----------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|-------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=msp-testbed-robert-7be9) | | Databases | `primary` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -180,8 +186,8 @@ sg msp pg connect -write-access msp-testbed robert #### robert BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | ---------------------------------------------------------------------------------------------------------------------- | +| 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) | @@ -194,7 +200,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!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 diff --git a/content/departments/engineering/managed-services/pings.md b/content/departments/engineering/managed-services/pings.md index 719289a7e521..5bbf6daa29fe 100644 --- a/content/departments/engineering/managed-services/pings.md +++ b/content/departments/engineering/managed-services/pings.md @@ -3,22 +3,22 @@ This document describes operational guidance for Pings Service infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------| | Service ID | [`pings`](https://github.com/sourcegraph/managed-services/blob/main/services/pings/service.yaml) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| ---------- | ------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|------------|--------------------------------------------------------------------------------------------------------| | Project ID | [`pings-prod-2f4f73edf1db`](https://console.cloud.google.com/run?project=pings-prod-2f4f73edf1db) | | Category | **external** | | Resources | | @@ -41,8 +41,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -52,8 +52,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Pings Service 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=pings-prod-2f4f73edf1db) | | 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=pings-prod-2f4f73edf1db) | @@ -71,7 +71,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/releaseregistry.md b/content/departments/engineering/managed-services/releaseregistry.md index 8e576f71c4b1..c1ecc914ac29 100644 --- a/content/departments/engineering/managed-services/releaseregistry.md +++ b/content/departments/engineering/managed-services/releaseregistry.md @@ -3,22 +3,22 @@ This document describes operational guidance for Release Registry infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------| | Service ID | [`releaseregistry`](https://github.com/sourcegraph/managed-services/blob/main/services/releaseregistry/service.yaml) | | Owners | **dev-experience** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| -------------- | -------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|----------------------------------------------------------------------------------------------------------| | Project ID | [`releaseregistry-prod-5421`](https://console.cloud.google.com/run?project=releaseregistry-prod-5421) | | Category | **test** | | Resources | [prod PostgreSQL instance](#prod-postgresql-instance) | @@ -42,8 +42,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] 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 | [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) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Release Registry 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=releaseregistry-prod-5421) | | 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=releaseregistry-prod-5421) | @@ -66,11 +66,14 @@ sg msp logs releaseregistry prod #### prod PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|---------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=releaseregistry-prod-5421) | | Databases | `releaseregistry` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -89,7 +92,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -108,8 +111,8 @@ sg msp tfc view releaseregistry prod ### dev -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|---------------------------------------------------------------------------------------------------------| | Project ID | [`releaseregistry-dev-6bac`](https://console.cloud.google.com/run?project=releaseregistry-dev-6bac) | | Category | **test** | | Resources | [dev PostgreSQL instance](#dev-postgresql-instance) | @@ -120,8 +123,8 @@ sg msp tfc view releaseregistry 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 | [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) | @@ -131,8 +134,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Release Registry dev 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=releaseregistry-dev-6bac) | | 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=releaseregistry-dev-6bac) | @@ -144,11 +147,14 @@ sg msp logs releaseregistry dev #### dev PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|-----------|--------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=releaseregistry-dev-6bac) | | Databases | `releaseregistry` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -167,7 +173,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [dev Cloud Run](#dev-cloud-run) section instead. In general: -> +> > - check service logs ([dev Cloud Run](#dev-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/sams.md b/content/departments/engineering/managed-services/sams.md index 96cca1be707a..44b61452b45f 100644 --- a/content/departments/engineering/managed-services/sams.md +++ b/content/departments/engineering/managed-services/sams.md @@ -3,24 +3,24 @@ This document describes operational guidance for Self-Serve Cody infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | [`sams`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/service.yaml) | -| Owners | **core-services** | +| Owners | **cody-plg** | | Service kind | Cloud Run service | | Environments | [dev](#dev), [prod](#prod) | | Docker image | `us-central1-docker.pkg.dev/sourcegraph-dev/sams/accounts-server` | @@ -30,20 +30,20 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### dev -| PROPERTY | DETAILS | -| -------------- | --------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|-----------------------------------------------------------------------------------------------------------------------------| | Project ID | [`sams-dev-bfec`](https://console.cloud.google.com/run?project=sams-dev-bfec) | | Category | **test** | | Resources | [dev Redis](#dev-redis), [dev PostgreSQL instance](#dev-postgresql-instance), [dev BigQuery dataset](#dev-bigquery-dataset) | | Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sams-dev-bfec) | | Sentry | [`sams-dev`](https://sourcegraph.sentry.io/projects/sams-dev/) | -| Domain | [accounts.sgdev.org](https://accounts.sgdev.org) | +| Domain | [cody.sgdev.org](https://cody.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 | -| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 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) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Self-Serve Cody dev 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=sams-dev-bfec) | | 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=sams-dev-bfec) | @@ -66,17 +66,20 @@ sg msp logs sams dev #### dev Redis -| PROPERTY | DETAILS | -| -------- | ----------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=sams-dev-bfec) | #### dev PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|---------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=sams-dev-bfec) | | Databases | `accounts`, `cody_management` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -89,8 +92,8 @@ sg msp pg connect -write-access sams dev #### dev BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Dataset Project | `sams-dev-bfec` | | Dataset ID | `sams` | | Tables | [`user_emails`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/user_emails.bigquerytable.json), [`events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/events.bigquerytable.json), [`cody_events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/cody_events.bigquerytable.json), [`subscription_events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/subscription_events.bigquerytable.json) | @@ -103,7 +106,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [dev Cloud Run](#dev-cloud-run) section instead. In general: -> +> > - check service logs ([dev Cloud Run](#dev-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -122,20 +125,20 @@ sg msp tfc view sams dev ### prod -| PROPERTY | DETAILS | -| -------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`sams-prod-ywuz`](https://console.cloud.google.com/run?project=sams-prod-ywuz) | | Category | **external** | | Resources | [prod Redis](#prod-redis), [prod PostgreSQL instance](#prod-postgresql-instance), [prod BigQuery dataset](#prod-bigquery-dataset) | | Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sams-prod-ywuz) | | Sentry | [`sams-prod`](https://sourcegraph.sentry.io/projects/sams-prod/) | -| Domain | [accounts.sourcegraph.com](https://accounts.sourcegraph.com) | +| Domain | [cody.sourcegraph.com](https://cody.sourcegraph.com) | | Cloudflare WAF | ✅ | MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -145,8 +148,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Self-Serve Cody 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=sams-prod-ywuz) | | 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=sams-prod-ywuz) | @@ -158,17 +161,20 @@ sg msp logs sams prod #### prod Redis -| PROPERTY | DETAILS | -| -------- | ------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|----------|--------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=sams-prod-ywuz) | #### prod PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | -------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|----------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=sams-prod-ywuz) | | Databases | `accounts`, `cody_management` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -181,8 +187,8 @@ sg msp pg connect -write-access sams prod #### prod BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Dataset Project | `sams-prod-ywuz` | | Dataset ID | `sams` | | Tables | [`user_emails`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/user_emails.bigquerytable.json), [`events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/events.bigquerytable.json), [`cody_events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/cody_events.bigquerytable.json), [`subscription_events`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/subscription_events.bigquerytable.json) | @@ -195,7 +201,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/sourcegraph-accounts.md b/content/departments/engineering/managed-services/sourcegraph-accounts.md index 952df5375b08..433643d09a3a 100644 --- a/content/departments/engineering/managed-services/sourcegraph-accounts.md +++ b/content/departments/engineering/managed-services/sourcegraph-accounts.md @@ -3,22 +3,22 @@ This document describes operational guidance for Sourcegraph Accounts infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | [`sourcegraph-accounts`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/service.yaml) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -30,18 +30,20 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### dev -| PROPERTY | DETAILS | -| ---------- | --------------------------------------------------------------------------------------------------------------------------- | -| Project ID | [`sourcegraph-accounts-dev-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-dev-csvc) | -| Category | **test** | -| Resources | [dev Redis](#dev-redis), [dev PostgreSQL instance](#dev-postgresql-instance), [dev BigQuery dataset](#dev-bigquery-dataset) | -| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sourcegraph-accounts-dev-csvc) | -| Sentry | [`sourcegraph-accounts-dev`](https://sourcegraph.sentry.io/projects/sourcegraph-accounts-dev/) | +| PROPERTY | DETAILS | +|----------------|-----------------------------------------------------------------------------------------------------------------------------| +| Project ID | [`sourcegraph-accounts-dev-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-dev-csvc) | +| Category | **test** | +| Resources | [dev Redis](#dev-redis), [dev PostgreSQL instance](#dev-postgresql-instance), [dev BigQuery dataset](#dev-bigquery-dataset) | +| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sourcegraph-accounts-dev-csvc) | +| Sentry | [`sourcegraph-accounts-dev`](https://sourcegraph.sentry.io/projects/sourcegraph-accounts-dev/) | +| Domain | [accounts.sgdev.org](https://accounts.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 | -| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 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) | @@ -51,8 +53,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Sourcegraph Accounts dev 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=sourcegraph-accounts-dev-csvc) | | 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=sourcegraph-accounts-dev-csvc) | @@ -64,17 +66,20 @@ sg msp logs sourcegraph-accounts dev #### dev Redis -| PROPERTY | DETAILS | -| -------- | --------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-----------------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=sourcegraph-accounts-dev-csvc) | #### dev PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ----------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------|-------------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=sourcegraph-accounts-dev-csvc) | | Databases | `accounts` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -87,8 +92,8 @@ sg msp pg connect -write-access sourcegraph-accounts dev #### dev BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Dataset Project | `sourcegraph-accounts-dev-csvc` | | Dataset ID | `sourcegraph_accounts` | | Tables | [`user_emails`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/user_emails.bigquerytable.json), [`events`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/events.bigquerytable.json) | @@ -101,7 +106,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [dev Cloud Run](#dev-cloud-run) section instead. In general: -> +> > - check service logs ([dev Cloud Run](#dev-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -120,18 +125,20 @@ sg msp tfc view sourcegraph-accounts dev ### prod -| PROPERTY | DETAILS | -| ---------- | --------------------------------------------------------------------------------------------------------------------------------- | -| Project ID | [`sourcegraph-accounts-prod-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-prod-csvc) | -| Category | **external** | -| Resources | [prod Redis](#prod-redis), [prod PostgreSQL instance](#prod-postgresql-instance), [prod BigQuery dataset](#prod-bigquery-dataset) | -| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sourcegraph-accounts-prod-csvc) | -| Sentry | [`sourcegraph-accounts-prod`](https://sourcegraph.sentry.io/projects/sourcegraph-accounts-prod/) | +| PROPERTY | DETAILS | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Project ID | [`sourcegraph-accounts-prod-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-prod-csvc) | +| Category | **external** | +| Resources | [prod Redis](#prod-redis), [prod PostgreSQL instance](#prod-postgresql-instance), [prod BigQuery dataset](#prod-bigquery-dataset) | +| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=sourcegraph-accounts-prod-csvc) | +| Sentry | [`sourcegraph-accounts-prod`](https://sourcegraph.sentry.io/projects/sourcegraph-accounts-prod/) | +| Domain | [accounts.sourcegraph.com](https://accounts.sourcegraph.com) | +| Cloudflare WAF | ✅ | MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -141,8 +148,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Sourcegraph Accounts 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=sourcegraph-accounts-prod-csvc) | | 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=sourcegraph-accounts-prod-csvc) | @@ -154,17 +161,20 @@ sg msp logs sourcegraph-accounts prod #### prod Redis -| PROPERTY | DETAILS | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|------------------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=sourcegraph-accounts-prod-csvc) | #### prod PostgreSQL instance -| PROPERTY | DETAILS | -| --------- | ------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|-----------|--------------------------------------------------------------------------------------------------------------| | Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=sourcegraph-accounts-prod-csvc) | | Databases | `accounts` | +> [!NOTE] +> The ['write access' Entitle permissions grant]([Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D)) is required for BOTH read-only and write access to the database. + 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 @@ -177,8 +187,8 @@ sg msp pg connect -write-access sourcegraph-accounts prod #### prod BigQuery dataset -| PROPERTY | DETAILS | -| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Dataset Project | `sourcegraph-accounts-prod-csvc` | | Dataset ID | `sourcegraph_accounts` | | Tables | [`user_emails`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/user_emails.bigquerytable.json), [`events`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/events.bigquerytable.json) | @@ -191,7 +201,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/support-integration.md b/content/departments/engineering/managed-services/support-integration.md index e81c1babe241..8b7fa48b1c06 100644 --- a/content/departments/engineering/managed-services/support-integration.md +++ b/content/departments/engineering/managed-services/support-integration.md @@ -3,22 +3,22 @@ This document describes operational guidance for Support Integration infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------| | Service ID | [`support-integration`](https://github.com/sourcegraph/managed-services/blob/main/services/support-integration/service.yaml) | | Owners | **Customer Support** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### prod -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------------|---------------------------------------------------------------------------------------------------------------| | Project ID | [`support-integration-prod-549b`](https://console.cloud.google.com/run?project=support-integration-prod-549b) | | Category | **internal** | | Resources | | @@ -42,8 +42,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -53,8 +53,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Support Integration 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=support-integration-prod-549b) | | 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=support-integration-prod-549b) | @@ -72,7 +72,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues diff --git a/content/departments/engineering/managed-services/telemetry-gateway.md b/content/departments/engineering/managed-services/telemetry-gateway.md index 6d4d41785c7a..d3d15f9a0925 100644 --- a/content/departments/engineering/managed-services/telemetry-gateway.md +++ b/content/departments/engineering/managed-services/telemetry-gateway.md @@ -3,22 +3,22 @@ This document describes operational guidance for Telemetry Gateway infrastructure. This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). > [!IMPORTANT] -> If this is your first time here, you should follow the [sourcegraph/managed-services README](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to set up the prerequisite tooling. +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | [`telemetry-gateway`](https://github.com/sourcegraph/managed-services/blob/main/services/telemetry-gateway/service.yaml) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -30,8 +30,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ### dev -| PROPERTY | DETAILS | -| ---------- | --------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|------------|-----------------------------------------------------------------------------------------------------------| | Project ID | [`telemetry-gateway-dev-0050`](https://console.cloud.google.com/run?project=telemetry-gateway-dev-0050) | | Category | **test** | | Resources | | @@ -41,8 +41,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] 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 | [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) | @@ -52,8 +52,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Telemetry Gateway dev 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=telemetry-gateway-dev-0050) | | 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=telemetry-gateway-dev-0050) | @@ -71,7 +71,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [dev Cloud Run](#dev-cloud-run) section instead. In general: -> +> > - check service logs ([dev Cloud Run](#dev-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues @@ -90,8 +90,8 @@ sg msp tfc view telemetry-gateway dev ### prod -| PROPERTY | DETAILS | -| ---------- | ---------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|------------|------------------------------------------------------------------------------------------------------------| | Project ID | [`telemetry-gateway-prod-acae`](https://console.cloud.google.com/run?project=telemetry-gateway-prod-acae) | | Category | **external** | | Resources | | @@ -101,8 +101,8 @@ sg msp tfc view telemetry-gateway dev MSP infrastructure access needs to be requested using Entitle for time-bound privileges. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -112,8 +112,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Telemetry Gateway 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=telemetry-gateway-prod-acae) | | 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=telemetry-gateway-prod-acae) | @@ -131,7 +131,7 @@ You may want to check your service environment's TFC workspaces if a Terraform a > [!NOTE] > If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: -> +> > - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving > - check TFC workspaces for infrastructure provisioning or configuration issues