This repository has been archived by the owner on Jul 2, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
engineering/managed-services: add generated docs (#8429)
This adds generated docs for all MSP services under `content/departments/engineering/infrastructure/managed-services/` - we put it in a "shared" directory as opposed to team-specific to keep everything in one place, and keep it simple (finding the appropriate path for a team is hard, and historically has changed frequently). Generated using https://github.com/sourcegraph/sourcegraph/pull/59496 **Preview: https://deploy-preview-8429--sourcegraph-handbook.netlify.app/departments/engineering/managed-services/** --------- Co-authored-by: bobheadxi <[email protected]>
- Loading branch information
Showing
14 changed files
with
603 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
content/departments/engineering/managed-services/cloud-ops.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Cloud Ops Dashboard infrastructure operations | ||
|
|
||
| <!-- | ||
| Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages' | ||
| Last updated: 2024-01-11 18:09:55.856334 +0000 UTC | ||
| Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b | ||
| --> | ||
|
|
||
| This document describes operational guidance for Cloud Ops Dashboard infrastructure. | ||
| This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). | ||
|
|
||
| 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-ops`](https://github.com/sourcegraph/managed-services/blob/main/services/cloud-ops/service.yaml) | | ||
| | Owners | **cloud** | | ||
| | Service kind | Cloud Run service | | ||
| | Environments | [prod](#prod) | | ||
| | Docker image | `us-central1-docker.pkg.dev/control-plane-5e9ee072/docker/apiserver` | | ||
| | Source code | [`github.com/sourcegraph/controller` - `cmd/apiserver`](https://github.com/sourcegraph/controller/tree/HEAD/cmd/apiserver) | | ||
|
|
||
| ## Environments | ||
|
|
||
| ### prod | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------------- | -------------------------------------------------------------------------------------------------- | | ||
| | Project ID | [`cloud-ops-prod-dd32`](https://console.cloud.google.com/run?project=cloud-ops-prod-dd32) | | ||
| | Category | **internal** | | ||
| | Resources | [prod Redis](#prod-redis) | | ||
| | Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=cloud-ops-prod-dd32) | | ||
| | Domain | [cloud-ops.sgdev.org](https://cloud-ops.sgdev.org) | | ||
| | Cloudflare WAF | ✅ | | ||
|
|
||
| MSP infrastructure access needs to be requested using Entitle for time-bound privileges. | ||
| Test environments have less stringent requirements. | ||
|
|
||
| | ACCESS | ENTITLE REQUEST TEMPLATE | | ||
| | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
| | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
|
|
||
| #### prod Cloud Run | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Console | [Cloud Run service](https://console.cloud.google.com/run?project=cloud-ops-prod-dd32) | | ||
| | 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) | | ||
|
|
||
| #### prod Redis | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------- | ----------------------------------------------------------------------------------------------------------------------- | | ||
| | Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=cloud-ops-prod-dd32) | |
52 changes: 52 additions & 0 deletions
52
content/departments/engineering/managed-services/cody-analytics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Cody Analytics infrastructure operations | ||
|
|
||
| <!-- | ||
| Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages' | ||
| Last updated: 2024-01-11 18:09:55.857756 +0000 UTC | ||
| Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b | ||
| --> | ||
|
|
||
| This document describes operational guidance for Cody Analytics infrastructure. | ||
| This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). | ||
|
|
||
| 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 | [`cody-analytics`](https://github.com/sourcegraph/managed-services/blob/main/services/cody-analytics/service.yaml) | | ||
| | Owners | **cody-strat** | | ||
| | Service kind | Cloud Run service | | ||
| | Environments | [dev](#dev) | | ||
| | Docker image | `us-central1-docker.pkg.dev/sourcegraph-dev/cody-analytics/service` | | ||
| | Source code | [`github.com/sourcegraph/cody-analytics` - `.`](https://github.com/sourcegraph/cody-analytics/tree/HEAD/.) | | ||
|
|
||
| ## Environments | ||
|
|
||
| ### dev | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------------- | ------------------------------------------------------------------------------------------------------ | | ||
| | Project ID | [`cody-analytics-dev-bd34`](https://console.cloud.google.com/run?project=cody-analytics-dev-bd34) | | ||
| | Category | **test** | | ||
| | Resources | | | ||
| | Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=cody-analytics-dev-bd34) | | ||
| | Domain | [cody-analytics.sgdev.org](https://cody-analytics.sgdev.org) | | ||
| | Cloudflare WAF | ✅ | | ||
|
|
||
| MSP infrastructure access needs to be requested using Entitle for time-bound privileges. | ||
| Test environments have less stringent requirements. | ||
|
|
||
| | ACCESS | ENTITLE REQUEST TEMPLATE | | ||
| | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | GCP project read access | [Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZGY3NWJkNWMtYmUxOC00MjhmLWEzNjYtYzlhYTU1MGIwODIzIiwidGhyb3VnaCI6ImRmNzViZDVjLWJlMTgtNDI4Zi1hMzY2LWM5YWE1NTBiMDgyMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
| | GCP project write access | [Entitle request for the 'Engineering Projects' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjIxNjAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiYzJkMTUwOGEtMGQ0ZS00MjA1LWFiZWUtOGY1ODg1ZGY3ZDE4IiwidGhyb3VnaCI6ImMyZDE1MDhhLTBkNGUtNDIwNS1hYmVlLThmNTg4NWRmN2QxOCIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
|
|
||
| #### dev Cloud Run | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | Console | [Cloud Run service](https://console.cloud.google.com/run?project=cody-analytics-dev-bd34) | | ||
| | 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) | |
50 changes: 50 additions & 0 deletions
50
content/departments/engineering/managed-services/gatekeeper.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Cody Gatekeeper infrastructure operations | ||
|
|
||
| <!-- | ||
| Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages' | ||
| Last updated: 2024-01-11 18:09:55.858769 +0000 UTC | ||
| Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b | ||
| --> | ||
|
|
||
| This document describes operational guidance for Cody Gatekeeper infrastructure. | ||
| This service is operated on the [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md). | ||
|
|
||
| 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 | [`gatekeeper`](https://github.com/sourcegraph/managed-services/blob/main/services/gatekeeper/service.yaml) | | ||
| | Owners | **cody-services** | | ||
| | Service kind | Cloud Run job | | ||
| | Environments | [prod](#prod) | | ||
| | Docker image | `us.gcr.io/sourcegraph-dev/abuse-ban-bot` | | ||
| | Source code | [`github.com/sourcegraph/abuse-ban-bot` - `.`](https://github.com/sourcegraph/abuse-ban-bot/tree/HEAD/.) | | ||
|
|
||
| ## Environments | ||
|
|
||
| ### prod | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | ---------- | --------------------------------------------------------------------------------------------------- | | ||
| | Project ID | [`gatekeeper-prod-1c93`](https://console.cloud.google.com/run/jobs?project=gatekeeper-prod-1c93) | | ||
| | Category | **internal** | | ||
| | Resources | | | ||
| | Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=gatekeeper-prod-1c93) | | ||
|
|
||
| MSP infrastructure access needs to be requested using Entitle for time-bound privileges. | ||
| Test environments have less stringent requirements. | ||
|
|
||
| | ACCESS | ENTITLE REQUEST TEMPLATE | | ||
| | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | GCP project read access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiNzg0M2MxYWYtYzU2MS00ZDMyLWE3ZTAtYjZkNjY0NDM4MzAzIiwidGhyb3VnaCI6Ijc4NDNjMWFmLWM1NjEtNGQzMi1hN2UwLWI2ZDY2NDQzODMwMyIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
| | GCP project write access | [Entitle request for the 'Internal Services' folder](https://app.entitle.io/request?data=eyJkdXJhdGlvbiI6IjEwODAwIiwianVzdGlmaWNhdGlvbiI6IkVOVEVSIEpVU1RJRklDQVRJT04gSEVSRSIsInJvbGVJZHMiOlt7ImlkIjoiZTEyYTJkZDktYzY1ZC00YzM0LTlmNDgtMzYzNTNkZmY0MDkyIiwidGhyb3VnaCI6ImUxMmEyZGQ5LWM2NWQtNGMzNC05ZjQ4LTM2MzUzZGZmNDA5MiIsInR5cGUiOiJyb2xlIn1dfQ%3D%3D) | | ||
|
|
||
| #### prod Cloud Run | ||
|
|
||
| | PROPERTY | DETAILS | | ||
| | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Console | [Cloud Run job](https://console.cloud.google.com/run/jobs?project=gatekeeper-prod-1c93) | | ||
| | 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) | |
Oops, something went wrong.