diff --git a/content/departments/engineering/managed-services/cloud-ops.md b/content/departments/engineering/managed-services/cloud-ops.md index e9857072ae43..222b496d6259 100644 --- a/content/departments/engineering/managed-services/cloud-ops.md +++ b/content/departments/engineering/managed-services/cloud-ops.md @@ -3,8 +3,8 @@ This document describes operational guidance for Cloud Ops Dashboard infrastructure. diff --git a/content/departments/engineering/managed-services/cloud-relay.md b/content/departments/engineering/managed-services/cloud-relay.md new file mode 100644 index 000000000000..a42254390032 --- /dev/null +++ b/content/departments/engineering/managed-services/cloud-relay.md @@ -0,0 +1,93 @@ +# Cloud Relay infrastructure operations + + + +This document describes operational guidance for Cloud Relay infrastructure. +This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). + +> [!IMPORTANT] +> If this is your first time here, you must follow the [sourcegraph/managed-services 'Tooling setup' guide](https://github.com/sourcegraph/managed-services/blob/main/README.md) as well to clone the service definitions repository and set up the prerequisite tooling. + +If you need assistance with MSP infrastructure, reach out to the [Core Services](../teams/core-services/index.md) team in #discuss-core-services. + +## Service overview + +| PROPERTY | DETAILS | +| ------------ | -------------------------------------------------------------------------------------------------------------------- | +| Service ID | [`cloud-relay`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-relay/service.yaml) | +| Owners | **cloud** | +| Service kind | Cloud Run service | +| Environments | [prod](#prod) | +| Docker image | `us-central1-docker.pkg.dev/control-plane-5e9ee072/docker/cloud-relay` | +| Source code | [`https://github.com/sourcegraph/cloud-relay` - `.`](https://https://github.com/sourcegraph/cloud-relay/tree/HEAD/.) | + +## Environments + +### prod + +| PROPERTY | DETAILS | +| ------------------- | ---------------------------------------------------------------------------------------------------- | +| Project ID | [`cloud-relay-prod-bd4c`](https://console.cloud.google.com/run?project=cloud-relay-prod-bd4c) | +| Category | **internal** | +| Resources | | +| Slack notifications | [#alerts-cloud-relay-prod](https://sourcegraph.slack.com/archives/alerts-cloud-relay-prod) | +| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=cloud-relay-prod-bd4c) | +| Errors | [Sentry `cloud-relay-prod`](https://sourcegraph.sentry.io/projects/cloud-relay-prod/) | +| Domain | [cloud-relay.sgdev.org](https://cloud-relay.sgdev.org) | +| Cloudflare WAF | ✅ | + +MSP infrastructure access needs to be requested using Entitle for time-bound privileges. + +| 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) | + +For Terraform Cloud access, see [prod Terraform Cloud](#prod-terraform-cloud). + +#### prod Cloud Run + +The Cloud Relay prod service implementation is deployed on [Google Cloud Run](https://cloud.google.com/run). + +| PROPERTY | DETAILS | +| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Console | [Cloud Run service](https://console.cloud.google.com/run?project=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) | +| Service errors | [Sentry `cloud-relay-prod`](https://sourcegraph.sentry.io/projects/cloud-relay-prod/) | + +You can also use `sg msp` to quickly open a link to your service logs: + +```bash +sg msp logs 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. +Terraform Cloud (TFC) workspaces specific to each service then provisions the required infrastructure from this configuration. +You may want to check your service environment's TFC workspaces if a Terraform apply fails (reported via GitHub commit status checks in the [`sourcegraph/managed-services`](https://github.com/sourcegraph/managed-services) repository, or in #alerts-msp-tfc). + +> [!NOTE] +> If you are looking for service logs, see the [prod Cloud Run](#prod-cloud-run) section instead. In general: +> +> - check service logs ([prod Cloud Run](#prod-cloud-run)) if your service has gone down or is misbehaving +> - check TFC workspaces for infrastructure provisioning or configuration issues + +To access this environment's Terraform Cloud workspaces, you will need to [log in to Terraform Cloud](https://app.terraform.io/app/sourcegraph) and then [request Entitle access to membership in the "Managed Services Platform Operator" TFC team](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjM2MDAiLCJqdXN0aWZpY2F0aW9uIjoiSlVTVElGSUNBVElPTiBIRVJFIiwicm9sZUlkcyI6W3siaWQiOiJiMzg3MzJjYy04OTUyLTQ2Y2QtYmIxZS1lZjI2ODUwNzIyNmIiLCJ0aHJvdWdoIjoiYjM4NzMyY2MtODk1Mi00NmNkLWJiMWUtZWYyNjg1MDcyMjZiIiwidHlwZSI6InJvbGUifV19). +The "Managed Services Platform Operator" team has access to all MSP TFC workspaces. + +> [!WARNING] +> You **must [log in to Terraform Cloud](https://app.terraform.io/app/sourcegraph) before making your Entitle request**. +> If you make your Entitle request, then log in, you will be removed from any team memberships granted through Entitle by Terraform Cloud's SSO implementation. + +The Terraform Cloud workspaces for this service environment are [grouped under the `msp-cloud-relay-prod` tag](https://app.terraform.io/app/sourcegraph/workspaces?tag=msp-cloud-relay-prod), or you can use: + +```bash +sg msp tfc view cloud-relay prod +``` diff --git a/content/departments/engineering/managed-services/cody-analytics.md b/content/departments/engineering/managed-services/cody-analytics.md index 233d8ceaa351..f0c6a78c435f 100644 --- a/content/departments/engineering/managed-services/cody-analytics.md +++ b/content/departments/engineering/managed-services/cody-analytics.md @@ -3,8 +3,8 @@ This document describes operational guidance for Cody Analytics infrastructure. diff --git a/content/departments/engineering/managed-services/entitler.md b/content/departments/engineering/managed-services/entitler.md index de64d0f50ff8..1e87431abee6 100644 --- a/content/departments/engineering/managed-services/entitler.md +++ b/content/departments/engineering/managed-services/entitler.md @@ -3,8 +3,8 @@ This document describes operational guidance for Entitler infrastructure. diff --git a/content/departments/engineering/managed-services/gatekeeper.md b/content/departments/engineering/managed-services/gatekeeper.md index d9e3f157217a..540f9953d0b2 100644 --- a/content/departments/engineering/managed-services/gatekeeper.md +++ b/content/departments/engineering/managed-services/gatekeeper.md @@ -3,8 +3,8 @@ This document describes operational guidance for Cody Gatekeeper infrastructure. diff --git a/content/departments/engineering/managed-services/index.md b/content/departments/engineering/managed-services/index.md index e68953b407a4..f682f8e079bb 100644 --- a/content/departments/engineering/managed-services/index.md +++ b/content/departments/engineering/managed-services/index.md @@ -3,8 +3,8 @@ These pages contain generated operational guidance for the infrastructure of [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md) services. @@ -29,6 +29,7 @@ Managed Services Platform services owned by `Customer Support`: Managed Services Platform services owned by `cloud`: - [Cloud Ops Dashboard](./cloud-ops.md) +- [Cloud Relay](./cloud-relay.md) ## cody-plg diff --git a/content/departments/engineering/managed-services/msp-testbed.md b/content/departments/engineering/managed-services/msp-testbed.md index 0b1dff50d9a9..dd02c4823edb 100644 --- a/content/departments/engineering/managed-services/msp-testbed.md +++ b/content/departments/engineering/managed-services/msp-testbed.md @@ -3,8 +3,8 @@ This document describes operational guidance for MSP Testbed infrastructure. diff --git a/content/departments/engineering/managed-services/pings.md b/content/departments/engineering/managed-services/pings.md index 308f0f11e002..ead843f63c38 100644 --- a/content/departments/engineering/managed-services/pings.md +++ b/content/departments/engineering/managed-services/pings.md @@ -3,8 +3,8 @@ This document describes operational guidance for Pings Service infrastructure. diff --git a/content/departments/engineering/managed-services/releaseregistry.md b/content/departments/engineering/managed-services/releaseregistry.md index 88aff6d809c5..ad7b208abc40 100644 --- a/content/departments/engineering/managed-services/releaseregistry.md +++ b/content/departments/engineering/managed-services/releaseregistry.md @@ -3,8 +3,8 @@ This document describes operational guidance for Release Registry infrastructure. diff --git a/content/departments/engineering/managed-services/sams.md b/content/departments/engineering/managed-services/sams.md index d76413ee3ed4..73ce6ac7ebdd 100644 --- a/content/departments/engineering/managed-services/sams.md +++ b/content/departments/engineering/managed-services/sams.md @@ -3,8 +3,8 @@ This document describes operational guidance for Self-Serve Cody infrastructure. diff --git a/content/departments/engineering/managed-services/sourcegraph-accounts.md b/content/departments/engineering/managed-services/sourcegraph-accounts.md index 41c0669e922e..6411536d6e38 100644 --- a/content/departments/engineering/managed-services/sourcegraph-accounts.md +++ b/content/departments/engineering/managed-services/sourcegraph-accounts.md @@ -3,8 +3,8 @@ This document describes operational guidance for Sourcegraph Accounts infrastructure. diff --git a/content/departments/engineering/managed-services/support-integration.md b/content/departments/engineering/managed-services/support-integration.md index 8422a54062c5..39e16d6c7bf4 100644 --- a/content/departments/engineering/managed-services/support-integration.md +++ b/content/departments/engineering/managed-services/support-integration.md @@ -3,8 +3,8 @@ This document describes operational guidance for Support Integration infrastructure. diff --git a/content/departments/engineering/managed-services/telemetry-gateway.md b/content/departments/engineering/managed-services/telemetry-gateway.md index bd2f7ae9faed..386c40d2b7fd 100644 --- a/content/departments/engineering/managed-services/telemetry-gateway.md +++ b/content/departments/engineering/managed-services/telemetry-gateway.md @@ -3,8 +3,8 @@ This document describes operational guidance for Telemetry Gateway infrastructure.