Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
update generated docs with timestamp and revision
Browse files Browse the repository at this point in the history
  • Loading branch information
@bobheadxi
bobheadxi committed Jan 11, 2024
1 parent 03c64f8 commit d58a109
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 71 deletions.
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/cloud-ops.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Cloud Ops Dashboard infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.978653 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Cloud Ops Dashboard infrastructure.
Expand Down
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/cody-analytics.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Cody Analytics infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.980144 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Cody Analytics infrastructure.
Expand Down
15 changes: 9 additions & 6 deletions content/departments/engineering/managed-services/gatekeeper.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Cody Gatekeeper infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.981234 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Cody Gatekeeper infrastructure.
Expand All @@ -27,17 +30,17 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
| PROPERTY | DETAILS |
|------------|-----------------------------------------------------------------------------------------------------|
| Project ID | [`gatekeeper-prod-1c93`](https://console.cloud.google.com/run/jobs?project=gatekeeper-prod-1c93) |
| Category | **test** |
| 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 '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) |
| 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

Expand Down
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Managed Services infrastructure

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.989859 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

These pages contain generated operational guidance for the infrastructure of [Managed Services Platform (MSP)](../teams/core-services/managed-services/platform.md) services.
Expand Down
63 changes: 5 additions & 58 deletions content/departments/engineering/managed-services/msp-testbed.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# MSP Testbed infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.982402 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for MSP Testbed infrastructure.
Expand All @@ -16,7 +19,7 @@ If you need assistance with MSP infrastructure, reach out to the [Core Services]
| Service ID | [`msp-testbed`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/service.yaml) |
| Owners | **core-services** |
| Service kind | Cloud Run service |
| Environments | [test](#test), [robert](#robert) |
| Environments | [test](#test) |
| Docker image | `us.gcr.io/sourcegraph-dev/msp-example` |
| Source code | [`github.com/sourcegraph/sourcegraph` - `cmd/msp-example`](https://github.com/sourcegraph/sourcegraph/tree/HEAD/cmd/msp-example) |

Expand Down Expand Up @@ -77,59 +80,3 @@ sg msp pg connect -write-access msp-testbed test
| 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) |

### robert

| PROPERTY | DETAILS |
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Project ID | [`msp-testbed-robert-7be9`](https://console.cloud.google.com/run?project=msp-testbed-robert-7be9) |
| Category | **test** |
| Resources | [robert Redis](#robert-redis), [robert PostgreSQL instance](#robert-postgresql-instance), [robert BigQuery dataset](#robert-bigquery-dataset) |
| Alerts | [GCP monitoring](https://console.cloud.google.com/monitoring/alerting?project=msp-testbed-robert-7be9) |
| Domain | [msp-testbed.sgdev.org](https://msp-testbed.sgdev.org) |

MSP infrastructure access needs to be requested using Entitle for time-bound privileges.
Test environments 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) |

#### robert Cloud Run

| PROPERTY | DETAILS |
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Console | [Cloud Run service](https://console.cloud.google.com/run?project=msp-testbed-robert-7be9) |
| 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) |

#### robert Redis

| PROPERTY | DETAILS |
|----------|-----------------------------------------------------------------------------------------------------------------------------|
| Console | [Memorystore Redis instances](https://console.cloud.google.com/memorystore/redis/instances?project=msp-testbed-robert-7be9) |

#### robert PostgreSQL instance

| PROPERTY | DETAILS |
|-----------|-------------------------------------------------------------------------------------------------------|
| Console | [Cloud SQL instances](https://console.cloud.google.com/sql/instances?project=msp-testbed-robert-7be9) |
| Databases | `primary` |

To connect to the PostgreSQL instance in this environment, use `sg msp` in the [`sourcegraph/managed-services`](https://github.com/sourcegraph/managed-services) repository:

```bash
# For read-only access
sg msp pg connect msp-testbed robert

# For write access - use with caution!
sg msp pg connect -write-access msp-testbed robert
```

#### robert BigQuery dataset

| PROPERTY | DETAILS |
|-----------------|------------------------------------------------------------------------------------------------------------------------|
| Dataset Project | `msp-testbed-robert-7be9` |
| Dataset ID | `msp_testbed` |
| Tables | [`example`](https://github.com/sourcegraph/managed-services/blob/main/services/msp-testbed/example.bigquerytable.json) |
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/pings.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Pings Service infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.983907 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Pings Service infrastructure.
Expand Down
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/sams.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Sourcegraph Accounts infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.985458 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Sourcegraph Accounts infrastructure.
Expand Down
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/support-integration.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Support Integration infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.986943 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Support Integration infrastructure.
Expand Down
5 changes: 4 additions & 1 deletion content/departments/engineering/managed-services/telemetry-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Telemetry Gateway infrastructure operations

<!--
Generated documentation; DO NOT EDIT. Regenerate using this command: 'sg msp operations generate-handbook-pages'
Generated documentation; DO NOT EDIT. Regenerate using this command: '2024-01-11 18:08:09.988184 +0000 UTC'
Last updated: sg msp operations generate-handbook-pages
Generated from: https://github.com/sourcegraph/managed-services/tree/f37cdc8aea65e1197e2d814447ad65c30fccd75b
-->

This document describes operational guidance for Telemetry Gateway infrastructure.
Expand Down

0 comments on commit d58a109

Please sign in to comment.