diff --git a/content/departments/engineering/managed-services/build-tracker-prod.svg b/content/departments/engineering/managed-services/build-tracker-prod.svg new file mode 100644 index 000000000000..917072970c47 --- /dev/null +++ b/content/departments/engineering/managed-services/build-tracker-prod.svg @@ -0,0 +1,101 @@ +Cloud Run ServiceMonitoringTraceRedisApplication Load BalancerExternal IP AddressInternet + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/build-tracker.md b/content/departments/engineering/managed-services/build-tracker.md index 4a909ee92863..9e18d2186943 100644 --- a/content/departments/engineering/managed-services/build-tracker.md +++ b/content/departments/engineering/managed-services/build-tracker.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `build-tracker` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/build-tracker/service.yaml)) | | Owners | **dev-experience** | | Service kind | Cloud Run service | @@ -28,8 +28,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`build-tracker-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/build-tracker-us-central1-rollout?project=build-tracker-prod-59bf) | | Stages | [prod](#prod) | @@ -39,8 +39,8 @@ Changes to Build Tracker are continuously delivered to the first stage ([prod](# ### prod -| PROPERTY | DETAILS | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`build-tracker-prod-59bf`](https://console.cloud.google.com/run?project=build-tracker-prod-59bf) | | Category | **test** | | Deployment type | `rollout` | @@ -53,8 +53,8 @@ Changes to Build Tracker are continuously delivered to the first stage ([prod](# MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -64,8 +64,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Build Tracker prod service implementation is deployed on [Google Cloud Run](https://cloud.google.com/run). -| PROPERTY | DETAILS | -| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Console | [Cloud Run service](https://console.cloud.google.com/run?project=build-tracker-prod-59bf) | | Service logs | [GCP logging](https://console.cloud.google.com/logs/query;query=resource.type%20%3D%20%22cloud_run_revision%22%20-logName%3D~%22logs%2Frun.googleapis.com%252Frequests%22;summaryFields=jsonPayload%252FInstrumentationScope,jsonPayload%252FBody,jsonPayload%252FAttributes%252Ferror:false:32:end?project=build-tracker-prod-59bf) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=build-tracker-prod-59bf) | @@ -79,10 +79,14 @@ sg msp logs build-tracker prod #### prod Redis -| PROPERTY | DETAILS | -| -------- | --------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|-----------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=build-tracker-prod-59bf) | +#### prod Architecture Diagram + +![Architecture Diagram](./build-tracker-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/build-tracker/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/build-tracker/service.yaml), and `sg msp generate build-tracker prod` generates the required infrastructure configuration for this environment in Terraform. @@ -108,7 +112,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view build-tracker prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -163,7 +167,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/cloud-ops-dev.svg b/content/departments/engineering/managed-services/cloud-ops-dev.svg new file mode 100644 index 000000000000..91014814559f --- /dev/null +++ b/content/departments/engineering/managed-services/cloud-ops-dev.svg @@ -0,0 +1,102 @@ +Cloud Run ServiceMonitoringTraceRedisExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/cloud-ops-prod.svg b/content/departments/engineering/managed-services/cloud-ops-prod.svg new file mode 100644 index 000000000000..91014814559f --- /dev/null +++ b/content/departments/engineering/managed-services/cloud-ops-prod.svg @@ -0,0 +1,102 @@ +Cloud Run ServiceMonitoringTraceRedisExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/cloud-ops.md b/content/departments/engineering/managed-services/cloud-ops.md index 42843b329bc0..dac0aa058eea 100644 --- a/content/departments/engineering/managed-services/cloud-ops.md +++ b/content/departments/engineering/managed-services/cloud-ops.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------| | Service ID | `cloud-ops` ([specification](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** | | Deployment type | `subscription` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=cloud-ops-prod-dd32) | @@ -70,10 +70,14 @@ 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 Architecture Diagram + +![Architecture Diagram](./cloud-ops-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-ops/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml), and `sg msp generate cloud-ops prod` generates the required infrastructure configuration for this environment in Terraform. @@ -101,8 +105,8 @@ sg msp tfc view cloud-ops prod ### dev -| PROPERTY | DETAILS | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`cloud-ops-dev-caff`](https://console.cloud.google.com/run?project=cloud-ops-dev-caff) | | Category | **internal** | | Deployment type | `manual` | @@ -115,8 +119,8 @@ sg msp tfc view cloud-ops prod 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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -126,8 +130,8 @@ For Terraform Cloud access, see [dev Terraform Cloud](#dev-terraform-cloud). The Cloud Ops Dashboard 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=cloud-ops-dev-caff) | | 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-dev-caff) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=cloud-ops-dev-caff) | @@ -141,10 +145,14 @@ sg msp logs cloud-ops dev #### dev Redis -| PROPERTY | DETAILS | -| -------- | ---------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|----------|------------------------------------------------------------------------------------------------------------------------| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=cloud-ops-dev-caff) | +#### dev Architecture Diagram + +![Architecture Diagram](./cloud-ops-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-ops/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml), and `sg msp generate cloud-ops dev` generates the required infrastructure configuration for this environment in Terraform. @@ -170,7 +178,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view cloud-ops dev ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -225,7 +233,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/cloud-relay-prod.svg b/content/departments/engineering/managed-services/cloud-relay-prod.svg new file mode 100644 index 000000000000..1aab2a1df5b8 --- /dev/null +++ b/content/departments/engineering/managed-services/cloud-relay-prod.svg @@ -0,0 +1,101 @@ +Cloud Run ServiceMonitoringTraceExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/cloud-relay.md b/content/departments/engineering/managed-services/cloud-relay.md index 44e2bd4e8643..1c9d57af7000 100644 --- a/content/departments/engineering/managed-services/cloud-relay.md +++ b/content/departments/engineering/managed-services/cloud-relay.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------| | Service ID | `cloud-relay` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-relay/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-relay-prod-bd4c`](https://console.cloud.google.com/run?project=cloud-relay-prod-bd4c) | | Category | **internal** | | Deployment type | `manual` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,8 @@ For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). The Cloud Relay 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-relay-prod-bd4c) | | 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-relay-prod-bd4c) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=cloud-relay-prod-bd4c) | @@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs cloud-relay prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./cloud-relay-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/cloud-relay/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-relay/service.yaml), and `sg msp generate cloud-relay prod` generates the required infrastructure configuration for this environment in Terraform. @@ -93,7 +97,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view cloud-relay prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -124,7 +128,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/cody-analytics-dev.svg b/content/departments/engineering/managed-services/cody-analytics-dev.svg new file mode 100644 index 000000000000..d359c7385692 --- /dev/null +++ b/content/departments/engineering/managed-services/cody-analytics-dev.svg @@ -0,0 +1,100 @@ +Cloud Run ServiceMonitoringTraceApplication Load BalancerExternal IP AddressInternet + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/cody-analytics-prod.svg b/content/departments/engineering/managed-services/cody-analytics-prod.svg new file mode 100644 index 000000000000..1aab2a1df5b8 --- /dev/null +++ b/content/departments/engineering/managed-services/cody-analytics-prod.svg @@ -0,0 +1,101 @@ +Cloud Run ServiceMonitoringTraceExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/cody-analytics.md b/content/departments/engineering/managed-services/cody-analytics.md index eae91d702ed8..2b433000e58e 100644 --- a/content/departments/engineering/managed-services/cody-analytics.md +++ b/content/departments/engineering/managed-services/cody-analytics.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `cody-analytics` ([specification](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** | | Deployment type | `manual` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=cody-analytics-dev-bd34) | @@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs cody-analytics dev ``` +#### dev Architecture Diagram + +![Architecture Diagram](./cody-analytics-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/cody-analytics/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml), and `sg msp generate cody-analytics dev` generates the required infrastructure configuration for this environment in Terraform. @@ -95,8 +99,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** | | Deployment type | `manual` | @@ -109,8 +113,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 | [Read-only Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -120,8 +124,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=cody-analytics-prod-da5a) | @@ -133,6 +137,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs cody-analytics prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./cody-analytics-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/cody-analytics/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml), and `sg msp generate cody-analytics prod` generates the required infrastructure configuration for this environment in Terraform. @@ -158,7 +166,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view cody-analytics prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -189,7 +197,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/entitler-prod.svg b/content/departments/engineering/managed-services/entitler-prod.svg new file mode 100644 index 000000000000..1aab2a1df5b8 --- /dev/null +++ b/content/departments/engineering/managed-services/entitler-prod.svg @@ -0,0 +1,101 @@ +Cloud Run ServiceMonitoringTraceExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/entitler.md b/content/departments/engineering/managed-services/entitler.md index 95c88dba4a31..dc0ead987c69 100644 --- a/content/departments/engineering/managed-services/entitler.md +++ b/content/departments/engineering/managed-services/entitler.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | --------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|-----------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `entitler` ([specification](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** | | Deployment type | `manual` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=entitler-prod-0516) | @@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs entitler prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./entitler-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/entitler/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/entitler/service.yaml), and `sg msp generate entitler prod` generates the required infrastructure configuration for this environment in Terraform. @@ -93,7 +97,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view entitler prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -124,7 +128,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/gatekeeper-prod.svg b/content/departments/engineering/managed-services/gatekeeper-prod.svg new file mode 100644 index 000000000000..06780704d96f --- /dev/null +++ b/content/departments/engineering/managed-services/gatekeeper-prod.svg @@ -0,0 +1,96 @@ +Cloud Run JobMonitoring + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/gatekeeper.md b/content/departments/engineering/managed-services/gatekeeper.md index d8ccb1ae3b24..f7170c39e116 100644 --- a/content/departments/engineering/managed-services/gatekeeper.md +++ b/content/departments/engineering/managed-services/gatekeeper.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------| | Service ID | `gatekeeper` ([specification](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** | | Deployment type | `subscription` | @@ -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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [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 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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=gatekeeper-prod-1c93) | @@ -66,6 +66,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs gatekeeper prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./gatekeeper-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/gatekeeper/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/gatekeeper/service.yaml), and `sg msp generate gatekeeper prod` generates the required infrastructure configuration for this environment in Terraform. @@ -91,7 +95,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view gatekeeper prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. diff --git a/content/departments/engineering/managed-services/index.md b/content/departments/engineering/managed-services/index.md index 3f3307dd6cdd..60b8c4eb4b6c 100644 --- a/content/departments/engineering/managed-services/index.md +++ b/content/departments/engineering/managed-services/index.md @@ -3,7 +3,7 @@ diff --git a/content/departments/engineering/managed-services/msp-testbed-robert.svg b/content/departments/engineering/managed-services/msp-testbed-robert.svg new file mode 100644 index 000000000000..5d5dd8c86f96 --- /dev/null +++ b/content/departments/engineering/managed-services/msp-testbed-robert.svg @@ -0,0 +1,112 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresApplication Load BalancerExternal IP AddressInternetexampleprimary + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/msp-testbed-test.svg b/content/departments/engineering/managed-services/msp-testbed-test.svg new file mode 100644 index 000000000000..050525d7cf92 --- /dev/null +++ b/content/departments/engineering/managed-services/msp-testbed-test.svg @@ -0,0 +1,113 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresExternal IP AddressInternetexampleprimaryApplication Load BalancerCloud Armor + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/msp-testbed.md b/content/departments/engineering/managed-services/msp-testbed.md index 94b7a9203378..fc494a21f57c 100644 --- a/content/departments/engineering/managed-services/msp-testbed.md +++ b/content/departments/engineering/managed-services/msp-testbed.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------------| | Service ID | `msp-testbed` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml)) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -35,8 +35,8 @@ Each Core Services teammate generally focuses their experiments on an individual ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`msp-testbed-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/msp-testbed-us-central1-rollout?project=msp-testbed-robert-7be9) | | Stages | [test](#test) -> [robert](#robert) | @@ -48,8 +48,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u ### test -| PROPERTY | DETAILS | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`msp-testbed-test-77589aae45d0`](https://console.cloud.google.com/run?project=msp-testbed-test-77589aae45d0) | | Category | **internal** | | Deployment type | `rollout` | @@ -62,8 +62,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u 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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -73,8 +73,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=msp-testbed-test-77589aae45d0) | @@ -88,14 +88,14 @@ 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` | @@ -114,12 +114,16 @@ 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) | +#### test Architecture Diagram + +![Architecture Diagram](./msp-testbed-test) + #### test Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/msp-testbed/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml), and `sg msp generate msp-testbed test` generates the required infrastructure configuration for this environment in Terraform. @@ -147,8 +151,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** | | Deployment type | `rollout` | @@ -161,8 +165,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 | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -172,8 +176,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=msp-testbed-robert-7be9) | @@ -187,14 +191,14 @@ 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` | @@ -213,12 +217,16 @@ 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) | +#### robert Architecture Diagram + +![Architecture Diagram](./msp-testbed-robert) + #### robert Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/msp-testbed/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml), and `sg msp generate msp-testbed robert` generates the required infrastructure configuration for this environment in Terraform. @@ -244,7 +252,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view msp-testbed robert ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -358,7 +366,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/pings-prod.svg b/content/departments/engineering/managed-services/pings-prod.svg new file mode 100644 index 000000000000..6ee1b43b0608 --- /dev/null +++ b/content/departments/engineering/managed-services/pings-prod.svg @@ -0,0 +1,100 @@ +Cloud Run ServiceMonitoringTraceApplication Load BalancerExternal IP AddressInternet + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/pings.md b/content/departments/engineering/managed-services/pings.md index 591b4bf7c425..50d092a743c6 100644 --- a/content/departments/engineering/managed-services/pings.md +++ b/content/departments/engineering/managed-services/pings.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------| | Service ID | `pings` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/pings/service.yaml)) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -28,8 +28,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`pings-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/pings-us-central1-rollout?project=pings-prod-2f4f73edf1db) | | Stages | [prod](#prod) | @@ -39,8 +39,8 @@ Changes to Pings Service are continuously delivered to the first stage ([prod](# ### prod -| PROPERTY | DETAILS | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`pings-prod-2f4f73edf1db`](https://console.cloud.google.com/run?project=pings-prod-2f4f73edf1db) | | Category | **external** | | Deployment type | `rollout` | @@ -52,8 +52,8 @@ Changes to Pings Service are continuously delivered to the first stage ([prod](# 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 | [Read-only Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -63,8 +63,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=pings-prod-2f4f73edf1db) | @@ -76,6 +76,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs pings prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./pings-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/pings/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/pings/service.yaml), and `sg msp generate pings prod` generates the required infrastructure configuration for this environment in Terraform. @@ -101,7 +105,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view pings prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -132,7 +136,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/releaseregistry-dev.svg b/content/departments/engineering/managed-services/releaseregistry-dev.svg new file mode 100644 index 000000000000..ed8df91b0eca --- /dev/null +++ b/content/departments/engineering/managed-services/releaseregistry-dev.svg @@ -0,0 +1,109 @@ +Cloud Run ServiceMonitoringTracePostgresApplication Load BalancerExternal IP AddressInternetreleaseregistry + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/releaseregistry-prod.svg b/content/departments/engineering/managed-services/releaseregistry-prod.svg new file mode 100644 index 000000000000..ed8df91b0eca --- /dev/null +++ b/content/departments/engineering/managed-services/releaseregistry-prod.svg @@ -0,0 +1,109 @@ +Cloud Run ServiceMonitoringTracePostgresApplication Load BalancerExternal IP AddressInternetreleaseregistry + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/releaseregistry.md b/content/departments/engineering/managed-services/releaseregistry.md index 3e82117edb9d..dd362f8fcffe 100644 --- a/content/departments/engineering/managed-services/releaseregistry.md +++ b/content/departments/engineering/managed-services/releaseregistry.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `releaseregistry` ([specification](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** | | Deployment type | `manual` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=releaseregistry-prod-5421) | @@ -70,8 +70,8 @@ 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` | @@ -88,6 +88,10 @@ sg msp pg connect releaseregistry prod sg msp pg connect -write-access releaseregistry prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./releaseregistry-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/releaseregistry/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/releaseregistry/service.yaml), and `sg msp generate releaseregistry prod` generates the required infrastructure configuration for this environment in Terraform. @@ -115,8 +119,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** | | Deployment type | `subscription` | @@ -129,8 +133,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 | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -140,8 +144,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=releaseregistry-dev-6bac) | @@ -155,8 +159,8 @@ 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` | @@ -173,6 +177,10 @@ sg msp pg connect releaseregistry dev sg msp pg connect -write-access releaseregistry dev ``` +#### dev Architecture Diagram + +![Architecture Diagram](./releaseregistry-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/releaseregistry/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/releaseregistry/service.yaml), and `sg msp generate releaseregistry dev` generates the required infrastructure configuration for this environment in Terraform. @@ -198,7 +206,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view releaseregistry dev ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -288,7 +296,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/sams-dev.svg b/content/departments/engineering/managed-services/sams-dev.svg new file mode 100644 index 000000000000..71b1bfbf54e6 --- /dev/null +++ b/content/departments/engineering/managed-services/sams-dev.svg @@ -0,0 +1,116 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresApplication Load BalancerExternal IP AddressInternetuser_emailseventscody_eventssubscription_eventsaccountscody_management + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/sams-prod.svg b/content/departments/engineering/managed-services/sams-prod.svg new file mode 100644 index 000000000000..fa6ceb205bda --- /dev/null +++ b/content/departments/engineering/managed-services/sams-prod.svg @@ -0,0 +1,117 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresExternal IP AddressInternetuser_emailseventscody_eventssubscription_eventsaccountscody_managementApplication Load BalancerCloud Armor + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/sams.md b/content/departments/engineering/managed-services/sams.md index 1de512df8ae8..a757103626ee 100644 --- a/content/departments/engineering/managed-services/sams.md +++ b/content/departments/engineering/managed-services/sams.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `sams` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/sams/service.yaml)) | | Owners | **cody-plg** | | Service kind | Cloud Run service | @@ -28,8 +28,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`sams-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/sams-us-central1-rollout?project=sams-prod-ywuz) | | Stages | [dev](#dev) -> [prod](#prod) | @@ -41,8 +41,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u ### dev -| PROPERTY | DETAILS | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| PROPERTY | DETAILS | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`sams-dev-bfec`](https://console.cloud.google.com/run?project=sams-dev-bfec) | | Category | **test** | | Deployment type | `rollout` | @@ -55,8 +55,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -66,8 +66,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=sams-dev-bfec) | @@ -81,14 +81,14 @@ 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` | @@ -107,12 +107,16 @@ 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) | +#### dev Architecture Diagram + +![Architecture Diagram](./sams-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/sams/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/service.yaml), and `sg msp generate sams dev` generates the required infrastructure configuration for this environment in Terraform. @@ -140,8 +144,8 @@ 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** | | Deployment type | `rollout` | @@ -154,8 +158,8 @@ sg msp tfc view sams 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 | [Read-only Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -165,8 +169,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=sams-prod-ywuz) | @@ -180,14 +184,14 @@ 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` | @@ -206,12 +210,16 @@ 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) | +#### prod Architecture Diagram + +![Architecture Diagram](./sams-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/sams/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/sams/service.yaml), and `sg msp generate sams prod` generates the required infrastructure configuration for this environment in Terraform. @@ -237,7 +245,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view sams prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -351,7 +359,7 @@ Severity: WARNING #### High Ratio of 400 Responses ```md -400 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +400 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -359,7 +367,7 @@ Severity: WARNING #### High Ratio of 401 Responses ```md -401 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +401 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -367,7 +375,7 @@ Severity: WARNING #### High Ratio of 403 Responses ```md -403 (forbidden) responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +403 (forbidden) responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -375,7 +383,7 @@ Severity: WARNING #### High Ratio of 500 Responses ```md -500 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +500 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -383,7 +391,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/sourcegraph-accounts-dev.svg b/content/departments/engineering/managed-services/sourcegraph-accounts-dev.svg new file mode 100644 index 000000000000..99506786037b --- /dev/null +++ b/content/departments/engineering/managed-services/sourcegraph-accounts-dev.svg @@ -0,0 +1,113 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresApplication Load BalancerExternal IP AddressInternetuser_emailseventsaccounts + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/sourcegraph-accounts-prod.svg b/content/departments/engineering/managed-services/sourcegraph-accounts-prod.svg new file mode 100644 index 000000000000..0f121673deea --- /dev/null +++ b/content/departments/engineering/managed-services/sourcegraph-accounts-prod.svg @@ -0,0 +1,114 @@ +Cloud Run ServiceMonitoringTraceRedisBigQueryPostgresExternal IP AddressInternetuser_emailseventsaccountsApplication Load BalancerCloud Armor + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/sourcegraph-accounts.md b/content/departments/engineering/managed-services/sourcegraph-accounts.md index 880efeca5627..f91c27b5511e 100644 --- a/content/departments/engineering/managed-services/sourcegraph-accounts.md +++ b/content/departments/engineering/managed-services/sourcegraph-accounts.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `sourcegraph-accounts` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/service.yaml)) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -33,7 +33,6 @@ Automatically generated from the service README: https://github.com/sourcegraph/ ### Operators cheat sheet #### Get email domain stats - For Google sign-in abuse protection. ```zsh @@ -76,8 +75,8 @@ WHERE id = '' ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`sourcegraph-accounts-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/sourcegraph-accounts-us-central1-rollout?project=sourcegraph-accounts-prod-csvc) | | Stages | [dev](#dev) -> [prod](#prod) | @@ -89,8 +88,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u ### dev -| PROPERTY | DETAILS | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`sourcegraph-accounts-dev-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-dev-csvc) | | Category | **test** | | Deployment type | `rollout` | @@ -103,8 +102,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -114,8 +113,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=sourcegraph-accounts-dev-csvc) | @@ -129,14 +128,14 @@ 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` | @@ -155,12 +154,16 @@ 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) | +#### dev Architecture Diagram + +![Architecture Diagram](./sourcegraph-accounts-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/sourcegraph-accounts/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/service.yaml), and `sg msp generate sourcegraph-accounts dev` generates the required infrastructure configuration for this environment in Terraform. @@ -188,8 +191,8 @@ sg msp tfc view sourcegraph-accounts dev ### prod -| PROPERTY | DETAILS | -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`sourcegraph-accounts-prod-csvc`](https://console.cloud.google.com/run?project=sourcegraph-accounts-prod-csvc) | | Category | **external** | | Deployment type | `rollout` | @@ -202,8 +205,8 @@ sg msp tfc view sourcegraph-accounts 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 | [Read-only Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -213,8 +216,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=sourcegraph-accounts-prod-csvc) | @@ -228,14 +231,14 @@ 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` | @@ -254,12 +257,16 @@ 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) | +#### prod Architecture Diagram + +![Architecture Diagram](./sourcegraph-accounts-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/sourcegraph-accounts/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/sourcegraph-accounts/service.yaml), and `sg msp generate sourcegraph-accounts prod` generates the required infrastructure configuration for this environment in Terraform. @@ -285,7 +292,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view sourcegraph-accounts prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -399,7 +406,7 @@ Severity: WARNING #### High Ratio of 400 Responses ```md -400 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +400 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -407,7 +414,7 @@ Severity: WARNING #### High Ratio of 401 Responses ```md -401 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +401 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -415,7 +422,7 @@ Severity: WARNING #### High Ratio of 403 Responses ```md -403 (forbidden) responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +403 (forbidden) responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -423,7 +430,7 @@ Severity: WARNING #### High Ratio of 500 Responses ```md -500 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. +500 responses coming from the application. Does NOT include requests that did not reach the instance, e.g. if no host is available to receive a request - check GCP logs and error reports instead. ``` Severity: WARNING @@ -431,7 +438,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/support-integration-prod.svg b/content/departments/engineering/managed-services/support-integration-prod.svg new file mode 100644 index 000000000000..1aab2a1df5b8 --- /dev/null +++ b/content/departments/engineering/managed-services/support-integration-prod.svg @@ -0,0 +1,101 @@ +Cloud Run ServiceMonitoringTraceExternal IP AddressInternetApplication Load BalancerCloud Armor + + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/support-integration.md b/content/departments/engineering/managed-services/support-integration.md index dd990ba8e8de..8f234a48301e 100644 --- a/content/departments/engineering/managed-services/support-integration.md +++ b/content/departments/engineering/managed-services/support-integration.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `support-integration` ([specification](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** | | Deployment type | `manual` | @@ -44,8 +44,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 | [Read-only Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -55,8 +55,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=support-integration-prod-549b) | @@ -68,6 +68,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs support-integration prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./support-integration-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/support-integration/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/support-integration/service.yaml), and `sg msp generate support-integration prod` generates the required infrastructure configuration for this environment in Terraform. @@ -93,7 +97,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view support-integration prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -124,7 +128,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING diff --git a/content/departments/engineering/managed-services/telemetry-gateway-dev.svg b/content/departments/engineering/managed-services/telemetry-gateway-dev.svg new file mode 100644 index 000000000000..6ee1b43b0608 --- /dev/null +++ b/content/departments/engineering/managed-services/telemetry-gateway-dev.svg @@ -0,0 +1,100 @@ +Cloud Run ServiceMonitoringTraceApplication Load BalancerExternal IP AddressInternet + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/telemetry-gateway-prod.svg b/content/departments/engineering/managed-services/telemetry-gateway-prod.svg new file mode 100644 index 000000000000..6ee1b43b0608 --- /dev/null +++ b/content/departments/engineering/managed-services/telemetry-gateway-prod.svg @@ -0,0 +1,100 @@ +Cloud Run ServiceMonitoringTraceApplication Load BalancerExternal IP AddressInternet + + + + + + + + \ No newline at end of file diff --git a/content/departments/engineering/managed-services/telemetry-gateway.md b/content/departments/engineering/managed-services/telemetry-gateway.md index 667f88b44d1e..caeebc7fe3dc 100644 --- a/content/departments/engineering/managed-services/telemetry-gateway.md +++ b/content/departments/engineering/managed-services/telemetry-gateway.md @@ -3,7 +3,7 @@ @@ -17,8 +17,8 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services] ## Service overview -| PROPERTY | DETAILS | -| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|--------------|----------------------------------------------------------------------------------------------------------------------------------------------| | Service ID | `telemetry-gateway` ([specification](https://github.com/sourcegraph/managed-services/blob/main/services/telemetry-gateway/service.yaml)) | | Owners | **core-services** | | Service kind | Cloud Run service | @@ -65,8 +65,8 @@ The production Telemetry Gateway instance has custom metrics dashboard defined i ## Rollouts -| PROPERTY | DETAILS | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Delivery pipeline | [`telemetry-gateway-us-central1-rollout`](https://console.cloud.google.com/deploy/delivery-pipelines/us-central1/telemetry-gateway-us-central1-rollout?project=telemetry-gateway-prod-acae) | | Stages | [dev](#dev) -> [prod](#prod) | @@ -78,8 +78,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u ### dev -| PROPERTY | DETAILS | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| PROPERTY | DETAILS | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Project ID | [`telemetry-gateway-dev-0050`](https://console.cloud.google.com/run?project=telemetry-gateway-dev-0050) | | Category | **test** | | Deployment type | `rollout` | @@ -91,8 +91,8 @@ Promotion of a release to the next stage in the pipeline must be done manually u MSP infrastructure access needs to be requested using Entitle for time-bound privileges. Test environments may have less stringent requirements. -| ACCESS | ENTITLE REQUEST TEMPLATE | -| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ACCESS | ENTITLE REQUEST TEMPLATE | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GCP project read access | [Read-only Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -102,8 +102,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=telemetry-gateway-dev-0050) | @@ -115,6 +115,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs telemetry-gateway dev ``` +#### dev Architecture Diagram + +![Architecture Diagram](./telemetry-gateway-dev) + #### dev Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/telemetry-gateway/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/telemetry-gateway/service.yaml), and `sg msp generate telemetry-gateway dev` generates the required infrastructure configuration for this environment in Terraform. @@ -142,8 +146,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** | | Deployment type | `rollout` | @@ -155,8 +159,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 | [Read-only Entitle request for the 'Managed Services ' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYTQ4OWM2MDktNTBlYy00ODAzLWIzZjItMzYzZGJhMTgwMWJhIiwidGhyb3VnaCI6ImE0ODljNjA5LTUwZWMtNDgwMy1iM2YyLTM2M2RiYTE4MDFiYSIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | GCP project write access | [Write access Entitle request for the 'Managed Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiODQzNTYxNzktZjkwMi00MDVlLTlhMTQtNTY3YTY1NmM5MzdmIiwidGhyb3VnaCI6Ijg0MzU2MTc5LWY5MDItNDA1ZS05YTE0LTU2N2E2NTZjOTM3ZiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | @@ -166,8 +170,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) | | Service traces | [Cloud Trace](https://console.cloud.google.com/traces/list?project=telemetry-gateway-prod-acae) | @@ -179,6 +183,10 @@ You can also use `sg msp` to quickly open a link to your service logs: sg msp logs telemetry-gateway prod ``` +#### prod Architecture Diagram + +![Architecture Diagram](./telemetry-gateway-prod) + #### prod Terraform Cloud This service's configuration is defined in [`sourcegraph/managed-services/services/telemetry-gateway/service.yaml`](https://github.com/sourcegraph/managed-services/blob/main/services/telemetry-gateway/service.yaml), and `sg msp generate telemetry-gateway prod` generates the required infrastructure configuration for this environment in Terraform. @@ -204,7 +212,7 @@ The Terraform Cloud workspaces for this service environment are [grouped under t sg msp tfc view telemetry-gateway prod ``` -### Alert Policies +## Alert Policies The following alert policies are defined for each of this service's environments. @@ -235,7 +243,7 @@ Severity: WARNING #### Cloud Run Pending Requests ```md -There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. +There are requests pending - we may need to increase Cloud Run instance count, request concurrency, or investigate further. ``` Severity: WARNING